diff --git a/specification/fairSyncApi.yml b/specification/fairSyncApi.yml index 973ffa207d233e2228f7cb0b4b2461d7c884250d..6ecbfbbc9ce51e90af5e0c96586b6e4a58676888 100644 --- a/specification/fairSyncApi.yml +++ b/specification/fairSyncApi.yml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: - title: FairSync API PointOfInterest - description: FairSync API for synchronizing PointOfInterest between maps and platforms. See also https://nlnet.nl/project/FairSync + title: FairSync API Places + description: FairSync API for synchronizing Places between maps and platforms. See also https://nlnet.nl/project/FairSync version: 0.0.1 contact: name: FairSync API @@ -9,11 +9,8 @@ info: license: name: CC0 1.0 url: 'https://creativecommons.org/publicdomain/zero/1.0/deed.de' -security: - - basicAuth: [] - - bearerAuth: [] paths: - /poi: + /place: get: summary: Search for POIs tags: @@ -31,14 +28,6 @@ paths: $ref: '#/components/schemas/Place' components: - securitySchemes: - basicAuth: - type: http - scheme: basic - bearerAuth: - type: http - scheme: bearer - bearerFormat: JWT schemas: DateTime: type: string @@ -81,7 +70,7 @@ components: houseNr: type: string streetAndHouseNr: - description: we prefere to seperate street and houseNumber, but there may be plattforms that are not able to do that. For that case use this field. + description: we prefere to seperate street and houseNumber, but there may be platforms that are not able to do that. For that case use this field. type: string zip: type: string @@ -131,15 +120,15 @@ components: format: url Owner: type: object - description: The owner of a POI. This is not a plattform, its more a person or a organisation, that is responsible for a concrete entry. + description: The owner of a POI. This is not a platform, its more a person or a organisation, that is responsible for a concrete entry. required: - contacturl properties: contact: $ref: '#/components/schemas/Contact' - Plattform: + Platform: type: object - description: The plattform that owns a POI. + description: The platform that owns a POI. required: - url properties: @@ -148,7 +137,7 @@ components: format: url VerifiedTag: type: object - description: Tags that are verified by the maintainer (a.k.a. plattform). Some platforms have service employees who validate entries and check whether tags have been allocated correctly. + description: Tags that are verified by the maintainer (a.k.a. platform). Some platforms have service employees who validate entries and check whether tags have been allocated correctly. required: - url properties: @@ -160,7 +149,7 @@ components: verifiedBy: $ref: '#/components/schemas/Contact' - PointOfInterest: + Place: required: - address - contact @@ -183,20 +172,19 @@ components: $ref: '#/components/schemas/DateTime' deleted: type: boolean - description: If true, this POI was deleted on the plattform you requested POIs + description: If true, this POI was deleted on the platform you requested POIs license: type: string source: type: object description: Origin of the dataset required: - - providerId - - entryId + - platform properties: owner: $ref: '#/components/schemas/Owner' - plattform: - $ref: '#/components/schemas/Plattform' + platform: + $ref: '#/components/schemas/Platform' title: type: string description: