Skip to content

Commit

Permalink
Merge pull request #1371 from betagouv/nouveau-swagger-cvec-et-modifs
Browse files Browse the repository at this point in the history
Nouveau swagger CVEC et modifs
  • Loading branch information
arslanegharout authored Aug 30, 2024
2 parents 96f863d + e9ba8ad commit df91471
Show file tree
Hide file tree
Showing 6 changed files with 198 additions and 152 deletions.
2 changes: 1 addition & 1 deletion _data/api/api-cvec.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ themes:
- Particulier
- Education
contact_link: api-boursier@cnous.fr
doc_tech_link: /swaggers/api-cvec.json
doc_tech_link: /swaggers/api-cvec-new.json
visits_2019: 3000
last_update: 15/04/2022
---
Expand Down
7 changes: 2 additions & 5 deletions _data/api/api_quiforme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ contact_link: quiforme@intercariforef.org
partners: # Vous pouvez ajouter ici la liste des co-producteurs de l'API si cela vous paraît cohérent.
# - insee
is_open: -1
datapass_link: https://datapass.api.gouv.fr/TODO
is_france_connected: -1
access_page:
- who:
Expand All @@ -22,14 +21,12 @@ access_page:
is_eligible: 0
description: |
En tant qu'éditeur de logiciel, vous êtes éligible à intégrer cette API si vous le faîtes pour le compte d'une entité publique (administrations, collectivités, etc.) dont vous êtes le prestataire.
Vous pouvez déposer une demande d'habilitation :
<Button href="https://datapass.api.gouv.fr/TODO">Demander un accès</Button>
Vous pouvez demander l'accès à l'API en écrivant à cette adresse : quiforme@intercariforef.org
- who:
- Une administration
is_eligible: 1
description: |
En tant que collectivité territoriale ou administration, vous êtes éligible à utiliser cette API selon votre cadre juridique. Vous pouvez déposer une demande d'habilitation :
<Button href="https://datapass.api.gouv.fr/TODO">Demander un accès</Button>
En tant que collectivité territoriale ou administration, vous êtes éligible à utiliser cette API selon votre cadre juridique. Vous pouvez demander l'accès à l'API en écrivant à cette adresse : quiforme@intercariforef.org
rate_limiting_resume: Volumétrie inconnue
rate_limiting_description: |
Le fournisseur de la donnée n'a pas cette information.
Expand Down
2 changes: 1 addition & 1 deletion _data/guides/diffusion-api-guide-pratique.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ L'[API Entreprise](https://api.gouv.fr/les-api/api-entreprise) et l'[API Particu

Pour les API qui demandent une habilitation pour y avoir accès, DataPass permet de dématérialiser les conventions entre les producteurs d'API et les demandeurs. Plusieurs avantages : centraliser les demandes, fluidifier et accélérer le traitement des demandes, et sécuriser les échanges.

[Voir la présentation complète de DataPass](/resources/DataPass_presentation_produit.pdf)
[Voir la présentation complète de DataPass](/resources/DataPass_presentation_new.pdf)

<details>
<summary>**Dans le cas des API exposées avec une page dédiée**</summary>
Expand Down
Binary file not shown.
194 changes: 194 additions & 0 deletions public/swaggers/api-cvec-new.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
{
"openapi": "3.0.0",
"info": {
"title": "CVEC",
"description": "API controle des attestations",
"version": "4.1.24"
},
"paths": {
"/api/attestation/{code}": {
"get": {
"parameters": [
{
"name": "code",
"in": "path",
"description": "n°attestation",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "etudiant",
"in": "query",
"description": "5 premières lettres du nom de l'étudiant"
}
],
"responses": {
"200": {
"description": "Contient l'attestation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CertificateDto"
}
}
}
},
"400": {
"description": "L'attestation n'a pas été trouvée.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CertificateErrorDto"
}
}
}
},
"404": {
"description": "Le paramètre code est manquant.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CertificateErrorDto"
}
}
}
}
}
},
"servers": [
{
"url": "https://cvec-ctrl.etudiant.gouv.fr"
},
{
"url": "https://cve-controle-prod.nuonet.fr"
},
{
"url": "https://cve-2020-controle-prod.nuonet.fr"
},
{
"url": "https://cve-2021-controle-prod.nuonet.fr"
},
{
"url": "https://cve-2022-controle-prod.nuonet.fr"
},
{
"url": "https://cve-2023-controle-prod.nuonet.fr"
}
]
}
},
"components": {
"schemas": {
"CertificateErrorDto": {
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"type": "object"
},
"GrantNotificationErrorDto": {
"properties": {
"code": {
"type": "string"
},
"libelle": {
"type": "string"
}
},
"type": "object"
},
"CertificateIneDto": {
"properties": {
"nom": {
"type": "string"
},
"nomUsage": {
"type": "string"
},
"prenom": {
"type": "string"
},
"sexe": {
"type": "string"
},
"date_naissance": {
"type": "string"
},
"code": {
"type": "string"
},
"crous": {
"type": "string"
},
"etat": {
"$ref": "#/components/schemas/StateDto"
},
"exoneration": {
"$ref": "#/components/schemas/ExonerationDto"
}
},
"type": "object"
},
"CertificateDto": {
"properties": {
"nom": {
"type": "string"
},
"nomUsage": {
"type": "string"
},
"prenom": {
"type": "string"
},
"sexe": {
"type": "string"
},
"date_naissance": {
"type": "string"
},
"ine": {
"type": "string"
},
"crous": {
"type": "string"
},
"etat": {
"$ref": "#/components/schemas/StateDto"
},
"exoneration": {
"$ref": "#/components/schemas/ExonerationDto"
}
},
"type": "object"
},
"StateDto": {
"properties": {
"code": {
"type": "string"
},
"libelle": {
"type": "string"
}
},
"type": "object"
},
"ExonerationDto": {
"properties": {
"active": {
"type": "boolean"
},
"motif": {
"type": "string"
}
},
"type": "object"
}
}
}
}
145 changes: 0 additions & 145 deletions public/swaggers/api-cvec.json

This file was deleted.

0 comments on commit df91471

Please sign in to comment.