swagger-ui-svelte
Version:
Light version of swagger UI using Svelte framework
2 lines (1 loc) • 17.5 kB
JSON
{"info":{"title":"API personnes décédées","version":"v0-268-g1cecacd","description":"API pour faciliter le rapprochement des personnes decedees","license":{"name":"lgpl-3.0","url":"https://choosealicense.com/licenses/lgpl-3.0/"},"contact":{"name":"MatchID","url":"https://deces.matchid.io","email":"matchid-project@gmail.com"}},"servers":[{"url":"https://deces.matchid.io/deces/api/v1"}],"openapi":"3.0.0","paths":{"/search/csv":{"post":{"summary":"Rapprochement par lot","description":"Launch bulk matching using csv","tags":["Bulk"],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"sep":{"type":"string","description":"Caractère séparateur","example":","},"firstName":{"type":"string","description":"Prénom","example":"Prenom"},"lastName":{"type":"string","description":"Nom de famille","example":"Nom"},"birthDate":{"type":"string","description":"Date de naissance au format JJ/MM/AAAA<br> <li> Pour une date inconnue les valeurs sont 0000 pour AAAA; 00 pour MM et JJ</li><br>","example":"dateColumn"},"chunkSize":{"type":"number","description":"Taille du lot pour le traitement","example":20},"dateFormat":{"type":"string","description":"Format to parse birthdate","example":"YYYY-MM-DD"},"fileName":{"type":"string","description":"Fichier CSV contenant le noms des identités à comparer","format":"binary"}}}}}},"responses":{"200":{"description":"Success de request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/HealthcheckResponse"},{"example":{"id":"abc","msg":"started"}}]}}}}}}},"/search/csv/:jobId?":{"get":{"description":"Obtenir le statut et le résultat du job","summary":"Obtenir le statut et le résultat du traitement","tags":["Bulk"],"parameters":[{"in":"path","name":"jobId","schema":{"type":"string","example":"abc"},"required":true,"description":"ID of the job"}],"responses":{"200":{"description":"Success de request","content":{"text/csv":{"schema":{"type":"string","description":"CSV results","example":"Prenom,Nom,Date,score,source,id,name,firstName,lastName,sex,birthDate,birthCity,cityCode,departmentCode,country,countryCode,latitude,longitude,deathDate,certificateId,age,deathCity,cityCode,departmentCode,country,countryCode,latitude,longitude \\r\\n \"DENISE\",\"GERMAN\",\"03/02/1952\",\"142.26564\",\"s3://fichier-des-personnes-decedees/deaths\",\"83ad9a6737289a3abd6f35e3a16996c8a3b21fd2\",\"Denise Josephine\",\"German\",\"F\",\"19520203\",\"Septfontaines\",\"25541\",\"25\",\"France\",\"FRA\",\"46.9739924\",\"6.1738194\",\"19760729\",\"1782\",\"24\",\"Septfontaines\",\"25541\",\"25\",\"France\",\"FRA\",\"46.9739924\",\"6.1738194\"\\r\\n \"JEAN PIERRE YANNICK\",\"GOUETI\",\"15/01/1953\" \\r\\n \"JOSE\",\"PONSARD\",\"30/12/1952\",\"163.79218\",\"s3://fichier-des-personnes-decedees/deaths\",\"99f809265af83e7ea0d98adff4dace0f5c763d0b\",\"Jose\",\"Ponsard\",\"M\",\"19521230\",\"Saulx\",\"70478\",\"70\",\"France\",\"FRA\",\"47.6962074\",\"6.2758008\",\"20050615\",\"7761\",\"52\",\"Saulx\",\"70478\",\"70\",\"France\",\"FRA\",\"47.6962074\",\"6.2758008\" \\r\\n"}}}}}}},"/search/json/:jobId?":{"get":{"description":"Obtenir le statut et le résultat du job","summary":"Obtenir le statut et le résultat du traitement","tags":["Bulk"],"parameters":[{"in":"path","name":"jobId","schema":{"type":"string","example":"abc"},"required":true,"description":"ID of the job"}],"responses":{"200":{"description":"Success de request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Result"}]}}}}}}},"/search":{"get":{"operationId":"Search","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"Ok"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"}},"description":"Launch single request","summary":"Rapprocher une seule identité","tags":["Simple"],"security":[],"parameters":[{"in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"Prénom","in":"query","name":"firstName","required":false,"schema":{"type":"string"}},{"description":"Nom de famille","in":"query","name":"lastName","required":false,"schema":{"type":"string"}},{"description":"Sexe","in":"query","name":"sex","required":false,"schema":{"type":"string","enum":["M","F","H"]}},{"description":"Date de naissance au format\\: JJ/MM/AAAA<br> <li> Pour une date inconnue les valeurs sont 0000 pour AAAA; 00 pour MM et JJ</li><br> <li> Une recherche par tranche de date est également possible sous la forme: JJ/MM/AAAA - JJ/MM/AAAA</li>","in":"query","name":"birthDate","required":false,"schema":{"type":"string"}},{"description":"Localité\\: de naissance en claire (pour les personnes nées en France ou dans les DOM/TOM/COM)","in":"query","name":"birthCity","required":false,"schema":{"type":"string"}},{"description":"Code département du lieu de naissance","in":"query","name":"birthDepartment","required":false,"schema":{"type":"string"}},{"description":"Libellé de pays de naissance en clair (pour les personnes nées à l'étranger)","in":"query","name":"birthCountry","required":false,"schema":{"type":"string"}},{"description":"Date de décès au format\\: JJ/MM/AAAA. <br> <li> Pour une date inconnue les valeurs sont 0000 pour AAAA; 00 pour MM et JJ</li>.<br> <li> Une recherche par tranche de date est également possible sous la forme: JJ/MM/AAAA - JJ/MM/AAAA</li>","in":"query","name":"deathDate","required":false,"schema":{"type":"string"}},{"description":"Localité de décès en claire** (pour les personnes nées en France ou dans les DOM/TOM/COM)","in":"query","name":"deathCity","required":false,"schema":{"type":"string"}},{"description":"Code département du lieu de décès","in":"query","name":"deathDepartment","required":false,"schema":{"type":"string"}},{"description":"Pays du lieu de décès","in":"query","name":"deathCountry","required":false,"schema":{"type":"string"}},{"description":"Age du décès","in":"query","name":"deathAge","required":false,"schema":{"type":"string"}},{"description":"Le temps durant lequel le contexte de la requête doit être garde","in":"query","name":"scroll","required":false,"schema":{"type":"string"}},{"description":"Identifiant technique du contexte","in":"query","name":"scrollId","required":false,"schema":{"type":"string"}},{"description":"Nombre d\\'identités retourne par page","in":"query","name":"size","required":false,"schema":{"format":"double","type":"number"}},{"description":"Numéro de page","in":"query","name":"page","required":false,"schema":{"format":"double","type":"number"}},{"description":"Recherche floue ou exacte","in":"query","name":"fuzzy","required":false,"schema":{"type":"string","enum":["true","false"]}},{"description":"Tri sur les colonnes (à préciser sur la structure du champs)","in":"query","name":"sort","required":false,"schema":{"type":"string"}}]},"post":{"operationId":"Searchpost","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"Ok"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"}},"description":"Launch single request","summary":"Rapprocher une seule identité","tags":["Simple"],"security":[],"parameters":[{"description":"Format of the response text/csv for csv otherwise application/json","in":"header","name":"Accept","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestBody"}}}}}},"/healthcheck":{"get":{"operationId":"Msg","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthcheckResponse"}}},"description":"Ok"}},"tags":["Check"],"security":[],"parameters":[]}},"/version":{"get":{"operationId":"Version","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Ok"}},"tags":["Check"],"security":[],"parameters":[]}}},"components":{"examples":{},"headers":{},"parameters":{},"requestBodies":{},"responses":{},"schemas":{"RequestType":{"properties":{"q":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"birthDate":{"type":"string","nullable":true},"birthCity":{"type":"string","nullable":true},"birthDepartment":{"type":"string","nullable":true},"birthCountry":{"type":"string","nullable":true},"deathDate":{"type":"string","nullable":true},"deathCity":{"type":"string","nullable":true},"deathDepartment":{"type":"string","nullable":true},"deathCountry":{"type":"string","nullable":true},"size":{"type":"number","format":"double","nullable":true},"page":{"type":"number","format":"double","nullable":true},"fuzzy":{"type":"string","nullable":true},"sort":{"type":"string","nullable":true}},"type":"object","additionalProperties":{"additionalProperties":true,"type":"object"}},"Name":{"properties":{"first":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"$ref":"#/components/schemas/RequestField"}]},"last":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"$ref":"#/components/schemas/RequestField"}]}},"required":["first","last"],"type":"object","additionalProperties":false},"GeoPoint":{"properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"},"distance":{"type":"string"}},"required":["latitude","longitude","distance"],"type":"object","additionalProperties":false},"Sort":{"properties":{},"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}},"NameFields":{"properties":{"first":{"properties":{"first":{"type":"string"},"all":{"type":"string"}},"type":"object","nullable":true},"last":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]}},"required":["last"],"type":"object","additionalProperties":false},"RequestField":{"properties":{"value":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/Name"},{"type":"number","format":"double"},{"$ref":"#/components/schemas/GeoPoint"},{"items":{"$ref":"#/components/schemas/Sort"},"type":"array"}]},"field":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"$ref":"#/components/schemas/NameFields"}],"nullable":true},"query":{"additionalProperties":true,"type":"object","nullable":true},"fuzzy":{"oneOf":[{"type":"string"},{"type":"boolean"}],"nullable":true},"mask":{"properties":{"validation":{"additionalProperties":true,"type":"object"},"transform":{"additionalProperties":true,"type":"object"}},"type":"object","nullable":true}},"required":["value"],"type":"object","additionalProperties":false},"Location":{"properties":{"city":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/RequestField"}],"nullable":true},"cityCode":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/RequestField"}],"nullable":true},"departmentCode":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/RequestField"}],"nullable":true},"country":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/RequestField"}],"nullable":true},"countryCode":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/RequestField"}],"nullable":true},"latitude":{"type":"number","format":"double","nullable":true},"longitude":{"type":"number","format":"double","nullable":true}},"type":"object","additionalProperties":false},"Person":{"properties":{"score":{"type":"number","format":"double"},"source":{"type":"string"},"id":{"type":"string"},"name":{"$ref":"#/components/schemas/Name"},"sex":{"type":"string","enum":["M","F"]},"birth":{"properties":{"date":{"type":"string"},"location":{"$ref":"#/components/schemas/Location"}},"required":["location","date"],"type":"object"},"death":{"properties":{"date":{"type":"string"},"certificateId":{"type":"string"},"age":{"type":"number","format":"double"},"location":{"$ref":"#/components/schemas/Location"}},"required":["location","age","certificateId","date"],"type":"object"}},"required":["score","source","id","name","sex","birth","death"],"type":"object","additionalProperties":false},"ResType":{"properties":{"scrollId":{"type":"string","nullable":true},"total":{"type":"number","format":"double","description":"nombre d'identité trouvé"},"maxScore":{"type":"number","format":"double","description":"score maximum obtenu lors de la recherche"},"size":{"type":"number","format":"double","description":"nombre d'identité présent dans la réponse"},"page":{"type":"number","format":"double","description":"numéro de page"},"delay":{"type":"number","format":"double","description":"délai du traitement"},"persons":{"items":{"$ref":"#/components/schemas/Person"},"type":"array"}},"required":["total","maxScore","size","page","delay","persons"],"type":"object","additionalProperties":false},"Result":{"description":"This is a description of a model","properties":{"msg":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"nullable":true},"request":{"$ref":"#/components/schemas/RequestType","nullable":true},"response":{"$ref":"#/components/schemas/ResType","nullable":true}},"type":"object","additionalProperties":false,"example":{"request":{"q":"Georges Pompidou"},"response":{"scrollId":"123XXX","total":2,"maxScore":10.54,"size":20,"page":1,"delay":2,"persons":[{"score":10.542101,"source":"2020-m01","id":"ba7582a6344757e67351bf42096c952a12108e06","name":{"first":["Jean","Pierre"],"last":"Dupont"},"sex":"M","birth":{"date":"19691111","location":{"city":"Clermont-Ferrand","cityCode":"63113","departmentCode":"63","country":"France","countryCode":"FRA","latitude":45.7833,"longitude":3.0833}},"death":{"date":"20200604","certificateId":"69 N","age":50,"location":{"city":"Clermont-Ferrand","cityCode":"63113","departmentCode":"63","country":"France","countryCode":"FRA","latitude":45.7833,"longitude":3.0833}}}]}}},"ErrorResponse":{"description":"Ce message décrit les erreurs rencontrées","properties":{"msg":{"oneOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]}},"required":["msg"],"type":"object","additionalProperties":false,"example":{"msg":"Error"}},"RequestBody":{"description":"These are all the query parameters","properties":{"scroll":{"type":"string","description":"Le temps durant lequel le contexte de la requête doit être garde","nullable":true},"scrollId":{"type":"string","description":"Identifiant technique du contexte","nullable":true},"size":{"type":"number","format":"double","description":"Nombre d\\'identités retourne par page","nullable":true},"page":{"type":"number","format":"double","description":"Numéro de page","nullable":true},"sort":{"oneOf":[{"type":"string"},{"items":{"$ref":"#/components/schemas/Sort"},"type":"array"}],"description":"Tri sur les colonnes (à préciser sur la structure du champs)","nullable":true},"fullText":{"type":"string","description":"Simple query","nullable":true},"firstName":{"type":"string","description":"Prénom","nullable":true},"lastName":{"type":"string","description":"Nom de famille","nullable":true},"sex":{"type":"string","enum":["M","F","H"],"description":"Sexe","nullable":true},"birthDate":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Date de naissance au format\\: JJ/MM/AAAA<br> <li> Pour une date inconnue les valeurs sont 0000 pour AAAA; 00 pour MM et JJ</li><br> <li> Une recherche par tranche de date est également possible sous la forme: JJ/MM/AAAA - JJ/MM/AAAA</li>","nullable":true},"birthCity":{"type":"string","description":"Localité\\: de naissance en claire (pour les personnes nées en France ou dans les DOM/TOM/COM)","nullable":true},"birthDepartment":{"type":"string","description":"Code département du lieu de naissance","nullable":true},"birthCountry":{"type":"string","description":"Libellé de pays de naissance en clair (pour les personnes nées à l'étranger)","nullable":true},"birthGeoPoint":{"$ref":"#/components/schemas/GeoPoint","description":"Coordonnés GPS du lieu de naissance","nullable":true},"deathDate":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Date de décès au format\\: JJ/MM/AAAA. <br> <li> Pour une date inconnue les valeurs sont 0000 pour AAAA; 00 pour MM et JJ</li>.<br> <li> Une recherche par tranche de date est également possible sous la forme: JJ/MM/AAAA - JJ/MM/AAAA</li>","nullable":true},"deathCity":{"type":"string","description":"Localité de décès en claire** (pour les personnes nées en France ou dans les DOM/TOM/COM)","nullable":true},"deathDepartment":{"type":"string","description":"Code département du lieu de décès","nullable":true},"deathCountry":{"type":"string","description":"Pays du lieu de décès","nullable":true},"deathGeoPoint":{"$ref":"#/components/schemas/GeoPoint","description":"Coordonnés GPS du lieu de décès","nullable":true},"deathAge":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Age du décès","nullable":true}},"type":"object","additionalProperties":{"additionalProperties":true,"type":"object"},"example":{"firstName":"Georges","lastName":"Pompidou","sex":"M","deathCity":"Paris"}},"HealthcheckResponse":{"description":"The message shows OK when the backend is running successfully","properties":{"msg":{"type":"string"}},"required":["msg"],"type":"object","additionalProperties":false,"example":{"msg":"Ok"}}},"securitySchemes":{}},"tags":[{"name":"Bulk","description":"Rapprochement par lot"}]}