Skip to content

Commit

Permalink
[develop] Update docs URLs (#764)
Browse files Browse the repository at this point in the history
* Start open api docs for Engine APIs

* Add some more apis to doc

* Updated Engine API categories.

* Update tag for search

* Update Query API and add crafterSite to all APIs

* Update search API

* [develop] Update docs URLs

---------

Co-authored-by: Sumer Jabri <[email protected]>
  • Loading branch information
alhambrav and sumerjabri authored Dec 10, 2024
1 parent 0d51935 commit 453ba20
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Crafter Engine
==============

Crafter Engine is the content rendering engine for CrafterCMS. For more information, please visit: http://docs.craftercms.org.
Crafter Engine is the content rendering engine for CrafterCMS. For more information, please visit: http://craftercms.com/docs.

# Community
## Contributors
Expand Down
6 changes: 3 additions & 3 deletions src/main/api/engine-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ servers:
info:
description: |-
Crafter Engine API
version: '4.2.0'
version: '5.0.0'
title: Crafter Engine
termsOfService: ''
contact:
Expand All @@ -14,7 +14,7 @@ info:
url: 'https://www.gnu.org/licenses/gpl-3.0.en.html'
externalDocs:
description: CrafterCMS - Engine
url: 'https://docs.craftercms.org/current/reference/modules/engine/index.html'
url: 'https://craftercms.com/docs/current/reference/modules/engine/index.html'
tags:
- name: content
description: Content retrieval operations
Expand Down Expand Up @@ -1152,7 +1152,7 @@ paths:
- search
summary: Search
operationId: search
description: Performs a search operation in the OpenSearch index of the current site resolved for the request and optional other indexes. See <a class="reference external" href="https://docs.craftercms.org/current/reference/api/search.html#search-multi-index-query" rel="noopener noreferrer" target="_blank">Multi-index Query</a> for more information on performing a multiple index search. <br><br> <i>Note:</i> <br> <i>The request body must be a valid OpenSearch JSON query as described in the</i> <a class="reference external" href="https://opensearch.org/docs/latest/api-reference/search/" rel="noopener noreferrer" target="_blank">official docs</a>
description: Performs a search operation in the OpenSearch index of the current site resolved for the request and optional other indexes. See <a class="reference external" href="https://craftercms.com/docs/current/reference/api/search.html#search-multi-index-query" rel="noopener noreferrer" target="_blank">Multi-index Query</a> for more information on performing a multiple index search. <br><br> <i>Note:</i> <br> <i>The request body must be a valid OpenSearch JSON query as described in the</i> <a class="reference external" href="https://opensearch.org/docs/latest/api-reference/search/" rel="noopener noreferrer" target="_blank">official docs</a>
parameters:
- name: index
in: query
Expand Down
4 changes: 2 additions & 2 deletions src/main/webapp/default-site/templates/web/entry.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@

<main id="main">

<a href="https://craftercms.org">
<a href="https://craftercms.com">
<img src="${urlTransformationService.transform('toWebAppRelativeUrl', '/static-assets/img/logo.svg')}" alt="CrafterCMS"/>
</a>

Expand All @@ -103,7 +103,7 @@
<nav class="navigation">
<h2 class="navigation--title">Helpful links:</h2>
<a class="navigation--link" href="/studio">Authoring environment</a>
<a class="navigation--link" href="http://docs.craftercms.org">Docs Homepage</a>
<a class="navigation--link" href="http://craftercms.com/docs">Docs Homepage</a>
<a class="navigation--link" href="http://www.craftercms.com/resources">Tutorials &amp; Screencasts</a>
<a class="navigation--link" href="http://www.craftercms.com/about/partners">Professional Services</a>
</nav>
Expand Down
4 changes: 2 additions & 2 deletions src/main/webapp/default-site/templates/web/no-site.ftl
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@

<main id="main">

<a href="https://craftercms.org">
<a href="https://craftercms.com">
<img src="${urlTransformationService.transform('toWebAppRelativeUrl', '/static-assets/img/logo.svg')}" alt="CrafterCMS"/>
</a>

Expand All @@ -102,7 +102,7 @@
<nav class="navigation">
<h2 class="navigation--title">Helpful links:</h2>
<a class="navigation--link" href="/studio">Authoring environment</a>
<a class="navigation--link" href="http://docs.craftercms.org">Docs Homepage</a>
<a class="navigation--link" href="http://craftercms.com/docs">Docs Homepage</a>
<a class="navigation--link" href="http://www.craftercms.com/resources">Tutorials &amp; Screencasts</a>
<a class="navigation--link" href="http://www.craftercms.com/about/partners">Professional Services</a>
</nav>
Expand Down

0 comments on commit 453ba20

Please sign in to comment.