{"openapi":"3.1.0","info":{"title":"API Géoplateforme - Recherche","description":"Ce service permet d'effectuer des recherches sur les données présentes dans la Géoplateforme.","termsOfService":"https://cartes.gouv.fr/cgu","contact":{"name":"Geoplateforme","url":"https://cartes.gouv.fr","email":"geoplateforme@ign.fr"},"version":"1.0.0"},"servers":[{"url":"https://data.geopf.fr/recherche"}],"tags":[{"name":"Recherche","description":"Recherche dans les index <br /><br />Ce swagger s'applique pour la recherche standard. <br />Cependant, les requêtes sont applicables à un index custom en : <br />- modifiant geoplateforme par l'index custom dans l'url <br />- en utilisant une adresse en private"}],"paths":{"/api/indexes/{index}":{"post":{"tags":["Recherche"],"summary":"Recherche dans les index","description":"C’est la requête de recherche de base. Elle permet de rechercher dans les index dans la Géoplateforme.","operationId":"search","parameters":[{"name":"index","in":"path","description":"index recherché","required":true,"schema":{"type":"string","default":"geoplateforme"}},{"name":"page","in":"query","description":"Numéro de page, à partir de 1","schema":{"type":"integer","default":1}},{"name":"size","in":"query","description":"Nombre maximum de résultats par page","schema":{"type":"integer","default":10}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Filtre des documents"}}},"required":true},"responses":{"200":{"description":"Lecture OK","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Index non existant"},"409":{"description":"Champ(s) d'aggrégation incorrect(s)"}}}},"/api/indexes":{"get":{"tags":["Recherche"],"summary":"Récupèration de la liste des index","description":"Cette requête permet de lister les index disponibles et de récupérer leurs paramètres.","operationId":"getCapabilities","parameters":[{"name":"page","in":"query","description":"Numéro de page, à partir de 1","schema":{"type":"integer","default":1}},{"name":"size","in":"query","description":"Nombre maximum de résultats par page","schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Lecture OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CapabilitiesResponseDto"},"uniqueItems":true}}}}}}},"/api/indexes/{index}/suggest_autocomplete":{"get":{"tags":["Recherche"],"summary":"Autocompletion par champ","description":"Cette requête permet l’autocomplétion du titre dans la recherche.<br />Elle permet de corriger les mots d'une recherche pour correspondre aux mots des champs du document.<br />L'autocomplétion de titre est utilisable sur les champs suivant : title, description, theme et keywords.","operationId":"getSuggestAutocomplete","parameters":[{"name":"index","in":"path","description":"Identifiant de l'index","required":true,"schema":{"type":"string","default":"geoplateforme"}},{"name":"text","in":"query","description":"Critère de recherche du texte qu'on souhaite être autocomplété","schema":{"type":"string"}},{"name":"field","in":"query","description":"Critère de recherche du champ sur lequel on souhaite effectuer l'autocomplétion","schema":{"type":"string"}}],"responses":{"200":{"description":"Lecture OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuggestAutocompleteResponseDto"},"uniqueItems":true}}}}}}},"/api/indexes/{index}/suggest":{"get":{"tags":["Recherche"],"summary":"Suggestions par champ(s)","description":"Cette requête permet la suggestion pour un ou plusieurs champs.<br />La suggestion par champ permet une autocomplétion (sur les champs autorisés) du texte recherché suivant le champ demandé.<br />La suggestion commence à partir de l'écriture de 3 lettres.","operationId":"getSuggestions","parameters":[{"name":"index","in":"path","description":"Identifiant de l'index","required":true,"schema":{"type":"string","default":"geoplateforme"}},{"name":"size","in":"query","description":"Nombre d'éléments à récupérer","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"text","in":"query","description":"Critère de recherche du texte qu'on souhaite être autocomplété","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Critère de recherche du champ sur lequel on souhaite effectuer l'autocomplétion","schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Lecture OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuggestResponseDto"}}}}},"409":{"description":"Champ(s) de recherche incorrect(s)"}}}},"/api/indexes/{index}/documents/{documentId}":{"get":{"tags":["Recherche"],"summary":"Permet la consultation d’un document","description":"Cette requête permet de retrouver un document en fonction de son ID. <br />Elle est utile si l’ID du document est déjà connu ou alors si une application cliente l’a préalablement récupéré.","operationId":"get","parameters":[{"name":"index","in":"path","description":"Identifiant de l'index","required":true,"schema":{"type":"string","default":"geoplateforme"}},{"name":"documentId","in":"path","description":"Identifiant du document demandé par la requête","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Document OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DocumentDetailResponseDto"}}}},"404":{"description":"Document inconnu"}}}},"/api/indexes/{index}/documents/offerings/{offeringId}":{"get":{"tags":["Recherche"],"summary":"Recherche des documents par offre","description":"Cette requête permet la consultation d’un document en fonction de l’ID de son offre. <br />Cela permet de récupérer tous les IDs de documents issus d'une offre. Une recherche par l’ID du document peut ensuite être effectuée.","operationId":"getDocumentsByOfferingId","parameters":[{"name":"index","in":"path","description":"Identifiant de l'index","required":true,"schema":{"type":"string","default":"geoplateforme"}},{"name":"offeringId","in":"path","description":"Identifiant de l'offre","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Lecture OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentResumeDto"}}}}},"404":{"description":"Offering Id non existant"}}}}},"components":{"schemas":{"CapabilitiesResponseDto":{"description":"Informations de l'index","properties":{"title":{"type":"string","description":"Titre de l'index"},"index":{"type":"string","description":"Le nom de l'index"},"keywords":{"type":"array","description":"Les keywords de l'index","items":{"type":"string","description":"Les keywords de l'index"},"uniqueItems":true},"url":{"type":"string","description":"URL d'accès à l'index"},"configuration_json":{"type":"object"},"abstract":{"type":"string","description":"Description de l'index"}},"required":["abstract","index","title","url"]},"SuggestAutocompleteOptionDto":{"description":"Suggest phrase response","properties":{"text":{"type":"string"},"score":{"type":"number","format":"double"},"freq":{"type":"integer","format":"int64"}}},"SuggestAutocompleteResponseDto":{"description":"Suggest phrase response","properties":{"text":{"type":"string"},"offset":{"type":"integer","format":"int32"},"length":{"type":"integer","format":"int32"},"options":{"type":"array","items":{"$ref":"#/components/schemas/SuggestAutocompleteOptionDto"},"uniqueItems":true},"suggestions":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"AttributionDto":{"description":"Informations du gestionnaire","properties":{"title":{"type":"string","description":"Nom du gestionnaire"},"url":{"type":"string","description":"URL du gestionnaire"},"email":{"type":"string","description":"E-mail du gestionnaire"},"logo":{"$ref":"#/components/schemas/AttributionLogoDto"}}},"AttributionLogoDto":{"description":"Logo du propriétaire","properties":{"format":{"type":"string","description":"Le format (mime-type) du logo"},"url":{"type":"string","description":"URL d'accès au logo"},"width":{"type":"integer","format":"int64","description":"Largeur du logo"},"height":{"type":"integer","format":"int64","description":"Hauteur du logo"}}},"DocumentDetailResponseDto":{"description":"Informations du document","properties":{"id":{"type":"string","format":"uuid","description":"Identifiant du document"},"offering_id":{"type":"string","format":"uuid","description":"Identifiant de l'offre"},"index_name":{"type":"string","description":"Nom de l'index"},"layer_name":{"type":"string","description":"Nom technique de la ressource"},"title":{"type":"string","description":"Titre"},"description":{"type":"string","description":"Description"},"type":{"type":"string","description":"Type d'offre"},"url":{"type":"string","description":"URL d'accès à l'offre"},"open":{"type":"boolean","description":"Visibilité de l'offre"},"attribution":{"$ref":"#/components/schemas/AttributionDto"},"thumbnail":{"type":"string","description":"Image"},"theme":{"type":"string","description":"Thématique"},"production_years":{"type":"array","description":"Année de production","items":{"type":"integer","format":"int32","description":"Année de production"},"uniqueItems":true},"producers":{"type":"array","description":"Liste des producteurs","items":{"type":"string","description":"Liste des producteurs"},"uniqueItems":true},"publication_date":{"type":"string","description":"Date de publication"},"keywords":{"type":"array","description":"Mots clefs associés","items":{"type":"string","description":"Mots clefs associés"},"uniqueItems":true},"licence":{"type":"string","description":"Licence"},"extent":{"type":"object","description":"Zone géographique"},"metadata_urls":{"type":"array","description":"Métadonnées","items":{"type":"string","description":"Métadonnées"},"uniqueItems":true},"srs":{"type":"array","description":"Projections","items":{"type":"string","description":"Projections"},"uniqueItems":true},"highlights":{"type":"object","additionalProperties":{"type":"array","description":"Highlights","items":{"type":"string","description":"Highlights"}},"description":"Highlights"},"extra":{"type":"object"}},"required":["description","id","index_name","layer_name","open","publication_date","title","type","url"]},"SuggestResponseDto":{"description":"Informations de suggestion search","properties":{"index":{"type":"string"},"score":{"type":"number","format":"double"},"source":{"$ref":"#/components/schemas/DocumentDetailResponseDto"}}},"DocumentResumeDto":{"description":"Informations de document","properties":{"id":{"type":"string","format":"uuid","description":"Identifiant de l'offre"}},"required":["id"]}}}}