Skip to content
Snippets Groups Projects
Commit b68c20f6 authored by ncastejon's avatar ncastejon
Browse files

Improve organizations and resources documentation

parent 3b08a667
No related branches found
No related tags found
No related merge requests found
......@@ -15,7 +15,7 @@ The entrypoint of the service is a REST API provided by a [NestJS](https://githu
## API documentation
NestJS provides a swagger module that can be easily integrated. Using specific annotations alongside your endpoints declaration, this module will automatically generates a swagger documentation, reachable at `/api-docs`.
NestJS provides a swagger module that can be easily integrated. Using specific annotations alongside your endpoints declaration, this module will automatically generates a swagger documentation, reachable at `/api-doc`.
## Service health
......
# Resources service
## What it does
This service can provide lists of resources and formats.
A resource is an entity representing some information, usually geographic, that can be accessed by a query (for example Web Map Service) or by downloading a file. One resource can be considered standard (e.g WMS protocol) or not standard (a custom service).
Each resource is associated with one or many formats.
*Example:*
the output of a Web Feature Service (WFS), standard service providing an interface for geographical features, is a resource. And it is associated with many formats as such Shapefile or JSON.
## How it works
......@@ -14,7 +17,7 @@ The entrypoint of the service is a REST API provided by a [NestJS](https://githu
## API documentation
NestJS provides a swagger module that can be easily integrated. Using specific annotations alongside your endpoints declaration, this module will automatically generates a swagger documentation, reachable at `/api-docs`.
NestJS provides a swagger module that can be easily integrated. Using specific annotations alongside your endpoints declaration, this module will automatically generates a swagger documentation, reachable at `/api-doc`.
## Service health
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment