Improving project

This commit is contained in:
Luca Frosini 2024-05-28 15:38:21 +02:00
parent 46fe0ebdce
commit 413846ab40
5 changed files with 16 additions and 20 deletions

View File

@ -220,14 +220,6 @@ The service exposes `its methods <../api-docs/index.html>`_ using a standard nam
Service Discovery on IS Service Discovery on IS
======================= =======================
The service can be discovered in the gCore IS as gCore Endpoint with the following parameter:
.. code:: xml
<ServiceClass>org.gcube.service</ServiceClass>
<ServiceName>helloworld</ServiceName>
The service can be discovered in the Facet-Based IS as EService with the following JSON query: The service can be discovered in the Facet-Based IS as EService with the following JSON query:
.. code:: json .. code:: json
@ -240,7 +232,7 @@ The service can be discovered in the Facet-Based IS as EService with the followi
"target": { "target": {
"@class": "SoftwareFacet", "@class": "SoftwareFacet",
"group": "org.gcube.service", "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 .. code:: xml
<groupId>org.gcube.service</groupId> <groupId>org.gcube.service</groupId>
<artifactId>helloworld</artifactId> <artifactId>hello-world-service</artifactId>
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.

View File

@ -222,7 +222,7 @@
<!-- This does not works as expected. We need to use the maven-resources-plugin below <!-- This does not works as expected. We need to use the maven-resources-plugin below
<docsDir>${project.build.directory}${file.separator}${project.artifactId}-${project.version}${file.separator}api-docs</docsDir> <docsDir>${project.build.directory}${file.separator}${project.artifactId}-${project.version}${file.separator}api-docs</docsDir>
--> -->
<configFile>${project.basedir}${file.separator}documentation${file.separator}enunciate.xml</configFile> <configFile>${project.basedir}${file.separator}documentation${file.separator}enunciate${file.separator}enunciate.xml</configFile>
</configuration> </configuration>
</plugin> </plugin>

View File

@ -1,6 +1,5 @@
{ {
"id": "ff7036fd-e12d-4dd7-9d0f-816bb5a0f06a", "name": "Environment for devVRE",
"name": "Hello World Env for devVRE",
"values": [ "values": [
{ {
"key": "introspect_secret", "key": "introspect_secret",
@ -14,7 +13,7 @@
"type": "secret", "type": "secret",
"enabled": true "enabled": true
}, },
{ {
"key": "service_client_secret", "key": "service_client_secret",
"value": "", "value": "",
"type": "secret", "type": "secret",
@ -28,7 +27,7 @@
}, },
{ {
"key": "username", "key": "username",
"value": "luca.frosini", "value": "",
"type": "default", "type": "default",
"enabled": true "enabled": true
}, },
@ -68,8 +67,5 @@
"type": "default", "type": "default",
"enabled": true "enabled": true
} }
], ]
"_postman_variable_scope": "environment",
"_postman_exported_at": "2024-05-24T16:06:23.560Z",
"_postman_exported_using": "Postman/11.1.14"
} }