fix(docs): update API docs (#118)

SocialGouv · Dec 6, 2021 · 8f6d23d · 8f6d23d
1 parent d56794d
commit 8f6d23d
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -6,9 +6,9 @@ Les données sont issues de [plusieurs jeux de données data.gouv.fr](./assembly
 
 Le dossier [`api`](./api) présente un exemple d'implémentation d'API NodeJS qui exploite cet index Elastic Search avec différentes requêtes.
 
-Un frontend de démo est disponible ici : https://p8dyl.csb.app/
+Un frontend de démo est disponible ici : https://recherche-entreprises.fabrique.social.gouv.fr
 
-Et vous pouvez utiliser librement l'API disponible sur https://api-recherche-entreprises.fabrique.social.gouv.fr cf [doc API](./api/README.md)
+Et vous pouvez utiliser librement l'API disponible sur https://api-recherche-entreprises.fabrique.social.gouv.fr cf [documentation API](./api/README.md)
 
 Exemple : [/api/v1/search?q=plume&a=paris](https://api-recherche-entreprises.fabrique.social.gouv.fr/api/v1/search?q=plume&a=paris)
 
@@ -40,11 +40,11 @@ Pour lancer les différentes parties du projet, un certain nombre d'outil doiven
 
 ### Assemblage des données
 
-Le script `sqlite.sh` permet de permet de télécharger les CSV, les importer dans SQLite pour les aggréger et les re-exporter en CSV.
+Le script `sqlite.sh` permet de permet de télécharger les CSV puis aggréger les données pour les re-exporter dans CSV "plat".
 
 Le fichier `./data/assembly.csv` fait +6Go avec plus de 30 millions de lignes.
 
-Cette opération dure environ 30 minutes.
+Cette opération dure environ 45 minutes.
 
 
 ### Indexation dans Elastic Search
@@ -78,6 +78,8 @@ yarn build
 ELASTICSEARCH_URL=http://localhost:9200 yarn start
 ```
 
+Le temps d'indexation est d'environ 1h.
+
 ## Projets relatifs
 
 - Annuaire-entreprises : https://annuaire-entreprises.data.gouv.fr

diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -16,8 +16,8 @@ schemes:
 paths:
   /search:
     get:
-      summary: "Recherche entreprise"
-      description: "Reherche d'entreprise par nom d'établissement, raison sociale"
+      summary: "Recherche d'entreprise par nom"
+      description: "Reherche d'entreprise par nom d'établissement, raison sociale, siret, siren"
       operationId: "search"
       tags:
         - "Recherche"
@@ -81,7 +81,41 @@ paths:
       responses:
         "500":
           description: "Unexpexted error occured"
-
+  /etablissement/{siret}:
+    get:
+      summary: "Recherche d'entreprise par SIRET"
+      description: "Reherche d'entreprise par numéro SIRET"
+      operationId: "siret"
+      tags:
+        - "Recherche"
+      produces:
+        - "application/json"
+      parameters:
+        - in: "path"
+          name: "siret"
+          description: "Numéro de SIRET (9 caractères)"
+          required: true
+          type: string
+          example: "323841353"
+          value: "323841353"
+  /entreprise/{siren}:
+    get:
+      summary: "Recherche d'entreprise par SIREN"
+      description: "Reherche d'entreprise par numéro SIREN  (14 caractères)"
+      operationId: "siren"
+      tags:
+        - "Recherche"
+      produces:
+        - "application/json"
+      parameters:
+        - in: "path"
+          name: "siren"
+          description: "Numéro de SIREN"
+          required: true
+          type: string
+          length: 14
+          example: "32384135300911"
+          value: "32384135300911"
 externalDocs:
-  description: "Find out more about Swagger"
-  url: "http://swagger.io"
+  description: "Source sur GitHub"
+  url: "https://github.com/socialgouv/recherche-enterprises"