Skip to content

Commit

Permalink
feat/bump-api-schema-0-17-0
Browse files Browse the repository at this point in the history
  • Loading branch information
hlecuyer committed Sep 2, 2024
1 parent 78a7747 commit 3db4ce5
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 9 deletions.
6 changes: 4 additions & 2 deletions api/requirements/dev-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ cryptography==42.0.5
# via
# data-inclusion-api (setup.py)
# python-jose
data-inclusion-schema==0.16.0
data-inclusion-schema==0.17.0
# via data-inclusion-api (setup.py)
distlib==0.3.8
# via virtualenv
Expand Down Expand Up @@ -116,7 +116,9 @@ idna==3.7
inflate64==1.0.0
# via py7zr
jinja2==3.1.3
# via fastapi-debug-toolbar
# via
# data-inclusion-api (setup.py)
# fastapi-debug-toolbar
mako==1.3.3
# via alembic
markupsafe==2.1.5
Expand Down
2 changes: 1 addition & 1 deletion api/requirements/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ cryptography==42.0.5
# via
# data-inclusion-api (setup.py)
# python-jose
data-inclusion-schema==0.16.0
data-inclusion-schema==0.17.0
# via data-inclusion-api (setup.py)
dnspython==2.6.1
# via email-validator
Expand Down
6 changes: 4 additions & 2 deletions api/requirements/test-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ cryptography==42.0.5
# via
# data-inclusion-api (setup.py)
# python-jose
data-inclusion-schema==0.16.0
data-inclusion-schema==0.17.0
# via data-inclusion-api (setup.py)
dnspython==2.6.1
# via email-validator
Expand Down Expand Up @@ -106,7 +106,9 @@ inflate64==1.0.0
iniconfig==2.0.0
# via pytest
jinja2==3.1.3
# via fastapi-debug-toolbar
# via
# data-inclusion-api (setup.py)
# fastapi-debug-toolbar
mako==1.3.3
# via alembic
markupsafe==2.1.5
Expand Down
2 changes: 1 addition & 1 deletion api/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"sqlalchemy",
"tqdm",
"uvicorn[standard]",
"data-inclusion-schema==0.16.0",
"data-inclusion-schema==0.17.0",
],
extras_require={
"test": [
Expand Down
5 changes: 5 additions & 0 deletions api/src/data_inclusion/api/inclusion_data/sources.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,10 @@
"slug": "soliguide",
"nom": "Soliguide",
"description": "Service numérique de recensement de l’offre d’insertion développé par l’association Solinum. Contient leurs structures et services sur des thématiques variées d’urgence sociale."
},
{
"slug": "fredo",
"nom": "Fredo",
"description": "Fredo est un outil diagnostique terrain pour les travailleurs sociaux. Il permet de mettre en relation les bénéficiaires diagnostiqués et les structures d'accompagnements grâce à une personne ressource"
}
]
9 changes: 6 additions & 3 deletions api/tests/e2e/api/__snapshots__/test_inclusion_data.ambr
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"openapi": "3.1.0",
"info": {
"title": "data·inclusion API",
"description": "### URL de base\n\nL'API est utilisable à partir de l'URL de base suivante:\n\n```\nhttp://127.0.0.1:8000\n```\n\nPar exemple, l'adresse complète (URL) correspondant à une recherche de services,\nsans paramètres additionnels, est:\n\n```\nhttp://127.0.0.1:8000/api/v0/search/services\n```\n\n\n\n### Token\n\nUn token est nécessaire pour accéder aux données.\n\nLes demandes de tokens s'effectuent via [ce formulaire](https://tally.so/r/mYjJ85). L'équipe data·inclusion prendra contact avec vous.\n\nLe token doit être renseigné dans chaque requête via un header:\n`Authorization: Bearer <VOTRE_TOKEN>`.\n\n### Schéma des données\n\nLes données utilisent le schéma data·inclusion. Ce schéma comprend deux modèles principaux :\n\n* les structures proposant des services\n* les services proposés par ces structures\n\nCes deux modèles utilisent des référentiels faisant également partie du schéma data·inclusion : les types de structures et de services, les thématiques, etc.\n\nPlus d'informations sur le\n[dépôt](https://github.com/gip-inclusion/data-inclusion-schema) versionnant le schéma,\nsur la [documentation officielle](https://www.data.inclusion.beta.gouv.fr/schemas-de-donnees-de-loffre/schema-des-structures-dinsertion)\nou sur la page [schema.gouv](https://schema.data.gouv.fr/gip-inclusion/data-inclusion-schema/) du schéma.\n\n### Sources des données\n\nLes données data·inclusion sont issues d'un ensemble de sources (emplois de l'inclusion, France Travail, etc.).\n\nLe endpoint `/sources` permet de lister les sources disponibles.\n\n\n### Filtrer géographiquement les données\n\nLes données renvoyées par certains endpoints peuvent être filtrées géographiquement.\n\nLes codes communes, départements et régions utilisés sont issus du [code officiel géographique produit par l'INSEE](https://www.insee.fr/fr/information/2560452).\n\nL'[api de la base adresse nationale](https://adresse.data.gouv.fr/api-doc/adresse) peut être utilisée afin d'automatiser l'identification de codes insee associés à partir d'adresses ou de parties d'adresses (e.g. nom de commune, code postal).\n\n\n### Nous contacter\n\n#### via notre [formulaire de contact](https://tally.so/r/w7N6Zz)\n\n#### par mail à [[email protected]](mailto:[email protected])",
"description": "### URL de base\n\nL'API est utilisable à partir de l'URL de base suivante:\n\n```\nhttps://api.data.inclusion.beta.gouv.fr\n```\n\nPar exemple, l'adresse complète (URL) correspondant à une recherche de services,\nsans paramètres additionnels, est:\n\n```\nhttps://api.data.inclusion.beta.gouv.fr/api/v0/search/services\n```\n\n\n\n### Token\n\nUn token est nécessaire pour accéder aux données.\n\nLes demandes de tokens s'effectuent via [ce formulaire](https://tally.so/r/mYjJ85). L'équipe data·inclusion prendra contact avec vous.\n\nLe token doit être renseigné dans chaque requête via un header:\n`Authorization: Bearer <VOTRE_TOKEN>`.\n\n### Schéma des données\n\nLes données utilisent le schéma data·inclusion. Ce schéma comprend deux modèles principaux :\n\n* les structures proposant des services\n* les services proposés par ces structures\n\nCes deux modèles utilisent des référentiels faisant également partie du schéma data·inclusion : les types de structures et de services, les thématiques, etc.\n\nPlus d'informations sur le\n[dépôt](https://github.com/gip-inclusion/data-inclusion-schema) versionnant le schéma,\nsur la [documentation officielle](https://www.data.inclusion.beta.gouv.fr/schemas-de-donnees-de-loffre/schema-des-structures-dinsertion)\nou sur la page [schema.gouv](https://schema.data.gouv.fr/gip-inclusion/data-inclusion-schema/) du schéma.\n\n### Sources des données\n\nLes données data·inclusion sont issues d'un ensemble de sources (emplois de l'inclusion, France Travail, etc.).\n\nLe endpoint `/sources` permet de lister les sources disponibles.\n\n\n### Filtrer géographiquement les données\n\nLes données renvoyées par certains endpoints peuvent être filtrées géographiquement.\n\nLes codes communes, départements et régions utilisés sont issus du [code officiel géographique produit par l'INSEE](https://www.insee.fr/fr/information/2560452).\n\nL'[api de la base adresse nationale](https://adresse.data.gouv.fr/api-doc/adresse) peut être utilisée afin d'automatiser l'identification de codes insee associés à partir d'adresses ou de parties d'adresses (e.g. nom de commune, code postal).\n\n\n### Nous contacter\n\n#### via notre [formulaire de contact](https://tally.so/r/w7N6Zz)\n\n#### par mail à [[email protected]](mailto:[email protected])",
"contact": {
"name": "data·inclusion",
"url": "https://www.data.inclusion.beta.gouv.fr/",
Expand All @@ -15,8 +15,8 @@
},
"servers": [
{
"url": "http://127.0.0.1:8000",
"description": "test"
"url": "https://api.data.inclusion.beta.gouv.fr",
"description": "dev"
}
],
"paths": {
Expand Down Expand Up @@ -3585,6 +3585,9 @@
"EPN",
"ES",
"ESS",
"ETABL_PRI",
"ETABL_PUB",
"ETAT",
"ETTI",
"EVS",
"FABLAB",
Expand Down

0 comments on commit 3db4ce5

Please sign in to comment.