From b68c20f69fa013f455b258c9d97a3ac216c0b6fa Mon Sep 17 00:00:00 2001 From: ncastejon <castejon.nicolas@gmail.com> Date: Thu, 6 Jun 2019 10:38:23 +0200 Subject: [PATCH] Improve organizations and resources documentation --- architecture/services/organizations.md | 2 +- architecture/services/resources.md | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/architecture/services/organizations.md b/architecture/services/organizations.md index caa7cbf..55e0fe7 100644 --- a/architecture/services/organizations.md +++ b/architecture/services/organizations.md @@ -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 diff --git a/architecture/services/resources.md b/architecture/services/resources.md index a23801e..4986784 100644 --- a/architecture/services/resources.md +++ b/architecture/services/resources.md @@ -1,9 +1,12 @@ # 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 -- GitLab