diff --git a/event-location.json b/event-location.json index 39e7917..95adb19 100644 --- a/event-location.json +++ b/event-location.json @@ -1,5 +1,5 @@ { "$ref": "./place-reference.json", "title": "event.location", - "description": "A reference to a [place](https://docs.publiq.be/docs/uitdatabank/models/place) linked to the event. When writing an event it should only contain an `@id` property. When reading an event it will contain all the properties from the [place](https://docs.publiq.be/docs/uitdatabank/models/place). Always required when creating/updating an event, except when using [attendanceMode](./models/event-attendanceMode.json) `online`." + "description": "A reference to a [place](./models/place.json) linked to the event. When writing an event it should only contain an `@id` property. When reading an event it will contain all the properties from the [place](./models/place.json). Always required when creating/updating an event, except when using [attendanceMode](./models/event-attendanceMode.json) `online`." } diff --git a/event-organizer.json b/event-organizer.json index 97a5e55..41ee3fc 100644 --- a/event-organizer.json +++ b/event-organizer.json @@ -1,5 +1,5 @@ { "$ref": "./organizer-reference.json", "title": "event.organizer", - "description": "A reference to an [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) linked to the event. When writing an event it should only contain an `@id` property. When reading an event it will contain all the properties from the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer)." + "description": "A reference to an [organizer](./models/organizer.json) linked to the event. When writing an event it should only contain an `@id` property. When reading an event it will contain all the properties from the [organizer](./models/organizer.json)." } diff --git a/organizer-@id.json b/organizer-@id.json index ccd89fc..aa190df 100644 --- a/organizer-@id.json +++ b/organizer-@id.json @@ -2,7 +2,7 @@ "title": "organizer.@id", "type": "string", "format": "uri", - "description": "A unique URI that acts as globally unique ID for the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer). Based on [JSON-LD node identifiers](https://www.w3.org/TR/json-ld/#node-identifiers).", + "description": "A unique URI that acts as globally unique ID for the [organizer](./models/organizer.json). Based on [JSON-LD node identifiers](https://www.w3.org/TR/json-ld/#node-identifiers).", "examples": [ "https://io-test.uitdatabank.be/organizers/5cf42d51-3a4f-46f0-a8af-1cf672be8c84" ], diff --git a/organizer-address.json b/organizer-address.json index d52d02a..e0a2fb5 100644 --- a/organizer-address.json +++ b/organizer-address.json @@ -1,5 +1,5 @@ { "$ref": "./common-address.json", "title": "organizer.address", - "description": "The address the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) is located at. Localized because some parts like the municipality or street address can be different in Dutch, French, German and/or English.\n\nRequires at least one locale, specifically the one defined in the [mainLanguage](./models/organizer-mainLanguage.json) of the organizer.\n\n**Only add a localized version if it's an official variant!**" + "description": "The address the [organizer](./models/organizer.json) is located at. Localized because some parts like the municipality or street address can be different in Dutch, French, German and/or English.\n\nRequires at least one locale, specifically the one defined in the [mainLanguage](./models/organizer-mainLanguage.json) of the organizer.\n\n**Only add a localized version if it's an official variant!**" } diff --git a/organizer-completedLanguages.json b/organizer-completedLanguages.json index eac2614..7f6ac48 100644 --- a/organizer-completedLanguages.json +++ b/organizer-completedLanguages.json @@ -1,5 +1,5 @@ { "$ref": "./common-languages.json", "title": "organizer.completedLanguages", - "description": "List of languages that _every_ localizable property on the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) is available in.\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [languages](./organizer-languages.json)." + "description": "List of languages that _every_ localizable property on the [organizer](./models/organizer.json) is available in.\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [languages](./organizer-languages.json)." } diff --git a/organizer-contact.json b/organizer-contact.json index 28c9e60..e175a13 100644 --- a/organizer-contact.json +++ b/organizer-contact.json @@ -1,7 +1,7 @@ { "title": "organizer.contact", "type": "array", - "description": "Contact info of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) in a legacy format, containing one or more phone numbers, email addresses and/or website URLs.\n\nA type is used to categories the kind of contact information. The type can be either: url, email or phone.", + "description": "Contact info of the [organizer](./models/organizer.json) in a legacy format, containing one or more phone numbers, email addresses and/or website URLs.\n\nA type is used to categories the kind of contact information. The type can be either: url, email or phone.", "examples": [ [ { diff --git a/organizer-contactPoint.json b/organizer-contactPoint.json index 0b816be..3fbb5dd 100644 --- a/organizer-contactPoint.json +++ b/organizer-contactPoint.json @@ -1,5 +1,5 @@ { "$ref": "./common-contactPoint.json", "title": "organizer.contactPoint", - "description": "Contact info of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer), containing one or more phone numbers, email addresses, and/or website URLs." + "description": "Contact info of the [organizer](./models/organizer.json), containing one or more phone numbers, email addresses, and/or website URLs." } diff --git a/organizer-contributors.json b/organizer-contributors.json index a92b288..451ebcc 100644 --- a/organizer-contributors.json +++ b/organizer-contributors.json @@ -5,5 +5,5 @@ }, "title": "organizer.contributors", "readOnly": true, - "description": "List of contributors on an [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer). Only included if you request the organizer with an authenticated user who has the \"Aanbod bewerken\" permission on the organizer." + "description": "List of contributors on an [organizer](./models/organizer.json). Only included if you request the organizer with an authenticated user who has the \"Aanbod bewerken\" permission on the organizer." } diff --git a/organizer-created.json b/organizer-created.json index 7f225c0..2eb5b0f 100644 --- a/organizer-created.json +++ b/organizer-created.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime-readOnly.json", "title": "organizer.created", - "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) was created at.\n\nFor example `2021-05-17T22:00:00+00:00`." + "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [organizer](./models/organizer.json) was created at.\n\nFor example `2021-05-17T22:00:00+00:00`." } diff --git a/organizer-creator.json b/organizer-creator.json index 8283357..b935498 100644 --- a/organizer-creator.json +++ b/organizer-creator.json @@ -1,5 +1,5 @@ { "$ref": "./common-creator.json", "title": "organizer.creator", - "description": "The unique identifier of the creator of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer). Usually a UUID, but can historally be an e-mail address.\n\nAdded automatically by UiTdatabank based on the authentication credentials used to create the organizer." + "description": "The unique identifier of the creator of the [organizer](./models/organizer.json). Usually a UUID, but can historally be an e-mail address.\n\nAdded automatically by UiTdatabank based on the authentication credentials used to create the organizer." } diff --git a/organizer-description.json b/organizer-description.json index dd6b6b4..a9daba7 100644 --- a/organizer-description.json +++ b/organizer-description.json @@ -1,5 +1,5 @@ { "$ref": "./common-description.json", "title": "organizer.description", - "description": "A human-readable, internationalized description of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/organizer-mainLanguage.json) property." + "description": "A human-readable, internationalized description of the [organizer](./models/organizer.json).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/organizer-mainLanguage.json) property." } diff --git a/organizer-educationalDescription.json b/organizer-educationalDescription.json index 4dd146d..c220277 100644 --- a/organizer-educationalDescription.json +++ b/organizer-educationalDescription.json @@ -1,5 +1,5 @@ { "$ref": "./common-description.json", "title": "organizer.educationalDescription", - "description": "A human-readable, internationalized educational description of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) that can be used as a description targeted to schools and teachers.\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/organizer-mainLanguage.json) property." + "description": "A human-readable, internationalized educational description of the [organizer](./models/organizer.json) that can be used as a description targeted to schools and teachers.\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/organizer-mainLanguage.json) property." } diff --git a/organizer-image-post.json b/organizer-image-post.json index 6c73d89..d99656c 100644 --- a/organizer-image-post.json +++ b/organizer-image-post.json @@ -1,7 +1,7 @@ { "title": "organizer.image.post", "type": "object", - "description": "Describes the request body to add an image to an [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer).", + "description": "Describes the request body to add an image to an [organizer](./models/organizer.json).", "examples": [], "properties": { "id": { diff --git a/organizer-images-patch.json b/organizer-images-patch.json index 6b19021..66c3411 100644 --- a/organizer-images-patch.json +++ b/organizer-images-patch.json @@ -1,7 +1,7 @@ { "type": "array", "title": "organizer.images.patch", - "description": "Describes the request body to update one or more images on an [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer).", + "description": "Describes the request body to update one or more images on an [organizer](./models/organizer.json).", "minItems": 1, "items": { "type": "object", diff --git a/organizer-images.json b/organizer-images.json index 117933b..829d9fb 100644 --- a/organizer-images.json +++ b/organizer-images.json @@ -1,5 +1,5 @@ { "$ref": "./common-images.json", "title": "organizer.images", - "description": "Describes an array of images that are linked to an [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer). The main image of the organizer will always be set to the first image in this list when creating/updating an organizer with multiple images." + "description": "Describes an array of images that are linked to an [organizer](./models/organizer.json). The main image of the organizer will always be set to the first image in this list when creating/updating an organizer with multiple images." } diff --git a/organizer-labels.json b/organizer-labels.json index faac178..148610d 100644 --- a/organizer-labels.json +++ b/organizer-labels.json @@ -1,5 +1,5 @@ { "$ref": "./common-labels.json", "title": "organizer.labels", - "description": "One or more labels that categorize the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer). Labels do not have a defined set of possible values or a hierarchy.\n\nLabels are allowed to be visible for end users on publication channels.\n\nLabels must match the `^(?=.{2,255}$)(?=.*\\S.*\\S.*)[^;]*$` pattern.\n\nSee [hiddenLabels](./organizer-hiddenLabels.json) for labels that should not be visible on publication channels." + "description": "One or more labels that categorize the [organizer](./models/organizer.json). Labels do not have a defined set of possible values or a hierarchy.\n\nLabels are allowed to be visible for end users on publication channels.\n\nLabels must match the `^(?=.{2,255}$)(?=.*\\S.*\\S.*)[^;]*$` pattern.\n\nSee [hiddenLabels](./organizer-hiddenLabels.json) for labels that should not be visible on publication channels." } diff --git a/organizer-languages.json b/organizer-languages.json index 36dac16..b479a9f 100644 --- a/organizer-languages.json +++ b/organizer-languages.json @@ -1,5 +1,5 @@ { "$ref": "./common-languages.json", "title": "organizer.languages", - "description": "List of languages that the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) is available in. (Not all localizable properties may contain every language though)\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [completedLanguages](./organizer-completedLanguages.json)." + "description": "List of languages that the [organizer](./models/organizer.json) is available in. (Not all localizable properties may contain every language though)\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [completedLanguages](./organizer-completedLanguages.json)." } diff --git a/organizer-mainImage.json b/organizer-mainImage.json index 7d56884..fc07d06 100644 --- a/organizer-mainImage.json +++ b/organizer-mainImage.json @@ -1,5 +1,5 @@ { "$ref": "./common-mainImage.json", "title": "organizer.mainImage", - "description": "URL to the main image of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer). Will be automatically be set by UiTdatabank to the URL of the first image in `images`." + "description": "URL to the main image of the [organizer](./models/organizer.json). Will be automatically be set by UiTdatabank to the URL of the first image in `images`." } diff --git a/organizer-mainLanguage.json b/organizer-mainLanguage.json index 93569ff..f15dfdc 100644 --- a/organizer-mainLanguage.json +++ b/organizer-mainLanguage.json @@ -1,5 +1,5 @@ { "$ref": "./common-mainLanguage.json", "title": "organizer.mainLanguage", - "description": "The main language that the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) is described in. All localized properties like [name](./models/organizer-name.json) and [description](./models/organizer-description.json) will be required to have at least a value for this language.\n\nCan be one of `nl`, `fr`, `de`, or `en`." + "description": "The main language that the [organizer](./models/organizer.json) is described in. All localized properties like [name](./models/organizer-name.json) and [description](./models/organizer-description.json) will be required to have at least a value for this language.\n\nCan be one of `nl`, `fr`, `de`, or `en`." } diff --git a/organizer-modified.json b/organizer-modified.json index dfe6a77..1f8c773 100644 --- a/organizer-modified.json +++ b/organizer-modified.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime-readOnly.json", "title": "organizer.modified", - "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) was last modified.\n\nFor example `2021-05-17T22:00:00+00:00`." + "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [organizer](./models/organizer.json) was last modified.\n\nFor example `2021-05-17T22:00:00+00:00`." } diff --git a/organizer-name.json b/organizer-name.json index 29ab440..1c64a96 100644 --- a/organizer-name.json +++ b/organizer-name.json @@ -1,5 +1,5 @@ { "$ref": "./common-name.json", "title": "organizer.name", - "description": "The human-readable, localized name of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/organizer-mainLanguage.json) property." + "description": "The human-readable, localized name of the [organizer](./models/organizer.json).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/organizer-mainLanguage.json) property." } diff --git a/organizer-workflowStatus.json b/organizer-workflowStatus.json index 4824057..98ab615 100644 --- a/organizer-workflowStatus.json +++ b/organizer-workflowStatus.json @@ -1,7 +1,7 @@ { "type": "string", "title": "organizer.workflowStatus", - "description": "The status of the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) in the moderation workflow.\n\nCan be one of two values:\n\n- `ACTIVE`: The organizer is created and can be used.\n- `DELETED`: The organizer was deleted and should not be visible on any publication channels.", + "description": "The status of the [organizer](./models/organizer.json) in the moderation workflow.\n\nCan be one of two values:\n\n- `ACTIVE`: The organizer is created and can be used.\n- `DELETED`: The organizer was deleted and should not be visible on any publication channels.", "enum": [ "ACTIVE", "DELETED" diff --git a/place-@id.json b/place-@id.json index 246277e..415a51c 100644 --- a/place-@id.json +++ b/place-@id.json @@ -3,7 +3,7 @@ "type": "string", "format": "uri", "pattern": "^http[s]?:\\/\\/.+?\\/place[s]?\\/([0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-?[0-9A-Fa-f]{12})[\\/]?", - "description": "A unique URI that acts as globally unique ID for the [place](https://docs.publiq.be/docs/uitdatabank/models/place). Based on (JSON-LD node identifiers)[https://www.w3.org/TR/json-ld/#node-identifiers].", + "description": "A unique URI that acts as globally unique ID for the [place](./models/place.json). Based on (JSON-LD node identifiers)[https://www.w3.org/TR/json-ld/#node-identifiers].", "examples": [ "https://io-test.uitdatabank.be/place/85b04295-479c-40f5-b3dd-469dfb4387b3" ] diff --git a/place-address-put.json b/place-address-put.json index b653179..1f8620e 100644 --- a/place-address-put.json +++ b/place-address-put.json @@ -1,5 +1,5 @@ { "$ref": "./common-address-localized.json", "title": "place.address.put", - "description": "New address of the [place](https://docs.publiq.be/docs/uitdatabank/models/place), localized in a single language." + "description": "New address of the [place](./models/place.json), localized in a single language." } diff --git a/place-address.json b/place-address.json index a9b2c3a..c6e3b4f 100644 --- a/place-address.json +++ b/place-address.json @@ -1,5 +1,5 @@ { "$ref": "./common-address.json", "title": "place.address", - "description": "The address the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is located at. Localized because some parts like the municipality or street address can be different in Dutch, French, German and/or English.\n\nRequires at least one locale, specifically the one defined in the [mainLanguage](./models/place-mainLanguage.json) of the place.\n\n**Only add a localized version if it's an official variant!**" + "description": "The address the [place](./models/place.json) is located at. Localized because some parts like the municipality or street address can be different in Dutch, French, German and/or English.\n\nRequires at least one locale, specifically the one defined in the [mainLanguage](./models/place-mainLanguage.json) of the place.\n\n**Only add a localized version if it's an official variant!**" } diff --git a/place-availableFrom-put.json b/place-availableFrom-put.json index 54b1e30..1ac8f1f 100644 --- a/place-availableFrom-put.json +++ b/place-availableFrom-put.json @@ -4,7 +4,7 @@ "properties": { "availableFrom": { "$ref": "./common-string-datetime.json", - "description": "The first date & time that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is allowed to be visible on publication channels.\n\nFormatted as an ISO-8601 datetime. For example `2021-05-17T22:00:00+00:00`." + "description": "The first date & time that the [place](./models/place.json) is allowed to be visible on publication channels.\n\nFormatted as an ISO-8601 datetime. For example `2021-05-17T22:00:00+00:00`." } }, "required": [ diff --git a/place-availableFrom.json b/place-availableFrom.json index 2ac2e54..561b61e 100644 --- a/place-availableFrom.json +++ b/place-availableFrom.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime.json", "title": "place.availableFrom", - "description": "The first date & time that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is allowed to be visible on publication channels.\n\nFormatted as an ISO-8601 datetime. For example `2021-05-17T22:00:00+00:00`." + "description": "The first date & time that the [place](./models/place.json) is allowed to be visible on publication channels.\n\nFormatted as an ISO-8601 datetime. For example `2021-05-17T22:00:00+00:00`." } diff --git a/place-availableTo.json b/place-availableTo.json index ae37abc..9a5274b 100644 --- a/place-availableTo.json +++ b/place-availableTo.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime-readOnly.json", "title": "place.availableTo", - "description": "The last date & time that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is allowed to be visible on publication channels.\n\nAdded automatically by UiTdatabank based on either the [startDate](./place-startDate) or [endDate](./place-endDate.json) depending on the [event type](./place-terms.json).\n\nFormatted as an ISO-8601 datetime. For example `2021-05-17T22:00:00+00:00`." + "description": "The last date & time that the [place](./models/place.json) is allowed to be visible on publication channels.\n\nAdded automatically by UiTdatabank based on either the [startDate](./place-startDate) or [endDate](./place-endDate.json) depending on the [event type](./place-terms.json).\n\nFormatted as an ISO-8601 datetime. For example `2021-05-17T22:00:00+00:00`." } diff --git a/place-bookingInfo.json b/place-bookingInfo.json index 6b50c50..2b5cb59 100644 --- a/place-bookingInfo.json +++ b/place-bookingInfo.json @@ -1,5 +1,5 @@ { "$ref": "./common-bookingInfo.json", "title": "place.bookingInfo", - "description": "Booking info of the [place](https://docs.publiq.be/docs/uitdatabank/models/place), containing one or more phone numbers, email addresses, and/or website URLs." + "description": "Booking info of the [place](./models/place.json), containing one or more phone numbers, email addresses, and/or website URLs." } diff --git a/place-completedLanguages.json b/place-completedLanguages.json index de3fc77..72b7ad7 100644 --- a/place-completedLanguages.json +++ b/place-completedLanguages.json @@ -1,5 +1,5 @@ { "$ref": "./common-languages.json", "title": "place.completedLanguages", - "description": "List of languages that _every_ localizable property on the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is available in.\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [languages](./place-languages.json)." + "description": "List of languages that _every_ localizable property on the [place](./models/place.json) is available in.\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [languages](./place-languages.json)." } diff --git a/place-contactPoint.json b/place-contactPoint.json index 63b112c..4092d2d 100644 --- a/place-contactPoint.json +++ b/place-contactPoint.json @@ -1,5 +1,5 @@ { "$ref": "./common-contactPoint.json", "title": "place.contactPoint", - "description": "Contact info of the [place](https://docs.publiq.be/docs/uitdatabank/models/place), containing one or more phone numbers, email addresses, and/or website URLs." + "description": "Contact info of the [place](./models/place.json), containing one or more phone numbers, email addresses, and/or website URLs." } diff --git a/place-contributors.json b/place-contributors.json index 10f2ac1..c4d0919 100644 --- a/place-contributors.json +++ b/place-contributors.json @@ -5,5 +5,5 @@ }, "title": "place.contributors", "readOnly": true, - "description": "List of contributors on a [place](https://docs.publiq.be/docs/uitdatabank/models/place). Only included if you request the place with an authenticated user who has the \"Aanbod bewerken\" permission on the place." + "description": "List of contributors on a [place](./models/place.json). Only included if you request the place with an authenticated user who has the \"Aanbod bewerken\" permission on the place." } diff --git a/place-created.json b/place-created.json index 9d46941..748e0e7 100644 --- a/place-created.json +++ b/place-created.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime-readOnly.json", "title": "place.created", - "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [place](https://docs.publiq.be/docs/uitdatabank/models/place) was created at.\n\nFor example `2021-05-17T22:00:00+00:00`." + "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [place](./models/place.json) was created at.\n\nFor example `2021-05-17T22:00:00+00:00`." } diff --git a/place-creator.json b/place-creator.json index 663d234..a8471ac 100644 --- a/place-creator.json +++ b/place-creator.json @@ -1,5 +1,5 @@ { "$ref": "./common-creator.json", "title": "place.creator", - "description": "The unique identifier of the creator of the [place](https://docs.publiq.be/docs/uitdatabank/models/place). Usually a UUID, but can historally be an e-mail address.\n\nAdded automatically by UiTdatabank based on the authentication credentials used to create the place." + "description": "The unique identifier of the creator of the [place](./models/place.json). Usually a UUID, but can historally be an e-mail address.\n\nAdded automatically by UiTdatabank based on the authentication credentials used to create the place." } diff --git a/place-description-put.json b/place-description-put.json index 6c07448..9e5f06d 100644 --- a/place-description-put.json +++ b/place-description-put.json @@ -4,7 +4,7 @@ "properties": { "description": { "type": "string", - "description": "A human-readable description of the [place](https://docs.publiq.be/docs/uitdatabank/models/place) localized in the language from the URL parameter." + "description": "A human-readable description of the [place](./models/place.json) localized in the language from the URL parameter." } }, "required": [ diff --git a/place-description.json b/place-description.json index 73742d8..7f403f9 100644 --- a/place-description.json +++ b/place-description.json @@ -1,5 +1,5 @@ { "$ref": "./common-description.json", "title": "place.description", - "description": "A human-readable, internationalized description of the [place](https://docs.publiq.be/docs/uitdatabank/models/place).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/place-mainLanguage.json) property." + "description": "A human-readable, internationalized description of the [place](./models/place.json).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/place-mainLanguage.json) property." } diff --git a/place-endDate.json b/place-endDate.json index a1f8368..4c659bf 100644 --- a/place-endDate.json +++ b/place-endDate.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime.json", "title": "place.endDate", - "description": "The date & time that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) ends when using the `periodic` [calendarType](./models/place-calendarType.json), as an ISO-8601 date.\n\nFor example `2021-05-17T22:00:00+00:00`." + "description": "The date & time that the [place](./models/place.json) ends when using the `periodic` [calendarType](./models/place-calendarType.json), as an ISO-8601 date.\n\nFor example `2021-05-17T22:00:00+00:00`." } diff --git a/place-image-post.json b/place-image-post.json index d886613..67ce276 100644 --- a/place-image-post.json +++ b/place-image-post.json @@ -1,7 +1,7 @@ { "title": "place.image.post", "type": "object", - "description": "Describes the request body to add an image to an [place](https://docs.publiq.be/docs/uitdatabank/models/place).", + "description": "Describes the request body to add an image to an [place](./models/place.json).", "properties": { "mediaObjectId": { "$ref": "./common-string-uuid.json", diff --git a/place-image-put.json b/place-image-put.json index b10a6c3..f95cbd3 100644 --- a/place-image-put.json +++ b/place-image-put.json @@ -1,7 +1,7 @@ { "title": "place.image.put", "type": "object", - "description": "Describes the request body to update an image at a [place](https://docs.publiq.be/docs/uitdatabank/models/place).", + "description": "Describes the request body to update an image at a [place](./models/place.json).", "examples": [ { "description": "Picture of the last publiq event", diff --git a/place-image.json b/place-image.json index 6a85805..a7e7da2 100644 --- a/place-image.json +++ b/place-image.json @@ -1,5 +1,5 @@ { "$ref": "./common-mainImage.json", "title": "place.image", - "description": "URL to the main image of the [place](https://docs.publiq.be/docs/uitdatabank/models/place). Will be automatically be set by UiTdatabank to the URL of the first image in `mediaObject`." + "description": "URL to the main image of the [place](./models/place.json). Will be automatically be set by UiTdatabank to the URL of the first image in `mediaObject`." } diff --git a/place-labels.json b/place-labels.json index 032978e..1e84dff 100644 --- a/place-labels.json +++ b/place-labels.json @@ -1,5 +1,5 @@ { "$ref": "./common-labels.json", "title": "place.labels", - "description": "One or more labels that categorize the [place](https://docs.publiq.be/docs/uitdatabank/models/place). Compared to [terms](./place-terms.json), labels do not have a defined set of possible values or a hierarchy.\n\nLabels are allowed to be visible for end users on publication channels.\n\nSee [hiddenLabels](./place-hiddenLabels.json) for labels that should not be visible on publication channels." + "description": "One or more labels that categorize the [place](./models/place.json). Compared to [terms](./place-terms.json), labels do not have a defined set of possible values or a hierarchy.\n\nLabels are allowed to be visible for end users on publication channels.\n\nSee [hiddenLabels](./place-hiddenLabels.json) for labels that should not be visible on publication channels." } diff --git a/place-languages.json b/place-languages.json index 07febfd..2ee1578 100644 --- a/place-languages.json +++ b/place-languages.json @@ -1,5 +1,5 @@ { "$ref": "./common-languages.json", "title": "place.languages", - "description": "List of languages that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is available in. (Not all localizable properties may contain every language though)\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [completedLanguages](./place-completedLanguages.json)." + "description": "List of languages that the [place](./models/place.json) is available in. (Not all localizable properties may contain every language though)\n\nAdded automatically by UiTdatabank based on the languages present in localized properties.\n\nSee also [completedLanguages](./place-completedLanguages.json)." } diff --git a/place-main-image-put.json b/place-main-image-put.json index 37fff7b..ba7a811 100644 --- a/place-main-image-put.json +++ b/place-main-image-put.json @@ -1,7 +1,7 @@ { "title": "place.main.image.put", "type": "object", - "description": "Describes the request body to set an image as the main image of a [place](https://docs.publiq.be/docs/uitdatabank/models/place).", + "description": "Describes the request body to set an image as the main image of a [place](./models/place.json).", "examples": [ { "mediaObjectId": "4b349765-9499-4d35-b295-c82ede576cf0" diff --git a/place-mainLanguage.json b/place-mainLanguage.json index 7e861dd..e8bc087 100644 --- a/place-mainLanguage.json +++ b/place-mainLanguage.json @@ -1,5 +1,5 @@ { "$ref": "./common-mainLanguage.json", "title": "place.mainLanguage", - "description": "The main language that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is described in. All localized properties like [name](./models/place-name.json) and [description](./models/place-description.json) will be required to have at least a value for this language.\n\nCan be one of `nl`, `fr`, `de`, or `en`." + "description": "The main language that the [place](./models/place.json) is described in. All localized properties like [name](./models/place-name.json) and [description](./models/place-description.json) will be required to have at least a value for this language.\n\nCan be one of `nl`, `fr`, `de`, or `en`." } diff --git a/place-mediaObject.json b/place-mediaObject.json index b499fcd..3f0011f 100644 --- a/place-mediaObject.json +++ b/place-mediaObject.json @@ -1,5 +1,5 @@ { "$ref": "./common-images.json", "title": "place.mediaObject", - "description": "A list of media objects related to the [place](https://docs.publiq.be/docs/uitdatabank/models/place), in reality always images but called mediaObject for backward compatibility. The main image of the place will always be set to the first image in this list when creating/updating a place with multiple images." + "description": "A list of media objects related to the [place](./models/place.json), in reality always images but called mediaObject for backward compatibility. The main image of the place will always be set to the first image in this list when creating/updating a place with multiple images." } diff --git a/place-modified.json b/place-modified.json index 9ecb8ef..ae74352 100644 --- a/place-modified.json +++ b/place-modified.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime-readOnly.json", "title": "place.modified", - "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [place](https://docs.publiq.be/docs/uitdatabank/models/place) was last modified.\n\nFor example `2021-05-17T22:00:00+00:00`." + "description": "Date formatted as an ISO-8601 datetime, added automatically by UiTdatabank based on the date & time the [place](./models/place.json) was last modified.\n\nFor example `2021-05-17T22:00:00+00:00`." } diff --git a/place-name.json b/place-name.json index 0185f4b..66b36c8 100644 --- a/place-name.json +++ b/place-name.json @@ -1,5 +1,5 @@ { "$ref": "./common-name.json", "title": "place.name", - "description": "The human-readable, localized name of the [place](https://docs.publiq.be/docs/uitdatabank/models/place).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/place-mainLanguage.json) property." + "description": "The human-readable, localized name of the [place](./models/place.json).\n\nRequires at least one value, for the language specified in the [mainLanguage](./models/place-mainLanguage.json) property." } diff --git a/place-openingHours.json b/place-openingHours.json index f7bd4be..8b2dde0 100644 --- a/place-openingHours.json +++ b/place-openingHours.json @@ -1,5 +1,5 @@ { "$ref": "./common-openingHours.json", "title": "place.openingHours", - "description": "A list of multiple open/closed times and weekdays indicating when the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is open." + "description": "A list of multiple open/closed times and weekdays indicating when the [place](./models/place.json) is open." } diff --git a/place-organizer.json b/place-organizer.json index 9dc8ff6..858d6b5 100644 --- a/place-organizer.json +++ b/place-organizer.json @@ -1,5 +1,5 @@ { "$ref": "./organizer-reference.json", "title": "place.organizer", - "description": "A reference to an [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer) linked to the place. When writing a place it should only contain an `@id` property. When reading a place it will contain all the properties from the [organizer](https://docs.publiq.be/docs/uitdatabank/models/organizer)." + "description": "A reference to an [organizer](./models/organizer.json) linked to the place. When writing a place it should only contain an `@id` property. When reading a place it will contain all the properties from the [organizer](./models/organizer.json)." } diff --git a/place-priceInfo.json b/place-priceInfo.json index 299bd00..dc2fd1c 100644 --- a/place-priceInfo.json +++ b/place-priceInfo.json @@ -1,5 +1,5 @@ { "$ref": "./common-priceInfo.json", "title": "place.priceInfo", - "description": "A list of tariffs available for tickets/reservations to visit the [place](https://docs.publiq.be/docs/uitdatabank/models/place)." + "description": "A list of tariffs available for tickets/reservations to visit the [place](./models/place.json)." } diff --git a/place-sameAs.json b/place-sameAs.json index f4d00ea..60b2ac3 100644 --- a/place-sameAs.json +++ b/place-sameAs.json @@ -1,5 +1,5 @@ { "$ref": "./common-sameAs.json", "title": "place.sameAs", - "description": "One or more URIs that represent the same [place](https://docs.publiq.be/docs/uitdatabank/models/place) on another API or website, not necessarily in JSON-LD format.\n\nAdded automatically by UiTdatabank based on info from other systems.\n\nFor example `http://www.uitinvlaanderen.be/agenda/p/test-place/85b04295-479c-40f5-b3dd-469dfb4387b3`." + "description": "One or more URIs that represent the same [place](./models/place.json) on another API or website, not necessarily in JSON-LD format.\n\nAdded automatically by UiTdatabank based on info from other systems.\n\nFor example `http://www.uitinvlaanderen.be/agenda/p/test-place/85b04295-479c-40f5-b3dd-469dfb4387b3`." } diff --git a/place-startDate.json b/place-startDate.json index 35249ba..08fb633 100644 --- a/place-startDate.json +++ b/place-startDate.json @@ -1,5 +1,5 @@ { "$ref": "./common-string-datetime.json", "title": "place.startDate", - "description": "The date & time that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) starts when using the `periodic` [calendarType](./models/place-calendarType.json), as an ISO-8601 date.\n\nFor example `2021-05-17T22:00:00+00:00`." + "description": "The date & time that the [place](./models/place.json) starts when using the `periodic` [calendarType](./models/place-calendarType.json), as an ISO-8601 date.\n\nFor example `2021-05-17T22:00:00+00:00`." } diff --git a/place-status.json b/place-status.json index ed0f348..ad4511b 100644 --- a/place-status.json +++ b/place-status.json @@ -1,7 +1,7 @@ { "$ref": "./common-status.json", "title": "place.status", - "description": "Indicates if the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is still open for visitations or not.", + "description": "Indicates if the [place](./models/place.json) is still open for visitations or not.", "examples": [ { "type": "Available" diff --git a/place-terms.json b/place-terms.json index 194f645..5b97740 100644 --- a/place-terms.json +++ b/place-terms.json @@ -1,7 +1,7 @@ { "type": "array", "title": "place.terms", - "description": "A list of taxonomy terms used to categorize the [place](https://docs.publiq.be/docs/uitdatabank/models/place).\n\nTerms are pre-defined and can be found using our [guide about taxonomy terms](../docs/taxonomy-api/terms.md).\n\nA place requires at least one term, to define its type. (For example a museum, monument, ...)", + "description": "A list of taxonomy terms used to categorize the [place](./models/place.json).\n\nTerms are pre-defined and can be found using our [guide about taxonomy terms](../docs/taxonomy-api/terms.md).\n\nA place requires at least one term, to define its type. (For example a museum, monument, ...)", "uniqueItems": true, "minItems": 1, "contains": { diff --git a/place-typicalAgeRange-put.json b/place-typicalAgeRange-put.json index 8033d28..a3701ff 100644 --- a/place-typicalAgeRange-put.json +++ b/place-typicalAgeRange-put.json @@ -1,7 +1,7 @@ { "title": "place.typicalAgeRange.put", "type": "object", - "description": "Describes the request body to set the typical age range of a [place](https://docs.publiq.be/docs/uitdatabank/models/place).", + "description": "Describes the request body to set the typical age range of a [place](./models/place.json).", "examples": [ { "typicalAgeRange": "6-12" diff --git a/place-typicalAgeRange.json b/place-typicalAgeRange.json index 0cc0e58..104f525 100644 --- a/place-typicalAgeRange.json +++ b/place-typicalAgeRange.json @@ -1,5 +1,5 @@ { "$ref": "./common-typicalAgeRange.json", "type": "string", - "description": "Indicates the minimum and maximum age to visit the [place](https://docs.publiq.be/docs/uitdatabank/models/place). For example `6-12`, `0-12`, `-12`, or `6-`." + "description": "Indicates the minimum and maximum age to visit the [place](./models/place.json). For example `6-12`, `0-12`, `-12`, or `6-`." } diff --git a/place-workflowStatus-put.json b/place-workflowStatus-put.json index 3569d22..7647949 100644 --- a/place-workflowStatus-put.json +++ b/place-workflowStatus-put.json @@ -7,7 +7,7 @@ }, "availableFrom": { "$ref": "./place-availableFrom.json", - "description": "Can be set when changing the workflowStatus to `READY_FOR_VALIDATION`. The first date & time that the [place](https://docs.publiq.be/docs/uitdatabank/models/place) is allowed to be visible on publication channels. If omitted when changing the workflowStatus to `READY_FOR_VALIDATION`, the current datetime will be used. Must be formatted as an ISO-8601 datetime." + "description": "Can be set when changing the workflowStatus to `READY_FOR_VALIDATION`. The first date & time that the [place](./models/place.json) is allowed to be visible on publication channels. If omitted when changing the workflowStatus to `READY_FOR_VALIDATION`, the current datetime will be used. Must be formatted as an ISO-8601 datetime." }, "reason": { "type": "string",