diff --git a/documentation/enunciate.xml b/documentation/enunciate/enunciate.xml similarity index 100% rename from documentation/enunciate.xml rename to documentation/enunciate/enunciate.xml diff --git a/documentation/sphinx/index.rst b/documentation/sphinx/index.rst index 7883f7a..a9dd2a1 100644 --- a/documentation/sphinx/index.rst +++ b/documentation/sphinx/index.rst @@ -220,14 +220,6 @@ The service exposes `its methods <../api-docs/index.html>`_ using a standard nam Service Discovery on IS ======================= -The service can be discovered in the gCore IS as gCore Endpoint with the following parameter: - -.. code:: xml - - org.gcube.service - helloworld - - The service can be discovered in the Facet-Based IS as EService with the following JSON query: .. code:: json @@ -240,7 +232,7 @@ The service can be discovered in the Facet-Based IS as EService with the followi "target": { "@class": "SoftwareFacet", "group": "org.gcube.service", - "name": "helloworld" + "name": "hello-world-service" } } ] @@ -254,5 +246,13 @@ The maven coordinates of the Hello World SG4 service are: .. code:: xml org.gcube.service - helloworld - \ No newline at end of file + hello-world-service + + +Postman Collection +======================= + +Here you can download the `postman collection to interact with the service <../api-docs/postman/hello-world-service.postman_collection.json>`_. +You also need the environment to be selected to be able to generate the authorization token. +This is an example of `postman environment <../api-docs/postman/hello-world-service-for-devvre.postman_environment.json>`_ for devVRE (/gcube/devsec/devVRE). +The latter must be configured by inserting the value of your username and password used in the D4Science infrastructure. diff --git a/pom.xml b/pom.xml index e16e8fa..be30921 100644 --- a/pom.xml +++ b/pom.xml @@ -222,7 +222,7 @@ - ${project.basedir}${file.separator}documentation${file.separator}enunciate.xml + ${project.basedir}${file.separator}documentation${file.separator}enunciate${file.separator}enunciate.xml diff --git a/documentation/postman/Hello World Env for devVRE.postman_environment.json b/src/main/webapp/api-docs/postman/hello-world-service-for-devvre.postman_environment.json similarity index 81% rename from documentation/postman/Hello World Env for devVRE.postman_environment.json rename to src/main/webapp/api-docs/postman/hello-world-service-for-devvre.postman_environment.json index 02bbf3e..3f08856 100644 --- a/documentation/postman/Hello World Env for devVRE.postman_environment.json +++ b/src/main/webapp/api-docs/postman/hello-world-service-for-devvre.postman_environment.json @@ -1,6 +1,5 @@ { - "id": "ff7036fd-e12d-4dd7-9d0f-816bb5a0f06a", - "name": "Hello World Env for devVRE", + "name": "Environment for devVRE", "values": [ { "key": "introspect_secret", @@ -14,7 +13,7 @@ "type": "secret", "enabled": true }, -{ + { "key": "service_client_secret", "value": "", "type": "secret", @@ -28,7 +27,7 @@ }, { "key": "username", - "value": "luca.frosini", + "value": "", "type": "default", "enabled": true }, @@ -68,8 +67,5 @@ "type": "default", "enabled": true } - ], - "_postman_variable_scope": "environment", - "_postman_exported_at": "2024-05-24T16:06:23.560Z", - "_postman_exported_using": "Postman/11.1.14" + ] } \ No newline at end of file diff --git a/documentation/postman/Hello World Service.postman_collection.json b/src/main/webapp/api-docs/postman/hello-world-service.postman_collection.json similarity index 100% rename from documentation/postman/Hello World Service.postman_collection.json rename to src/main/webapp/api-docs/postman/hello-world-service.postman_collection.json