Skip to content
This repository has been archived by the owner on Apr 13, 2022. It is now read-only.

III-4279 Document history endpoints #35

Merged
merged 5 commits into from Oct 18, 2021
Merged

III-4279 Document history endpoints #35

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d201f16
Document history endpoints
bertramakers Oct 14, 2021
746d07a
Merge branch 'master' into III-4279-history-endpoints
bertramakers Oct 15, 2021
ce911fa
Merge branch 'unreleased' into III-4279-history-endpoints
bertramakers Oct 18, 2021
29c4197
Remove x-examples
bertramakers Oct 18, 2021
323dc88
Remove other unnecessary constraints on the history logs array
bertramakers Oct 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
226 changes: 225 additions & 1 deletion reference/entry.json
View file
Open in desktop
Expand Up @@ -50,6 +50,118 @@
"description": "Returns the details of the event for the given `eventId`."
}
},
"/events/{eventId}/history": {
"parameters": [
{
"$ref": "#/components/parameters/eventId"
}
],
"get": {
"summary": "Get event history",
"tags": [
"Events"
],
"responses": {
"200": {
"description": "Event history.",
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A human-readable description of the update to the event. (Always in Dutch.)"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-08-26T16:54:38+00:00",
"description": "The date and time that the update happened in an ISO-8601 format with a timezone offset. For example `2021-08-26T16:54:38+00:00`."
},
"author": {
"type": "string",
"description": "Identifier of the user who made the change. Should not be treated as a semantic user id though, because it can be an email, v1 user id, or v2 user id. Should only be displayed and used by admins that look at the history log to look up the user in the correct system."
},
"api": {
"type": "string",
"description": "Human-readable name of the API that was used to make the change. Not always present in older history logs."
},
"auth0ClientId": {
"type": "string",
"description": "The id of the Auth0 client that made the change. (If it was an Auth0 API client.)"
},
"auth0ClientName": {
"type": "string",
"description": "Name of the client in Auth0 that made the change. (If it was an Auth0 API client.)"
},
"apiKey": {
"type": "string",
"description": "API key of the UiTID v1 consumer that made the change (if it was an UiTID v1 consumer)."
},
"consumerName": {
"type": "string",
"description": "Name of the UiTID v1 consumer that made the change (if it was an UiTID v1 consumer)."
}
},
"required": [
"description",
"date"
]
}
},
"examples": {
"Auth0 client": {
"value": [
{
"date": "2021-09-30T14:57:17+00:00",
"description": "Kalender-info aangepast",
"author": "google-oauth2|108326107941342286958",
"auth0ClientId": "JGJ3rAJLurRM9DHDE072zVhF3azl57mo",
"auth0ClientName": "UiTdatabase JWT Provider",
"api": "JSON-LD API"
}
]
},
"UiTID v1 consumer": {
"value": [
{
"date": "2021-10-04T09:40:59+00:00",
"description": "Reservatie-info aangepast",
"author": "google-oauth2|108326107941342286958",
"apiKey": "deb306a6-6f46-4c98-89ce-b03ec4fd11e2",
"api": "JSON-LD API",
"consumerName": "UiTdatabank Acceptatie"
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/EventNotFound"
}
},
"operationId": "get-event-history",
"description": "Returns the history log of the event for the given `eventId`.\n\nThe history log is an array of objects that contain info about each individual update to the event, who did the update, using what API, etc.\n\nBecause this history log can contain API keys which are secret (deprecated but still usable for backward compatibility), it can only be accessed by users that are a \"god user\".\n\nBecause of this limitation, the endpoint is also documented as internal and not visible in the public docs.",
"x-internal": true,
"security": [
{
"USER_ACCESS_TOKEN": []
},
{
"CLIENT_ACCESS_TOKEN": []
}
]
}
},
"/events/{eventId}/booking-availability": {
"parameters": [
{
Expand Down Expand Up @@ -1004,6 +1116,118 @@
"description": "Returns the details of the place for the given `placeId`."
}
},
"/places/{placeId}/history": {
"parameters": [
{
"$ref": "#/components/parameters/placeId"
}
],
"get": {
"summary": "Get place history",
"tags": [
"Places"
],
"responses": {
"200": {
"description": "Place history.",
"content": {
"application/json": {
"schema": {
"type": "array",
"description": "",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "A human-readable description of the update to the place. (Always in Dutch.)"
},
"date": {
"type": "string",
"format": "date-time",
"example": "2021-08-26T16:54:38+00:00",
"description": "The date and time that the update happened in an ISO-8601 format with a timezone offset. For example `2021-08-26T16:54:38+00:00`."
},
"author": {
"type": "string",
"description": "Identifier of the user who made the change. Should not be treated as a semantic user id though, because it can be an email, v1 user id, or v2 user id. Should only be displayed and used by admins that look at the history log to look up the user in the correct system."
},
"api": {
"type": "string",
"description": "Human-readable name of the API that was used to make the change. Not always present in older history logs."
},
"auth0ClientId": {
"type": "string",
"description": "The id of the Auth0 client that made the change. (If it was an Auth0 API client.)"
},
"auth0ClientName": {
"type": "string",
"description": "Name of the client in Auth0 that made the change. (If it was an Auth0 API client.)"
},
"apiKey": {
"type": "string",
"description": "API key of the UiTID v1 consumer that made the change (if it was an UiTID v1 consumer)."
},
"consumerName": {
"type": "string",
"description": "Name of the UiTID v1 consumer that made the change (if it was an UiTID v1 consumer)."
}
},
"required": [
"description",
"date"
]
}
},
"examples": {
"Auth0 client": {
"value": [
{
"date": "2021-09-30T14:57:17+00:00",
"description": "Kalender-info aangepast",
"author": "google-oauth2|108326107941342286958",
"auth0ClientId": "JGJ3rAJLurRM9DHDE072zVhF3azl57mo",
"auth0ClientName": "UiTdatabase JWT Provider",
"api": "JSON-LD API"
}
]
},
"UiTID v1 consumer": {
"value": [
{
"date": "2021-10-04T09:40:59+00:00",
"description": "Reservatie-info aangepast",
"author": "google-oauth2|108326107941342286958",
"apiKey": "deb306a6-6f46-4c98-89ce-b03ec4fd11e2",
"api": "JSON-LD API",
"consumerName": "UiTdatabank Acceptatie"
}
]
}
}
}
}
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/PlaceNotFound"
}
},
"operationId": "get-place-history",
"description": "Returns the history log of the place for the given `placeId`.\n\nThe history log is an array of objects that contain info about each individual update to the place, who did the update, using what API, etc.\n\nBecause this history log can contain API keys which are secret (deprecated but still usable for backward compatibility), it can only be accessed by users that are a \"god user\".\n\nBecause of this limitation, the endpoint is also documented as internal and not visible in the public docs.",
"x-internal": true,
"security": [
{
"USER_ACCESS_TOKEN": []
},
{
"CLIENT_ACCESS_TOKEN": []
}
]
}
},
"/places/{placeId}/calendar": {
"parameters": [
{
Expand Down Expand Up @@ -1774,4 +1998,4 @@
"name": "Places"
}
]
}
}