From be1f4b87eb6201ebf4a52ef569af5805bb6f6188 Mon Sep 17 00:00:00 2001 From: Serhii Plyhun Date: Wed, 22 Jan 2025 12:31:32 +0100 Subject: [PATCH 1/6] GPU-1892: No getmesh.io --- .github/CONTRIBUTING.md | 2 +- CHANGELOG.adoc | 20 +-- .../hugo/content/docs/authentication.asciidoc | 2 +- .../hugo/content/docs/contributing.asciidoc | 2 + .../hugo/content/docs/cookbook/index.asciidoc | 7 +- .../main/hugo/content/docs/features.asciidoc | 118 ++++-------------- .../content/docs/getting-started.asciidoc | 9 -- .../main/hugo/content/docs/graphql.asciidoc | 10 -- .../docs/guides/mesh-api-intro/index.asciidoc | 6 +- .../docs/guides/mesh-hugo/index.asciidoc | 4 - .../docs/guides/mesh-react-2/index.asciidoc | 2 +- .../docs/guides/mesh-react/index.asciidoc | 2 +- .../content/docs/image-manipulation.asciidoc | 51 +------- .../content/docs/java-rest-client.asciidoc | 4 +- .../hugo/content/docs/mesh-insomnia-v1.json | 4 +- .../hugo/content/docs/mesh-insomnia-v2.json | 4 +- .../hugo/content/docs/references.asciidoc | 43 ------- doc/src/main/hugo/data/github.json | 2 +- doc/src/main/hugo/data/releases.json | 60 ++++----- .../gentics/layouts/download/download.html | 2 +- .../gentics/layouts/partials/ldjson.html | 4 +- .../mesh/example/MeshRestClientExample.java | 4 +- .../rest/client/MeshRestClientConfig.java | 2 +- .../monitoring/MonitoringClientConfig.java | 2 +- 24 files changed, 92 insertions(+), 274 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 1200dee75c..513f8b5d9f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -28,7 +28,7 @@ Submit a pull request via the normal GitHub UI. ## Documentation -If you want to contribute to the Gentics Mesh documentation, the right place is: https://github.com/gentics/mesh. Every release all the contributions are reviewed and published on the public [documentation](https://getmesh.io/docs/beta/). +If you want to contribute to the Gentics Mesh documentation, the right place is: https://github.com/gentics/mesh. Every release all the contributions are reviewed and published on the public [documentation](https://gentics.com/mesh/docs/). ## Code formatting diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc index 73660fb884..21e466d880 100644 --- a/CHANGELOG.adoc +++ b/CHANGELOG.adoc @@ -854,7 +854,7 @@ icon:plus[] Core: It is now possible to use Gentics Mesh in read only mode. Take icon:check[] REST: The `/health/live` and `/health/ready` endpoints have been added to the REST API. These endpoints are also available on the monitoring server, but adding them to the REST server makes it possible for load balancers to monitor the server on the same port that used to proxy the requests. -icon:check[] REST: The link:https://getmesh.io/docs/api/#users__userUuid__token_post[`/user/:uuid/token`] endpoint now has the Cache-Control header set to private. +icon:check[] REST: The link:https://gentics.com/mesh/docs/api/#users__userUuid__token_post[`/user/:uuid/token`] endpoint now has the Cache-Control header set to private. icon:check[] Java Rest Client: Fixed a bug that caused `MeshOkHttpRequestImpl#getResponse` to always return null. @@ -896,7 +896,7 @@ icon:check[] UI: The UI has been updated to version link:https://github.com/gent icon:plus[] GraphQL: The GraphQL Endpoint now supports the `wait` query-parameter like the Search Endpoint does. link:https://github.com/gentics/mesh/issues/805[#805] -icon:plus[] Clustering: The role of an instance has been added to the link:https://getmesh.io/docs/api/#admin_cluster_status_get[cluster status response]. +icon:plus[] Clustering: The role of an instance has been added to the link:https://gentics.com/mesh/docs/api/#admin_cluster_status_get[cluster status response]. icon:plus[] Plugins: It is now possible to specify the API Version that should be used when creating a new admin client. link:https://github.com/gentics/mesh-incubator/issues/216[#216] @@ -909,7 +909,7 @@ icon:check[] UI: The UI has been updated to version link:https://github.com/gent [[v1.1.0]] == 1.1.0 (29.10.2019) -WARNING: The internal monitoring library has been changed from dropwizard to link:https://micrometer.io/[micrometer]. This allows better labeling of various metrics for link:https://prometheus.io/[Prometheus]. With this change, some metrics names from Vert.x have been changed. See link:https://vertx.io/docs/vertx-micrometer-metrics/java/#_vert_x_core_tools_metrics[here] for the new list of Vert.x metrics. By default, JVM metrics are also recorded. This can be configured in the link:{{< relref "administration-guide.asciidoc" >}}#_monitoring_options[monitoring options]. Also, the response structure in the `/search/status` endpoint has changed. Take a look at the link:https://getmesh.io/docs/api/#search_status_get[API docs] for a new example. +WARNING: The internal monitoring library has been changed from dropwizard to link:https://micrometer.io/[micrometer]. This allows better labeling of various metrics for link:https://prometheus.io/[Prometheus]. With this change, some metrics names from Vert.x have been changed. See link:https://vertx.io/docs/vertx-micrometer-metrics/java/#_vert_x_core_tools_metrics[here] for the new list of Vert.x metrics. By default, JVM metrics are also recorded. This can be configured in the link:{{< relref "administration-guide.asciidoc" >}}#_monitoring_options[monitoring options]. Also, the response structure in the `/search/status` endpoint has changed. Take a look at the link:https://gentics.com/mesh/docs/api/#search_status_get[API docs] for a new example. icon:plus[] Search: A new setting has been added which can be used to enable Elasticsearch 7 support. The `search.complianceMode` setting in the `mesh.yml` file can be used to control the compliance mode for Elasticsearch support. The setting can also be controlled via the `MESH_ELASTICSEARCH_COMPLIANCE_MODE` environment variable. Currently there are two modes: `ES_7` for Elasticsearch 7.x and `ES_6` for Elasticsearch 6.x. By default `ES_6` will be used thus no changes are required for existing installations. @@ -1517,7 +1517,7 @@ icon:check[] REST: Fixed a bug which prevented the `DELETE /api/v1/admin/jobs/:j [[v0.31.2]] == 0.31.2 (22.03.2019) -icon:plus[] Docker: Default memory settings for the server and demo docker images were updated. The `-Dstorage.diskCache.bufferSize=256` setting has been added for the server image. The setting can be changed using the `JAVA_TOOL_OPTIONS` environment variable. See link:https://getmesh.io/docs/administration-guide/#_memory_settings[Memory documentation] for more information and recommendations. +icon:plus[] Docker: Default memory settings for the server and demo docker images were updated. The `-Dstorage.diskCache.bufferSize=256` setting has been added for the server image. The setting can be changed using the `JAVA_TOOL_OPTIONS` environment variable. See link:https://gentics.com/mesh/docs/administration-guide/#_memory_settings[Memory documentation] for more information and recommendations. icon:plus[] OrientDB: The included OrientDB version has been updated to version 3.0.18. @@ -1573,7 +1573,7 @@ icon:check[] Fixed a bug in the consistency checks which claimed missing user ro icon:check[] Schema: A bug was fixed which prevented the update of the schema field `elasticsearch` property to value null. -icon:plus[] Docker: Default memory settings for the server and demo docker images were added. Default for server is set to `-Xms512m -Xmx512m -XX:MaxDirectMemorySize=256m`. The setting can be changed using the `JAVA_TOOL_OPTIONS` environment variable. See link:https://getmesh.io/docs/administration-guide/#_memory_settings[Memory documentation] for more information. +icon:plus[] Docker: Default memory settings for the server and demo docker images were added. Default for server is set to `-Xms512m -Xmx512m -XX:MaxDirectMemorySize=256m`. The setting can be changed using the `JAVA_TOOL_OPTIONS` environment variable. See link:https://gentics.com/mesh/docs/administration-guide/#_memory_settings[Memory documentation] for more information. icon:check[] The `.vertx` cache folder was moved to the configurable `data/tmp` folder. @@ -1598,7 +1598,7 @@ icon:check[] Java Rest Client: Fixed a bug in the MeshRestClient#isOneOf helper [[v0.30.0]] == 0.30.0 (12.02.2019) -CAUTION: Java Rest Client: The Gentics Mesh Java REST client which was based on Vert.x was replaced with a `OkHttpClient` implementation. Some changes to the client interface were necessary to make the client independent of Vert.x. See link:https://getmesh.io/docs/platforms/#_java[this example] and the Javadoc for more information. +CAUTION: Java Rest Client: The Gentics Mesh Java REST client which was based on Vert.x was replaced with a `OkHttpClient` implementation. Some changes to the client interface were necessary to make the client independent of Vert.x. See link:https://gentics.com/mesh/docs/platforms/#_java[this example] and the Javadoc for more information. icon:check[] Clustering: The mesh version will no longer be appended to the node name used for OrientDB clustering. It is recommended to sanitize the `data/graphdb/storage/distributed-db-config.json` file and remove/rename entries which reference older mesh nodes. Only the active nodes should be listed in the file. @@ -1744,7 +1744,7 @@ icon:plus[] Core: Deletion of micronode and list field data has been implemented icon:check[] Changelog: Fixed a bug in the webroot index database migration entry which caused a `ORecordDuplicatedException` changelog error and prevented update and startup of older databases. link:https://github.com/gentics/mesh/issues/554[#554], link:https://github.com/gentics/mesh/issues/546[#546] -icon:check[] Core: Fixed a bug that caused link:https://getmesh.io/docs/api/#project__branches__branchUuid__migrateSchemas_post[/migrateSchemas] to fail when a newer schema version was not assigned to the branch. link:https://github.com/gentics/mesh/issues/532[#532] +icon:check[] Core: Fixed a bug that caused link:https://gentics.com/mesh/docs/api/#project__branches__branchUuid__migrateSchemas_post[/migrateSchemas] to fail when a newer schema version was not assigned to the branch. link:https://github.com/gentics/mesh/issues/532[#532] icon:check[] Core: Nodes are now migrated to the newest schema version when a new branch is created. link:https://github.com/gentics/mesh/issues/521[#521] @@ -2241,7 +2241,7 @@ icon:check[] REST: In some cases parallel file uploads of multiple images could CAUTION: Search: The raw search endpoints now wraps a multisearch request. The endpoint response will now include the elasticsearch responses array. The query stays the same. -icon:plus[] Demo: The link:https://demo.getmesh.io/demo[demo application] was updated to use Angular 5. +icon:plus[] Demo: The demo application was updated to use Angular 5. icon:plus[] Core: Gentics Mesh can now be downgraded if the link:{{< relref "administration-guide.asciidoc" >}}#database-revisions[database revision] matches the needed revision of Gentics Mesh. @@ -3226,14 +3226,14 @@ icon:bullhorn[] Content releases support [quote] ____ -This version of Gentics Mesh introduces _Content Releases_. A detailed description of this feature can be found in our https://getmesh.io/docs[Documentation]. +This version of Gentics Mesh introduces _Content Releases_. A detailed description of this feature can be found in our https://gentics.com/mesh/docs[Documentation]. ____ icon:bullhorn[] Versioning support [quote] ____ -This version of Gentics Mesh introduces versioning of contents. A detailed description of the versioning feature can be found in our https://getmesh.io/docs[Documentation]. +This version of Gentics Mesh introduces versioning of contents. A detailed description of the versioning feature can be found in our https://gentics.com/mesh/docs[Documentation]. Important changes summary: diff --git a/doc/src/main/hugo/content/docs/authentication.asciidoc b/doc/src/main/hugo/content/docs/authentication.asciidoc index edebea6a4a..2e252af4d6 100644 --- a/doc/src/main/hugo/content/docs/authentication.asciidoc +++ b/doc/src/main/hugo/content/docs/authentication.asciidoc @@ -172,7 +172,7 @@ Gentics Mesh first and foremost keeps your content safe - all data including med That is why Gentics Mesh instances ship with an included ```anonymous``` user/role/group set. If no authentication details are provided Gentics Mesh will automatically try to authenticate with the user ```anonymous```. -TIP: Try our Gentics Mesh demo instance without authenticating yourself: ```https://demo.getmesh.io{apiLatest}/auth/me```. This link:/docs/api#auth[API endpoint] shows the currently authenticated user - which is ```anonymous```. +This link:/docs/api#auth[API endpoint] shows the currently authenticated user. You can assign ```readPublished``` permissions to the ```anonymous``` role for all elements you want to be publicly available. diff --git a/doc/src/main/hugo/content/docs/contributing.asciidoc b/doc/src/main/hugo/content/docs/contributing.asciidoc index 7c81f01c5d..e2a837265c 100644 --- a/doc/src/main/hugo/content/docs/contributing.asciidoc +++ b/doc/src/main/hugo/content/docs/contributing.asciidoc @@ -83,6 +83,8 @@ The main components which are used to build Gentics Mesh are: | https://google.github.io/dagger/[Dagger 2] | Dependency injection library | https://github.com/ReactiveX/RxJava[RxJava2] | Library which is used to composing asynchronous requests/processes. | https://docs.jboss.org/hibernate/orm/6.5/introduction/html_single/Hibernate_Introduction.html[Hibernate] | Object relations mapping. +|====== + == Big Picture Since you are most likely already familiar with the Gentics Mesh link:/docs/api[REST API] I assume it is best to start there. diff --git a/doc/src/main/hugo/content/docs/cookbook/index.asciidoc b/doc/src/main/hugo/content/docs/cookbook/index.asciidoc index b84c60473f..7b6a1e40e4 100644 --- a/doc/src/main/hugo/content/docs/cookbook/index.asciidoc +++ b/doc/src/main/hugo/content/docs/cookbook/index.asciidoc @@ -12,15 +12,14 @@ This document aims to provide you with suggestions and hints on how to deal with Handling contents is fairly easy. You can either identify and load content using the UUIDs or a regular web path. -By Path: https://demo.getmesh.io{apiLatest}/demo/webroot/yachts/indian-empress +By Path: ```GET {apiLatest}/:projectName/webroot/path/to/the/node``` -By Uuid: https://demo.getmesh.io{apiLatest}/demo/nodes/079ae5d5467447b99ae5d5467447b934 +By Uuid: ```{apiLatest}/:projectName/nodes/:nodeUuid``` -You can either place the path or uuid to your content in a fragment `/demo#category/079ae5d5467447b99ae5d5467447b934` or in the regular web path `/demo/category/079ae5d5467447b99ae5d5467447b934`. Most modern single page application frameworks like angular or react support both variations. +You can either place the path or uuid to your content in a fragment `/:projectName#nodes/:nodeUuid` or in the regular web path `/:projectName/nodes/:nodeUuid`. Most modern single page application frameworks like angular or react support both variations. If you choose to use a server side webframework like link:https://laravel.com/[Laravel] or link:https://expressjs.com/de/[Express] you can setup routes to handle the inbound request. The request path can be used to build the webroot path for Gentics Mesh. Using that path you can query Gentics Mesh and check whether content for the given path can be found. - == Binaries Binary requests should be directly passed along to the CMS API. This way no additional overhead is involved when dealing with binary data transmission. diff --git a/doc/src/main/hugo/content/docs/features.asciidoc b/doc/src/main/hugo/content/docs/features.asciidoc index e402089db8..b559385929 100644 --- a/doc/src/main/hugo/content/docs/features.asciidoc +++ b/doc/src/main/hugo/content/docs/features.asciidoc @@ -48,10 +48,6 @@ For more details see the documentation on link:{{< relref "building-blocks.ascii You can also specify dedicated paths for nodes using the ```urlFields``` schema property. You can add string or string list fields to your schema and list them via the ```urlFields``` property. Gentics Mesh will utilize these fields in nodes in order to retrieve the node. -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/cars/outatime - === API endpoints [options="header",cols="2*"] @@ -67,10 +63,6 @@ https://demo.getmesh.io{apiLatest}/demo/webroot/cars/outatime ==== Response Sample -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/fc3c85be82584ae2bc85be82588ae2b0?resolveLinks=short - [source,json] ---- { @@ -223,18 +215,6 @@ The demo app includes a navigation object showing just the top-level elements _A === Response Sample -Retrieving a navigation object using the projects root node ```/``` including the top level navigation menu items. - -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/navroot/?resolveLinks=short&maxDepth=1 - -The same can be achieved using the node specific navigation endpoint. In this case you can specify the root node of your navigation by providing the node uuid. - -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/688f7beae8d240bf8f7beae8d2a0bf2e/navigation?resolveLinks=short&maxDepth=1 - [source,json] ---- { @@ -690,10 +670,6 @@ The ```breadcrumb``` property will be returned in all API responses containing n === Response Sample -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/fc3c85be82584ae2bc85be82588ae2b0?resolveLinks=short - [source,json] ---- { @@ -846,7 +822,7 @@ For example, the following will not work: | API endpoint | Response code | GET -| /api/v2/docs/hello-world/example-page.html +| {apiLatest}/docs/hello-world/example-page.html | 404 |====== @@ -866,7 +842,7 @@ By prepending the path with a forward slash, the same request will resolve the n | API endpoint | Response code | GET -| /api/v2/docs/hello-world/example-page.html +| {apiLatest}/docs/hello-world/example-page.html | 200 |====== @@ -881,8 +857,8 @@ Using the WebRoot API it is possible to easily integrate Gentics Mesh with many [options="header"] |====== | Framework | Language | Example -| http://silex.sensiolabs.org/[Silex] | PHP | https://getmesh.io/Blog/Building+an+API-first+Web+App+with+Gentics+Mesh+and+the+PHP+Microframework+Silex[blog post] -| http://expressjs.com/[ExpressJS] | JS | https://getmesh.io/Blog/Getting+started+with+Express+and+the+API-first+CMS+Gentics+Mesh[blog post] +| http://silex.sensiolabs.org/[Silex] | PHP | https://gentics.com/mesh/Blog/Building+an+API-first+Web+App+with+Gentics+Mesh+and+the+PHP+Microframework+Silex[blog post] +| http://expressjs.com/[ExpressJS] | JS | https://gentics.com/mesh/Blog/Getting+started+with+Express+and+the+API-first+CMS+Gentics+Mesh[blog post] | http://vertx.io/[Vert.x] | Java,JS,Ceylon | http://vertx.io/blog/data-driven-apps-made-easy-with-vert-x-3-4-0-and-headless-cms-gentics-mesh/[blog post] | http://lotusrb.org/[Lotus] | Ruby | - |====== @@ -911,17 +887,11 @@ NOTE: Each segment of the URL must be URL-encoded. A node's contents must provid ==== Fetch node with UUID -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/fc3c85be82584ae2bc85be82588ae2b0?resolveLinks=short - Loading the node with the given UUID using API endpoint ```GET {apiLatest}/:projectName/nodes/:nodeUuid```. ==== Fetch node with WebRoot path -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/automobiles/ford-gt?resolveLinks=short +```GET {apiLatest}/:projectName/webroot/path/to/the/image/image?resolveLinks=short``` === Query binary content by path The WebRoot API, furthermore, directly supports delivering binary content (e.g., images, documents, etc.) using the ```fileName``` meta-data field of the ```binary``` field. @@ -932,17 +902,13 @@ NOTE: Downloads of resized images currently do not support byte range requests. ==== Fetch an image with UUID -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image +```GET {apiLatest}/:projectName/nodes/:imageNodeUuid/binary/:binaryFieldName``` Downloading a node's binary field with the given name using API endpoint ```GET {apiLatest}/:projectName/nodes/:nodeUuid/binary/:fieldName```. ==== Fetch an image with WebRoot path -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg +```GET {apiLatest}/:projectName/webroot/path/to/the/image/image.jpg``` TIP: When using a routing framework, in order to find out if a requested resource is binary data or JSON data you need to check the HTTP Content-Disposition response header. If it is set, it’s binary data. @@ -952,18 +918,11 @@ link:{{}}[Image Manipulation] such as crop ==== Crop and resize an image with UUID -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?rect=10,100,800,400&w=300&crop=rect +```GET {apiLatest}/:projectName/nodes/:imageNodeUuid/binary/:binaryFieldName?rect=10,100,800,400&w=300&crop=rect``` ==== Crop and resize an image with WebRoot path -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?rect=10,100,800,400&w=300&crop=rect - -Find out more about this topic in our blog post about https://getmesh.io/blog/gentics-mesh-image-manipulation/[Gentics Mesh's Image Manipulation API and Interface]. - +```GET {apiLatest}/:projectName/webroot/path/to/the/image/image.jpg?rect=10,100,800,400&w=300&crop=rect``` == Link Resolving @@ -973,7 +932,7 @@ image::../images/GenticsMesh-LinkResolver-Utility-Example.png[Gentics Mesh Examp Typically, editors create content including internal links to other nodes. When fetching content for your apps, however, Gentics Mesh will resolve these internal links for you and return a WebRoot path. -For example, ```{{mesh.link("2f2de9297c8143e8ade9297c8193e8fc", "en")}}``` will be transformed into ```{apiLatest}/demo/webroot/images/ford-gt.jpg``` when using the ```?resolveLinks=full``` query parameter. +For example, ```{{mesh.link("2f2de9297c8143e8ade9297c8193e8fc", "en")}}``` will be transformed into ```{apiLatest}/:projectName/webroot/path/to/the/image/image.jpg``` when using the ```?resolveLinks=full``` query parameter. The ```?resolveLinks``` query parameter defines if and how links are resolved: @@ -1382,17 +1341,10 @@ Most API responses within Gentics Mesh contain a list of permissions. This list ==== Example -.Try the example -[TIP] -Permission of user ```anonymous``` on node ```Delorean``` -https://demo.getmesh.io{apiLatest}/demo/nodes/fc3c85be82584ae2bc85be82588ae2b0?version=published -// TODO provide new example node, remove read permission for this example node only, add ?version=published to example code -// TODO provide image with user - group - role for anonymous and permissions to specified node - [source,json,subs=attributes] ----- -// permissions for node https://demo.getmesh.io{apiLatest}/demo/nodes/fd58237c79d64bf198237c79d6bbf107?version=published +// permissions for node {apiLatest}/:projectName/nodes/:nodeUuid?version=published ... "permissions" : { "create" : false, //create other nodes @@ -1405,7 +1357,6 @@ https://demo.getmesh.io{apiLatest}/demo/nodes/fc3c85be82584ae2bc85be82588ae2b0?v ... ----- - The example above shows that the requesting user ```anonymous``` has the ```readPublish``` permission on the requested node, only. This means the user is allowed to read the published version of the node but not previous versions or a draft version of the requested element. Furthermore the user is not allowed to @@ -1451,17 +1402,9 @@ NOTE: The following example links, require prior authentication with user ```adm ==== Querying Role Permissions The link:/docs/api/#roles__roleUuid__permissions__pathToElement__get[```GET {apiLatest}/roles/:roleUuid/permissions/:path```] endpoint can be used to query a role's permission on a specific element or set of elements. -For example, the link:{{< relref "references.asciidoc" >}}#_authentication[authenticated] ```admin``` user is able to find out the configured permissions for role ```Public User``` on node ```fc3c85be82584ae2bc85be82588ae2b0```. - -.Try the example with user ```admin``` -[TIP] -https://demo.getmesh.io{apiLatest}/roles/10447951fd264e6a847951fd266e6ae6/permissions/projects/217f8c981ada4642bf8c981adaa642c3/nodes/88fac3fbc61041c1bac3fbc610d1c182 -Note, that a request with user ```anonymous``` will yield a _Missing object permissions_ error response. - - [source,bash,subs=attributes] ----- -GET https://demo.getmesh.io{apiLatest}/roles/10447951fd264e6a847951fd266e6ae6/permissions/projects/217f8c981ada4642bf8c981adaa642c3/nodes/88fac3fbc61041c1bac3fbc610d1c182 +GET {apiLatest}/roles/10447951fd264e6a847951fd266e6ae6/permissions/projects/217f8c981ada4642bf8c981adaa642c3/nodes/88fac3fbc61041c1bac3fbc610d1c182 RESPONSE { @@ -1474,15 +1417,11 @@ RESPONSE } ----- -Alternatively, you can use query the element using the respective API endpoint (e.g. link:++/docs/api#project__nodes__get++[```GET {apiLatest}/projectName/nodes```]) and use the ```role``` query parameter to find out another role's (i.e. ```anonymous```) permissions on the element: - -.Try the example with user ```admin``` -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/88fac3fbc61041c1bac3fbc610d1c182?role=10447951fd264e6a847951fd266e6ae6 +Alternatively, you can use query the element using the respective API endpoint (e.g. link:++/docs/api#project__nodes__get++[```GET {apiLatest}/projectName/nodes```]) and use the ```role``` query parameter to find out another role's (i.e. ```anonymous```) permissions on the element. [source,bash,subs=attributes] ----- -GET https://demo.getmesh.io{apiLatest}/roles/10447951fd264e6a847951fd266e6ae6/permissions/projects/217f8c981ada4642bf8c981adaa642c3/nodes/88fac3fbc61041c1bac3fbc610d1c182 +GET {apiLatest}/roles/10447951fd264e6a847951fd266e6ae6/permissions/projects/217f8c981ada4642bf8c981adaa642c3/nodes/88fac3fbc61041c1bac3fbc610d1c182 RESPONSE ... @@ -1508,10 +1447,6 @@ RESPONSE ==== Querying User Permissions The endpoint link:/docs/api/#users__userUuid__permissions__path__get[```GET {apiLatest}/users/:userUuid/permissions/:path```] provides a shortcut for querying permissions for specific users directly, e.g., for user ```anonymous```, which is essentially inheriting all permissions from role ```anonymous```. -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/users/5fb9654c0b734e87b9654c0b736e8701/permissions/projects/217f8c981ada4642bf8c981adaa642c3/nodes/88fac3fbc61041c1bac3fbc610d1c182 - === Assigning & Revoking Permissions The link:/docs/api#roles__roleUuid__permissions__pathToElement__post[```POST {apiLatest}/roles/:roleUuid/permissions/:path```] API endpoint can be used to assign or revoke permissions to/from a role. @@ -1549,7 +1484,7 @@ NOTE: Links used in the example require prior authentication with user admin (cr [source,bash,subs=attributes] ----- -POST https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/users +POST {apiLatest}/roles/:roleUuid/permissions/users { "permissions": { "create": false, @@ -1572,7 +1507,9 @@ POST https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/p You can query the updated permissions with user ```admin```: -https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/users +----- +GET {apiLatest}/roles/:roleUuid/permissions/users +----- ===== Role permissions All possible role permissions on users are summarized in the following table. @@ -1606,7 +1543,7 @@ NOTE: Links used in the example require prior authentication with user admin (cr [source,bash,subs=attributes] ----- -POST https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/groups/df81c23d9ff1450081c23d9ff195005e +POST {apiLatest}/roles/:roleUuid/permissions/groups/:groupUuid { "permissions": { "create": false, @@ -1630,12 +1567,8 @@ POST https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/p You can query the updated permissions with user ```admin```: -* https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/groups/df81c23d9ff1450081c23d9ff195005e -* https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/users - -* or alternatively with -https://demo.getmesh.io{apiLatest}/groups/df81c23d9ff1450081c23d9ff195005e?role=6754d83b086244d894d83b086204d87f -https://demo.getmesh.io{apiLatest}/groups/df81c23d9ff1450081c23d9ff195005e/users?role=6754d83b086244d894d83b086204d87f +* `{apiLatest}/roles/:roleUuid/permissions/groups/:groupUuid` +* `{apiLatest}/roles/:roleUuid/permissions/users` ===== Role permissions All possible role permissions on groups are summarized in the following table. @@ -1671,7 +1604,7 @@ NOTE: Links used in the example require prior authentication with user admin (cr [source,bash,subs=attributes] ----- -POST https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/roles +POST {apiLatest}/roles/:roleUuid/permissions/roles { "permissions": { "create": true, @@ -1692,12 +1625,7 @@ POST https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/p } ----- -You can query the updated permissions with user ```admin```: - -* https://demo.getmesh.io{apiLatest}/roles/6754d83b086244d894d83b086204d87f/permissions/roles - -* or alternatively with -https://demo.getmesh.io{apiLatest}/roles?role=6754d83b086244d894d83b086204d87f +You can query the updated permissions with user ```admin```. ===== Role permissions All possible role permissions on roles are summarized in the following table. diff --git a/doc/src/main/hugo/content/docs/getting-started.asciidoc b/doc/src/main/hugo/content/docs/getting-started.asciidoc index d37a42b783..bc0a66eee5 100644 --- a/doc/src/main/hugo/content/docs/getting-started.asciidoc +++ b/doc/src/main/hugo/content/docs/getting-started.asciidoc @@ -16,15 +16,6 @@ A headless CMS just provides an API (REST/GraphQL) instead of serving or renderi If you don't have much time: -* Try the link:https://demo.getmesh.io/mesh-ui/[UI] with login (admin/admin) for playing around with Gentics Mesh and it's user interface. -* Changes can be viewed in the link:https://demo.getmesh.io/demo/[demo front-end] - -[subs=attributes] -++++ - -++++ - * Head over to the <> section to find out everything you need to know and what makes Gentics Mesh special. == Run with Docker diff --git a/doc/src/main/hugo/content/docs/graphql.asciidoc b/doc/src/main/hugo/content/docs/graphql.asciidoc index e1e070c954..cc5bfd8341 100644 --- a/doc/src/main/hugo/content/docs/graphql.asciidoc +++ b/doc/src/main/hugo/content/docs/graphql.asciidoc @@ -53,11 +53,6 @@ The search query is an escaped JSON object which represents the a regular https: include::content/docs/examples/graphql/node-search-query[] -[subs=attributes] -++++ -Example using variables -++++ - === Using pagination Similar to the REST API a value based pagination system is implemented. @@ -147,11 +142,6 @@ Many tasks can be done by both the search and the filtering feature. Here are a We have integrated the interactive https://github.com/graphql/graphiql[GraphiQL]footnote:[https://github.com/graphql/graphiql[GraphiQL] is owned and developed by Facebook Inc. Usage is subject to the https://github.com/gentics/mesh/blob/dev/verticles/graphql/src/main/resources/graphiql/LICENSE[LICENSE AGREEMENT For GraphiQL software].] browser into Gentics Mesh so you can easily play with the API. -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/graphql/browser/[Live Demo] - -Alternatively, you can download Gentics Mesh and test the API locally. Once authenticated you can access the interactive GraphiQL browser at ```{apiLatest}/:projectName/graphql/browser/``` . NOTE: The GraphiQL browser currently does not support the `branch` or `version` query parameter. diff --git a/doc/src/main/hugo/content/docs/guides/mesh-api-intro/index.asciidoc b/doc/src/main/hugo/content/docs/guides/mesh-api-intro/index.asciidoc index 1206550a7c..de8cf97ae0 100644 --- a/doc/src/main/hugo/content/docs/guides/mesh-api-intro/index.asciidoc +++ b/doc/src/main/hugo/content/docs/guides/mesh-api-intro/index.asciidoc @@ -43,11 +43,11 @@ In this guide we will mainly focus on loading, creating and updating vehicle con === Setup -We can quickly start-up a Gentics Mesh instance using Docker. Alternativly we can also use `demo.getmesh.io` which will however be reset once a day. +We can quickly start-up a Gentics Mesh instance using Docker. [source,bash] ---- -docker run -p 8080:8080 --rm gentics/mesh-demo:0.33.1 +docker run -p 8080:8080 --rm gentics/mesh-hsqldb:latest ---- Now lets set the base so we can reuse it in our examples: @@ -55,8 +55,6 @@ Now lets set the base so we can reuse it in our examples: [source,bash,subs="+attributes"] ---- export MESH_BASE="http://localhost:8080{apiLatest}" -or -export MESH_BASE="https://demo.getmesh.io{apiLatest}" ---- In this guide we only use `curl` and `jq` which is just used to increase readability. diff --git a/doc/src/main/hugo/content/docs/guides/mesh-hugo/index.asciidoc b/doc/src/main/hugo/content/docs/guides/mesh-hugo/index.asciidoc index 9c82441f71..4064238f7a 100644 --- a/doc/src/main/hugo/content/docs/guides/mesh-hugo/index.asciidoc +++ b/doc/src/main/hugo/content/docs/guides/mesh-hugo/index.asciidoc @@ -89,10 +89,6 @@ Now we can run the exporter which will connect to Gentics Mesh and load the cont `java -jar mesh2hugo-1.0.0.jar -c -p demo -url http://localhost:8080` -Alternatively you can also use the Gentics Mesh Demo server to load the contents. - -`java -jar mesh2hugo-1.0.0.jar -c -p demo -url https://demo.getmesh.io` - The exported content markdown files show now look like this: ``` diff --git a/doc/src/main/hugo/content/docs/guides/mesh-react-2/index.asciidoc b/doc/src/main/hugo/content/docs/guides/mesh-react-2/index.asciidoc index b9ff619843..d55c148da2 100644 --- a/doc/src/main/hugo/content/docs/guides/mesh-react-2/index.asciidoc +++ b/doc/src/main/hugo/content/docs/guides/mesh-react-2/index.asciidoc @@ -26,7 +26,7 @@ The following changes can be applied on the `guide-step-2` branch. The fully working example can be found in the `guide-step-3` branch of the link:https://github.com/gentics/mesh-react-example/tree/guide-step-3[mesh-react-example] repository. -TIP: The `proxy` field in the `package.json` file specifies the Gentics Mesh server to be proxied into the app server. By default `https://demo.getmesh.io` will be used. +TIP: The `proxy` field in the `package.json` file specifies the Gentics Mesh server to be proxied into the app server. First we need to add the `vertx3-eventbus-client` which provides the connection to the websocket endpoint of Gentics Mesh. diff --git a/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc b/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc index faa3c0a75f..c8c80395d1 100644 --- a/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc +++ b/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc @@ -177,7 +177,7 @@ The `displayField` controls what field should be used to display in the UI node The `segmentField` controls which field should be used to identify the node for the webroot API. Nodes can be nested in each other and thus each node can provide a segment for path. This way it is possible to load nodes via a path resolving system. -For the images the `binary` field will provide the segment. This way the filename of the uploaded binary will be used. The image will be loadable via the https://demo.getmesh.io{apiLatest}/demo/webroot/images/sts.jpg?w=800[`/images/sts.jpg`] path. +For the images the `binary` field will provide the segment. This way the filename of the uploaded binary will be used. The image will be loadable via the `/path/to/the/image/image.jpg` path. The `container` property controls whether the node can contain children. For images this is not needed but `folders` would need to be containers. diff --git a/doc/src/main/hugo/content/docs/image-manipulation.asciidoc b/doc/src/main/hugo/content/docs/image-manipulation.asciidoc index 56e45d18d4..8172905706 100644 --- a/doc/src/main/hugo/content/docs/image-manipulation.asciidoc +++ b/doc/src/main/hugo/content/docs/image-manipulation.asciidoc @@ -24,21 +24,9 @@ The following image formats are supported: `png`, `jpg`, `bmp`, `gif` and `webp` Endpoint: ```{apiLatest}/:projectName/nodes/:uuid/binary/:fieldname?w=220``` -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?w=500 - -.via UUID -image::https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?w=300&version=1.0[Example Image,role="img-responsive"] - === Using Path -Images can be loaded similar to regular contents. It is also possible to load them using the WebRoot path. - -TIP: By Path: https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?h=300 - -.via webroot path -image::https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?w=500[Image By Path] +Images can be loaded similar to regular contents. It is also possible to load them using the WebRoot path: ```{apiLatest}/:projectName/webroot/path/to/the/image/image.jpg?h=300``` === Resizing Options @@ -60,13 +48,8 @@ You can use the resizing option `resize=force` to request the source image with Note that using the force-resizing mode can potentially lead to non-proportional resizing and thus potentially distort your image. .When providing width and height Mesh resizes and crops the image to the desired format. Cropping happens only if necessary and only in one dimension. -image::https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?w=500&h=200[Image with width and height] - .When adding the resize parameter `prop` the image gets scaled proportionally to fit the dimensions. -image::https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?w=500&h=200&resize=prop[Image with width and height and forced resize] - .When adding the resize parameter `force` the image gets distorted to fit the dimensions -image::https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?w=500&h=200&resize=force[Image with width and height and forced resize] == Crop @@ -74,9 +57,6 @@ You can also selectively extract a certain portion of your image by providing a NOTE: It is mandatory to specify all four crop parameters when cropping an image. -.Let's say we want to highlight the motorcycle behind the car. We could do this by cropping everything else. -image::https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?rect=520,70,280,160&crop=rect[Cropped image] - TIP: Cropping can also be combined with resizing. == Placeholders @@ -89,10 +69,6 @@ It is also possible to use the image manipulation in combination with the WebRoo Endpoint: ```{apiLatest}/:projectName/webroot/:path?rect=10,100,800,400&crop=rect``` -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?rect=10,100,800,400&crop=rect - == Focal Point Responsive designs often suggest the usage of https://developer.mozilla.org/en-US/docs/Learn/HTML/Multimedia_and_embedding/Responsive_images[srcset images for responsive images]. @@ -110,34 +86,15 @@ Otherwise Gentics Mesh can't tell which area of the image needs to be cropped. Finally the `fpdebug` parameter can be used to visualize the focal point. This is useful when testing designs and resize parameters. -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?fpx=0.5&fpy=0.4&w=800&h=600&crop=fp&fpdebug=true - In some cases you may want to show just a single area of the image. In this case you can use the `fpz` zoom parameter to zoom to the focal point area. -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?fpx=0.5&fpy=0.35&fpz=3.0&w=800&h=600&crop=fp&fpdebug=true - It is also possible to store focal point information along with the binary field. This way you can set the focal point once and omit it within the image request. In those cases it is not needed to specify the `fpx` and `fpy` parameter. Gentics Mesh will automatically load the missing parameter from the binary field if possible. -.Try the example -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?fpz=1.2&w=800&h=600&crop=fp&fpdebug=true - - === Responsive Design You can use the focal point feature to mark the point of interest in your images. That information can be used to generate different size sets of your images. Different image sizes may be required by your responsive design. The focal point will be used by Gentics Mesh to crop the image in the desired way. -image::https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?w=600&h=300&crop=fp&fpdebug=true&version=1.0[Image with FP] - -image::https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?w=200&h=200&crop=fp&fpdebug=true&version=1.0[Image with FP] - -image::https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?w=100&h=300&crop=fp&fpdebug=true&version=1.0[Image with FP] - === Updating Focalpoint The focal point can be updated by updating the node which contains the binary field. @@ -145,7 +102,7 @@ The focal point can be updated by updating the node which contains the binary fi .Example Request: [source,bash,subs="+attributes"] ---- -POST {apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6 +POST {apiLatest}/demo/nodes/:imageNodeUuid { "language": "en", @@ -166,7 +123,7 @@ Alternatively the focal can also be set when transforming the binary field. *Example Request:* [source,bash,subs="+attributes"] ---- -POST {apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binaryTransform/image +POST {apiLatest}/demo/nodes/:imageNodeUuid/binaryTransform/image { "version" : "1.0", @@ -191,7 +148,7 @@ Endpoint: ```POST {apiLatest}/:projectName/nodes/:uuid/binaryTransform/:fieldnam *Example Request:* [source,bash,subs="+attributes"] ---- -POST {apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binaryTransform/image +POST {apiLatest}/demo/nodes/:imageNodeUuid/binaryTransform/image { "version" : "1.0", diff --git a/doc/src/main/hugo/content/docs/java-rest-client.asciidoc b/doc/src/main/hugo/content/docs/java-rest-client.asciidoc index 21d618cf98..14c42fe354 100644 --- a/doc/src/main/hugo/content/docs/java-rest-client.asciidoc +++ b/doc/src/main/hugo/content/docs/java-rest-client.asciidoc @@ -62,8 +62,8 @@ Builder builder = MeshRestClientConfig.newConfig(); builder.addTrustedCA("certs/server.pem"); builder.setClientCert("certs/alice.pem"); builder.setClientKey("certs/alice.key"); -builder.setHost("demo.getmesh.io"); -builder.setPort(443); +builder.setHost("localhost"); +builder.setPort(8443); builder.setSsl(true); builder.setHostnameVerification(false); builder.setBasePath("/api/v2"); diff --git a/doc/src/main/hugo/content/docs/mesh-insomnia-v1.json b/doc/src/main/hugo/content/docs/mesh-insomnia-v1.json index 6368f922b9..6706b9ec54 100644 --- a/doc/src/main/hugo/content/docs/mesh-insomnia-v1.json +++ b/doc/src/main/hugo/content/docs/mesh-insomnia-v1.json @@ -278,7 +278,7 @@ "color": null, "created": 1492520447982, "data": { - "baseurl": "https://demo.getmesh.io/api/v1", + "baseurl": "https://localhost:8080/api/v1", "password": "admin", "project": "demo", "username": "admin" @@ -1457,7 +1457,7 @@ "authentication": {}, "body": { "mimeType": "application/json", - "text": "{\n\t\"hostname\":\"demo.getmesh.io\"\n}" + "text": "{\n\t\"hostname\":\"localhost\"\n}" }, "created": 1532335215556, "description": "", diff --git a/doc/src/main/hugo/content/docs/mesh-insomnia-v2.json b/doc/src/main/hugo/content/docs/mesh-insomnia-v2.json index 4743f5b6a2..3842716da0 100644 --- a/doc/src/main/hugo/content/docs/mesh-insomnia-v2.json +++ b/doc/src/main/hugo/content/docs/mesh-insomnia-v2.json @@ -278,7 +278,7 @@ "color": null, "created": 1492520447982, "data": { - "baseurl": "https://demo.getmesh.io/api/v2", + "baseurl": "https://localhost:8080/api/v2", "password": "admin", "project": "demo", "username": "admin" @@ -1457,7 +1457,7 @@ "authentication": {}, "body": { "mimeType": "application/json", - "text": "{\n\t\"hostname\":\"demo.getmesh.io\"\n}" + "text": "{\n\t\"hostname\":\"localhost\"\n}" }, "created": 1532335215556, "description": "", diff --git a/doc/src/main/hugo/content/docs/references.asciidoc b/doc/src/main/hugo/content/docs/references.asciidoc index c75a97d820..d892968a5d 100644 --- a/doc/src/main/hugo/content/docs/references.asciidoc +++ b/doc/src/main/hugo/content/docs/references.asciidoc @@ -41,48 +41,6 @@ include::content/docs/examples/tables/NodeParametersImpl.adoc-include[] include::content/docs/examples/tables/RolePermissionParametersImpl.adoc-include[] -=== Examples - -We have set up a Gentics Mesh instance for demo purposes, that you can play with. - -*Let's see what's inside...* - -.List all projects. Well, it's just our demo project. -[TIP] -https://demo.getmesh.io{apiLatest}/projects - -.Want to fetch all content items including media? With pretty URLs? Here you go -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/?resolveLinks=short - -.OK, let's load a single content item. -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/fc3c85be82584ae2bc85be82588ae2b0 - -.And now forget about UUIDs and do it with its corresponding WebRoot path -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/automobiles/ford-gt - -That's easy. Well, what about images? - -.That's the image node -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6 - -.And that's the actual image -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image - -.Let's do some resizing -[TIP] -https://demo.getmesh.io{apiLatest}/demo/nodes/df8beb3922c94ea28beb3922c94ea2f6/binary/image?width=400 - -.And now again with a readable WebRoot path -[TIP] -https://demo.getmesh.io{apiLatest}/demo/webroot/images/ford-gt.jpg?width=400 - -TIP: The https://insomnia.rest/[Insomnia] REST client can be used to build and invoke requests from your browser to Gentics Mesh. - == HTTP === Encoding @@ -208,7 +166,6 @@ Here is a quick guide to import the API into link:https://www.getpostman.com/[Po * Once the Postman app is started go to "Import" > "Import from Link" * Input the URL to the `/raml` endpoint of your Mesh instance. -* You can also try https://demo.getmesh.io{apiLatest}/raml to get it form our demo TIP: Make use of the params and workspace parameters to maximize your productiviy. Check out the link:https://www.getpostman.com/docs/v6/postman/sending_api_requests/requests#url[Postman documentation about URL setup] for more. diff --git a/doc/src/main/hugo/data/github.json b/doc/src/main/hugo/data/github.json index 9e39f983f5..503008fe70 100644 --- a/doc/src/main/hugo/data/github.json +++ b/doc/src/main/hugo/data/github.json @@ -71,7 +71,7 @@ "ssh_url": "git@github.com:gentics/mesh.git", "clone_url": "https://github.com/gentics/mesh.git", "svn_url": "https://github.com/gentics/mesh", - "homepage": "https://getmesh.io", + "homepage": "https://gentics.com/mesh", "size": 312291, "stargazers_count": 570, "watchers_count": 570, diff --git a/doc/src/main/hugo/data/releases.json b/doc/src/main/hugo/data/releases.json index 51e0e5f045..7d31d489ae 100644 --- a/doc/src/main/hugo/data/releases.json +++ b/doc/src/main/hugo/data/releases.json @@ -38,7 +38,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.1.5", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.1.5", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/172369834", @@ -79,7 +79,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.33", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.33", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/169108360", @@ -120,7 +120,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.1.4", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.1.4", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/169062702", @@ -161,7 +161,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.32", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.32", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/162556622", @@ -202,7 +202,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.1.3", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.1.3", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/162514760", @@ -243,7 +243,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.31", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.31", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/155519760", @@ -284,7 +284,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.1.2", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.1.2", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/155493724", @@ -325,7 +325,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.30", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.30", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/147472932", @@ -366,7 +366,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.18", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.18", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/145077614", @@ -407,7 +407,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.17", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.17", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/145039872", @@ -448,7 +448,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.29", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.29", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/143988130", @@ -489,7 +489,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.16", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.16", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/143824713", @@ -530,7 +530,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.28", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.28", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/143053765", @@ -571,7 +571,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.15", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.15", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/140364788", @@ -612,7 +612,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.14", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.14", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/140336630", @@ -653,7 +653,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.26", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.26", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/138341015", @@ -694,7 +694,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.13", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.13", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/137249788", @@ -735,7 +735,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.25", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.25", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/136546986", @@ -776,7 +776,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.12", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.12", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/136517039", @@ -817,7 +817,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.24", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.24", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/134663533", @@ -858,7 +858,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.11", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.11", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/134613870", @@ -899,7 +899,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.23", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.23", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/132866035", @@ -940,7 +940,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.10", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.10", - "body": "[Changelog](https://getmesh.io/docs/changelog#v2.0.10)\r\n[Download Demo](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-demo/2.0.10/mesh-demo-2.0.10.jar)\r\n[Download Server](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-server/2.0.10/mesh-server-2.0.10.jar)" + "body": "[Changelog](https://gentics.com/mesh/docs/changelog#v2.0.10)\r\n[Download Demo](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-demo/2.0.10/mesh-demo-2.0.10.jar)\r\n[Download Server](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-server/2.0.10/mesh-server-2.0.10.jar)" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/132843735", @@ -981,7 +981,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.22", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.22", - "body": "LTS (Long-term Support) commercial release\r\n\r\n[LTS Changelog](https://getmesh.io/docs/lts-changelog#v1.10.22)" + "body": "LTS (Long-term Support) commercial release\r\n\r\n[LTS Changelog](https://gentics.com/mesh/docs/lts-changelog#v1.10.22)" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/131934004", @@ -1022,7 +1022,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.21", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.21", - "body": "LTS (Long-term Support) commercial release\n" + "body": "LTS (Long-term Support) commercial release\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/130076406", @@ -1063,7 +1063,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.9", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.9", - "body": "" + "body": "" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/130037315", @@ -1104,7 +1104,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.20", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.20", - "body": "LTS (Long-term Support) commercial release\r\n" + "body": "LTS (Long-term Support) commercial release\r\n" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/127710244", @@ -1145,7 +1145,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/2.0.8", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/2.0.8", - "body": "[Changelog](https://getmesh.io/docs/changelog#v2.0.8)\r\n[Download Demo](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-demo/2.0.8/mesh-demo-2.0.8.jar)\r\n[Download Server](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-server/2.0.8/mesh-server-2.0.8.jar)" + "body": "[Changelog](https://gentics.com/mesh/docs/changelog#v2.0.8)\r\n[Download Demo](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-demo/2.0.8/mesh-demo-2.0.8.jar)\r\n[Download Server](https://maven.gentics.com/maven2/com/gentics/mesh/mesh-server/2.0.8/mesh-server-2.0.8.jar)" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/127684056", @@ -1186,7 +1186,7 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.19", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.19", - "body": "LTS (Long-term Support) commercial release\r\n\r\n[LTS Changelog](https://getmesh.io/docs/lts-changelog#v1.10.19)" + "body": "LTS (Long-term Support) commercial release\r\n\r\n[LTS Changelog](https://gentics.com/mesh/docs/lts-changelog#v1.10.19)" }, { "url": "https://api.github.com/repos/gentics/mesh/releases/126437269", @@ -1227,6 +1227,6 @@ ], "tarball_url": "https://api.github.com/repos/gentics/mesh/tarball/1.10.18", "zipball_url": "https://api.github.com/repos/gentics/mesh/zipball/1.10.18", - "body": "LTS (Long-term Support) commercial release\r\n\r\n[LTS Changelog](https://getmesh.io/docs/lts-changelog#v1.10.18)" + "body": "LTS (Long-term Support) commercial release\r\n\r\n[LTS Changelog](https://gentics.com/mesh/docs/lts-changelog#v1.10.18)" } ] diff --git a/doc/src/main/hugo/themes/gentics/layouts/download/download.html b/doc/src/main/hugo/themes/gentics/layouts/download/download.html index 82d13cc5f5..5d6d50c000 100644 --- a/doc/src/main/hugo/themes/gentics/layouts/download/download.html +++ b/doc/src/main/hugo/themes/gentics/layouts/download/download.html @@ -46,7 +46,7 @@

Java

GPG keys: - 

curl https://getmesh.io/public-key.asc | gpg --import
+ 
curl https://gentics.com/mesh/public-key.asc | gpg --import
Demo: GPG signature - sha256
Server: GPG signature - sha256

diff --git a/doc/src/main/hugo/themes/gentics/layouts/partials/ldjson.html b/doc/src/main/hugo/themes/gentics/layouts/partials/ldjson.html index b6f0d47900..2f7d9b278e 100644 --- a/doc/src/main/hugo/themes/gentics/layouts/partials/ldjson.html +++ b/doc/src/main/hugo/themes/gentics/layouts/partials/ldjson.html @@ -3,8 +3,8 @@ "@context": "http://schema.org", "@type": "Organization", "name": "Gentics Mesh", - "url": "https://getmesh.io", - "logo": "https://getmesh.io/assets/gentics-mesh-logo.png", + "url": "https://gentics.com/mesh", + "logo": "https://gentics.com/mesh/assets/gentics-mesh-logo.png", "address": { "@type": "PostalAddress", "streetAddress": "Laimgrubengasse 10", diff --git a/doc/src/main/java/com/gentics/mesh/example/MeshRestClientExample.java b/doc/src/main/java/com/gentics/mesh/example/MeshRestClientExample.java index 1d2c2263d4..e50e55a20e 100644 --- a/doc/src/main/java/com/gentics/mesh/example/MeshRestClientExample.java +++ b/doc/src/main/java/com/gentics/mesh/example/MeshRestClientExample.java @@ -21,8 +21,8 @@ public static void main(String[] args) { builder.addTrustedCA("certs/server.pem"); builder.setClientCert("certs/alice.pem"); builder.setClientKey("certs/alice.key"); - builder.setHost("demo.getmesh.io"); - builder.setPort(443); + builder.setHost("localhost"); + builder.setPort(8443); builder.setSsl(true); builder.setHostnameVerification(false); builder.setBasePath("/api/v2"); diff --git a/rest-client/src/main/java/com/gentics/mesh/rest/client/MeshRestClientConfig.java b/rest-client/src/main/java/com/gentics/mesh/rest/client/MeshRestClientConfig.java index 4192fb7efa..5427e903f0 100644 --- a/rest-client/src/main/java/com/gentics/mesh/rest/client/MeshRestClientConfig.java +++ b/rest-client/src/main/java/com/gentics/mesh/rest/client/MeshRestClientConfig.java @@ -216,7 +216,7 @@ public Builder setProtocolVersion(ProtocolVersion protocolVersion) { } /** - * Sets the host to connect to. Example: "demo.getmesh.io" + * Sets the host to connect to. Example: "localhost" * * This configuration is required. * diff --git a/rest-client/src/main/java/com/gentics/mesh/rest/monitoring/MonitoringClientConfig.java b/rest-client/src/main/java/com/gentics/mesh/rest/monitoring/MonitoringClientConfig.java index 7794477455..598bbdeef2 100644 --- a/rest-client/src/main/java/com/gentics/mesh/rest/monitoring/MonitoringClientConfig.java +++ b/rest-client/src/main/java/com/gentics/mesh/rest/monitoring/MonitoringClientConfig.java @@ -52,7 +52,7 @@ public MonitoringClientConfig build() { } /** - * Sets the host to connect to. Example: "demo.getmesh.io" + * Sets the host to connect to. Example: "localhost" * * This configuration is required. * From 9503f0beab2d25126d66d7d8f2174198c51ead1e Mon Sep 17 00:00:00 2001 From: Serhii Plyhun Date: Wed, 22 Jan 2025 13:21:19 +0100 Subject: [PATCH 2/6] No demo --- .../hugo/content/docs/contributing.asciidoc | 1 - .../docs/guides/mesh-react/index.asciidoc | 4 ++-- .../gentics/layouts/download/download.html | 16 ++------------ .../hugo/themes/gentics/layouts/index.html | 22 +------------------ 4 files changed, 5 insertions(+), 38 deletions(-) diff --git a/doc/src/main/hugo/content/docs/contributing.asciidoc b/doc/src/main/hugo/content/docs/contributing.asciidoc index e2a837265c..b10173e343 100644 --- a/doc/src/main/hugo/content/docs/contributing.asciidoc +++ b/doc/src/main/hugo/content/docs/contributing.asciidoc @@ -166,7 +166,6 @@ The single remote database is used for both single instance and clustered modes. | mesh-api | Contains API classes like Configuration POJOs and constants. | mesh-core | Contains the data model and the main codebase | mesh-database-connectors | Contains the database connectors code -| mesh-demo | Contains the Gentics Demo which can be run via the `DemoRunner` main class. | mesh-rest-client | Contains the Vert.x based REST client. | mesh-rest-model | Contains the POJOs for the REST API models. | mesh-doc | Contains sources for the getmesh.io documentation and tools to generate tables and examples from sources. diff --git a/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc b/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc index c8c80395d1..d2a8c5676c 100644 --- a/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc +++ b/doc/src/main/hugo/content/docs/guides/mesh-react/index.asciidoc @@ -148,11 +148,11 @@ Once the container has been setup, start the docker container and login `http:// docker run -v mesh-graphdb:/graphdb -v mesh-uploads:/uploads -p 8080:8080 gentics/mesh ---- -You can also skip Step 3 if you want and use our demo instance which already contains the demo content. +You can also skip Step 3 if you want and use our test instance, with no requirement of an external database. [source,bash] ---- -docker run -p 8080:8080 gentics/mesh-demo +docker run -p 8080:8080 gentics/mesh-hsqldb ---- == Step 3 - Schemas diff --git a/doc/src/main/hugo/themes/gentics/layouts/download/download.html b/doc/src/main/hugo/themes/gentics/layouts/download/download.html index 5d6d50c000..a9d32813dd 100644 --- a/doc/src/main/hugo/themes/gentics/layouts/download/download.html +++ b/doc/src/main/hugo/themes/gentics/layouts/download/download.html @@ -31,30 +31,18 @@

v{{ $version }}

features and fixes.

Docker

- 
docker run -p 8080:8080 gentics/mesh-demo:{{$version}}
+ 
docker run -p 8080:8080 gentics/mesh-hsqldb:{{$version}}
-

Java

-
- 
java -jar mesh-demo-{{$version}}.jar
-
-

- - Download - (sig) -

GPG keys: 

curl https://gentics.com/mesh/public-key.asc | gpg --import
- Demo: GPG signature - sha256
Server: GPG signature - sha256

For production purposes please download the Gentics Mesh server or use the docker image gentics/mesh free from any demo content.

+ >download the Gentics Mesh server or use the docker image gentics/mesh

diff --git a/doc/src/main/hugo/themes/gentics/layouts/index.html b/doc/src/main/hugo/themes/gentics/layouts/index.html index 94c17c2def..5df63b8cd2 100644 --- a/doc/src/main/hugo/themes/gentics/layouts/index.html +++ b/doc/src/main/hugo/themes/gentics/layouts/index.html @@ -61,28 +61,8 @@

Download

Download -
-
-

Run

-

Start the JAR-file by executing - 

java -jar mesh-demo-X.X.X.jar
-

-
-
-
-
-

Done

-

Point your browser to -
- http://localhost:8080/mesh-ui/ -
to reach the Gentics Mesh User Interface -
the initial credentials are - admin/admin -

-
-
-

Find a more in-depth setup guide in the +

Find an in-depth setup guide in the getting started guide.

From e1dcd42b59bb6197387f557a759a6aeb7b233777 Mon Sep 17 00:00:00 2001 From: Serhii Plyhun Date: Wed, 22 Jan 2025 14:49:29 +0100 Subject: [PATCH 3/6] Build fix --- .../main/hugo/content/docs/features.asciidoc | 25 +++++++++++-------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/doc/src/main/hugo/content/docs/features.asciidoc b/doc/src/main/hugo/content/docs/features.asciidoc index b559385929..7442d7627b 100644 --- a/doc/src/main/hugo/content/docs/features.asciidoc +++ b/doc/src/main/hugo/content/docs/features.asciidoc @@ -215,6 +215,8 @@ The demo app includes a navigation object showing just the top-level elements _A === Response Sample +Retrieving a navigation object using the projects root node ```/``` including the top level navigation menu items. The same can be achieved using the node specific navigation endpoint. In this case you can specify the root node of your navigation by providing the node uuid. + [source,json] ---- { @@ -891,7 +893,7 @@ Loading the node with the given UUID using API endpoint ```GET {apiLatest}/:proj ==== Fetch node with WebRoot path -```GET {apiLatest}/:projectName/webroot/path/to/the/image/image?resolveLinks=short``` +Accessing the node located at `path/to/the/image/image` looks like following ```GET {apiLatest}/:projectName/webroot/path/to/the/image/image?resolveLinks=short``` === Query binary content by path The WebRoot API, furthermore, directly supports delivering binary content (e.g., images, documents, etc.) using the ```fileName``` meta-data field of the ```binary``` field. @@ -902,13 +904,11 @@ NOTE: Downloads of resized images currently do not support byte range requests. ==== Fetch an image with UUID -```GET {apiLatest}/:projectName/nodes/:imageNodeUuid/binary/:binaryFieldName``` - Downloading a node's binary field with the given name using API endpoint ```GET {apiLatest}/:projectName/nodes/:nodeUuid/binary/:fieldName```. ==== Fetch an image with WebRoot path -```GET {apiLatest}/:projectName/webroot/path/to/the/image/image.jpg``` +Same as above, but over the node's path `path/to/the/image/image.jpg` is ```GET {apiLatest}/:projectName/webroot/path/to/the/image/image.jpg``` TIP: When using a routing framework, in order to find out if a requested resource is binary data or JSON data you need to check the HTTP Content-Disposition response header. If it is set, it’s binary data. @@ -918,11 +918,11 @@ link:{{}}[Image Manipulation] such as crop ==== Crop and resize an image with UUID -```GET {apiLatest}/:projectName/nodes/:imageNodeUuid/binary/:binaryFieldName?rect=10,100,800,400&w=300&crop=rect``` +API call example: ```GET {apiLatest}/:projectName/nodes/:imageNodeUuid/binary/:binaryFieldName?rect=10,100,800,400&w=300&crop=rect``` ==== Crop and resize an image with WebRoot path -```GET {apiLatest}/:projectName/webroot/path/to/the/image/image.jpg?rect=10,100,800,400&w=300&crop=rect``` +API call example: ```GET {apiLatest}/:projectName/webroot/path/to/the/image/image.jpg?rect=10,100,800,400&w=300&crop=rect``` == Link Resolving @@ -1507,6 +1507,7 @@ POST {apiLatest}/roles/:roleUuid/permissions/users You can query the updated permissions with user ```admin```: +[source,bash,subs=attributes] ----- GET {apiLatest}/roles/:roleUuid/permissions/users ----- @@ -1567,8 +1568,8 @@ POST {apiLatest}/roles/:roleUuid/permissions/groups/:groupUuid You can query the updated permissions with user ```admin```: -* `{apiLatest}/roles/:roleUuid/permissions/groups/:groupUuid` -* `{apiLatest}/roles/:roleUuid/permissions/users` +* ```{apiLatest}/roles/:roleUuid/permissions/groups/:groupUuid``` +* ```{apiLatest}/roles/:roleUuid/permissions/users``` ===== Role permissions All possible role permissions on groups are summarized in the following table. @@ -1625,7 +1626,11 @@ POST {apiLatest}/roles/:roleUuid/permissions/roles } ----- -You can query the updated permissions with user ```admin```. +You can query the updated permissions with user ```admin```: + +* '''GET {apiLatest}/roles/:adminRoleUuid/permissions/roles``` + +* Or alternatively with ```GET {apiLatest}/roles?role=:adminRoleUuid``` ===== Role permissions All possible role permissions on roles are summarized in the following table. @@ -1897,8 +1902,6 @@ Versions of a node can be listed via the ```{apiLatest}/:projectName/nodes/:uuid "draft" : true, "published" : true, "branchRoot" : false - } - … } ] } ``` From eca29c58bb6267042660cd535ec6af93e08b6ab1 Mon Sep 17 00:00:00 2001 From: Serhii Plyhun Date: Wed, 22 Jan 2025 15:06:50 +0100 Subject: [PATCH 4/6] No blog --- doc/src/main/hugo/content/docs/features.asciidoc | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/doc/src/main/hugo/content/docs/features.asciidoc b/doc/src/main/hugo/content/docs/features.asciidoc index 7442d7627b..221912e0ac 100644 --- a/doc/src/main/hugo/content/docs/features.asciidoc +++ b/doc/src/main/hugo/content/docs/features.asciidoc @@ -843,6 +843,7 @@ By prepending the path with a forward slash, the same request will resolve the n | Request | API endpoint | Response code + | GET | {apiLatest}/docs/hello-world/example-page.html | 200 @@ -854,18 +855,7 @@ Possible applications for the `urlFields` property are: * Nice URL handling * Redirection handling -Using the WebRoot API it is possible to easily integrate Gentics Mesh with many known routing frameworks. - -[options="header"] -|====== -| Framework | Language | Example -| http://silex.sensiolabs.org/[Silex] | PHP | https://gentics.com/mesh/Blog/Building+an+API-first+Web+App+with+Gentics+Mesh+and+the+PHP+Microframework+Silex[blog post] -| http://expressjs.com/[ExpressJS] | JS | https://gentics.com/mesh/Blog/Getting+started+with+Express+and+the+API-first+CMS+Gentics+Mesh[blog post] -| http://vertx.io/[Vert.x] | Java,JS,Ceylon | http://vertx.io/blog/data-driven-apps-made-easy-with-vert-x-3-4-0-and-headless-cms-gentics-mesh/[blog post] -| http://lotusrb.org/[Lotus] | Ruby | - -|====== - -//TODO blog post on WebRoot API +Using the WebRoot API it is possible to easily integrate Gentics Mesh with many known routing frameworks. An example of API usage in https://vertx.io/[Vert.x] Java framework is shown in the http://vertx.io/blog/data-driven-apps-made-easy-with-vert-x-3-4-0-and-headless-cms-gentics-mesh/[blog post]. === API endpoints From 856db1ffcb07f11e67f830b7691e0e2e008923c4 Mon Sep 17 00:00:00 2001 From: Serhii Plyhun Date: Wed, 22 Jan 2025 15:10:01 +0100 Subject: [PATCH 5/6] Minor fix --- doc/src/main/hugo/content/docs/cookbook/index.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/src/main/hugo/content/docs/cookbook/index.asciidoc b/doc/src/main/hugo/content/docs/cookbook/index.asciidoc index 7b6a1e40e4..166ffcfef0 100644 --- a/doc/src/main/hugo/content/docs/cookbook/index.asciidoc +++ b/doc/src/main/hugo/content/docs/cookbook/index.asciidoc @@ -14,7 +14,7 @@ Handling contents is fairly easy. You can either identify and load content using By Path: ```GET {apiLatest}/:projectName/webroot/path/to/the/node``` -By Uuid: ```{apiLatest}/:projectName/nodes/:nodeUuid``` +By Uuid: ```GET {apiLatest}/:projectName/nodes/:nodeUuid``` You can either place the path or uuid to your content in a fragment `/:projectName#nodes/:nodeUuid` or in the regular web path `/:projectName/nodes/:nodeUuid`. Most modern single page application frameworks like angular or react support both variations. From d179cc5533f49cd63f62fbb6a6dfbf15debcc4cd Mon Sep 17 00:00:00 2001 From: Serhii Plyhun Date: Wed, 22 Jan 2025 15:33:15 +0100 Subject: [PATCH 6/6] Update platforms --- doc/src/main/hugo/content/docs/features.asciidoc | 2 +- doc/src/main/hugo/content/docs/platforms.asciidoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/main/hugo/content/docs/features.asciidoc b/doc/src/main/hugo/content/docs/features.asciidoc index 221912e0ac..2ce3398d71 100644 --- a/doc/src/main/hugo/content/docs/features.asciidoc +++ b/doc/src/main/hugo/content/docs/features.asciidoc @@ -855,7 +855,7 @@ Possible applications for the `urlFields` property are: * Nice URL handling * Redirection handling -Using the WebRoot API it is possible to easily integrate Gentics Mesh with many known routing frameworks. An example of API usage in https://vertx.io/[Vert.x] Java framework is shown in the http://vertx.io/blog/data-driven-apps-made-easy-with-vert-x-3-4-0-and-headless-cms-gentics-mesh/[blog post]. +Using the WebRoot API it is possible to easily integrate Gentics Mesh with many known routing frameworks. An example of API usage in https://vertx.io/[Vert.x] Java framework is described in the http://vertx.io/blog/data-driven-apps-made-easy-with-vert-x-3-4-0-and-headless-cms-gentics-mesh/[blog post]. Some other code examples can be found in the {{}}[Platforms] overview. === API endpoints diff --git a/doc/src/main/hugo/content/docs/platforms.asciidoc b/doc/src/main/hugo/content/docs/platforms.asciidoc index 6696b8e842..aabe0c4759 100644 --- a/doc/src/main/hugo/content/docs/platforms.asciidoc +++ b/doc/src/main/hugo/content/docs/platforms.asciidoc @@ -6,7 +6,7 @@ include::content/docs/variables.adoc-include[] == JavaScript -* link:https://github.com/gentics/mesh-js-api[Gentics Mesh JavaScript Client] - A work-in-progress client for Gentics Mesh written in TypeScript. +* link:https://github.com/gentics/mesh-ui[Gentics Mesh UI] * link:https://github.com/gentics/mesh-angular-example[Gentics Mesh Angular Example] * link:https://github.com/gentics/mesh-express-example[Gentics Mesh Express Example]