From 0397823b65202a4219c2c78c89909d59a4cedfaa Mon Sep 17 00:00:00 2001 From: kathryn-ods Date: Fri, 1 Nov 2024 11:12:01 +0000 Subject: [PATCH 1/3] adding empty as a required field for components/schema/Page --- schema/compiled/service_with_definitions.json | 146 +++++++++--------- schema/openapi.json | 3 +- 2 files changed, 75 insertions(+), 74 deletions(-) diff --git a/schema/compiled/service_with_definitions.json b/schema/compiled/service_with_definitions.json index 35a9b7e..e2e3e5a 100644 --- a/schema/compiled/service_with_definitions.json +++ b/schema/compiled/service_with_definitions.json @@ -3179,10 +3179,10 @@ "service_id" ] }, - "url": { - "name": "url", - "path": "url.csv", - "description": "A URL with a label", + "unit": { + "name": "unit", + "path": "units.csv", + "description": "The details of units which are used to measure service capacity.", "datapackage_metadata": { "format": "csv", "mediatype": "text/csv", @@ -3194,54 +3194,39 @@ "id": { "name": "id", "type": "string", - "title": "Identifier", - "description": "The identifier for the URL object. Each URL must have a unique identifier.", "format": "uuid", - "constraints": { - "unique": true - }, - "example": "30951f94-7b24-11ef-ba1b-a79405d4dcaa" + "title": "Identifier", + "description": "The identifier for the unit object. Each unit must have a unique identifier.", + "example": "8896b788-7b3e-11ef-8db9-7f3d040352b3" }, - "label": { - "name": "label", + "name": { + "name": "name", "type": "string", - "title": "Label", - "description": "The human-readable label for this url e.g. \u201cTwitter\u201d or \u201cWebsite\u201d.", - "constraints": { - "unique": false - }, - "example": "Website" + "title": "Name", + "description": "The human-readable name for this unit e.g. \u201cBed\u201d or \u201cHours\u201d", + "example": "Kilogram" }, - "url": { - "name": "url", + "scheme": { + "name": "scheme", "type": "string", - "format": "uri", - "title": "URL", - "description": "The URL for this URL object. This must be formatted as a valid URI.", - "constraints": { - "unique": false - }, - "example": "https://example.org" + "title": "Scheme", + "description": "The scheme which formalizes the unit, if applicable e.g. \u201cSI\u201d for Standard International Units such as Kilogram, Litre, etc.", + "example": "SI" }, - "organization_id": { - "name": "organization_id", + "identifier": { + "name": "identifier", "type": "string", - "format": "uuid", - "title": "Organization Identifier", - "description": "The identifier for the organization associated with this URL object", - "constraints": { - "unique": false - } + "title": "Unit Identifier", + "description": "The identifier of the unit taken from the scheme if applicable e.g. `kgm` for Kilogram.", + "example": "kgm" }, - "service_id": { - "name": "service_id", + "uri": { + "name": "uri", "type": "string", - "format": "uuid", - "title": "Service Identifier", - "description": "The identifier for the service associated with this URL object", - "constraints": { - "unique": false - } + "format": "uri", + "title": "URI", + "description": "The URI to the definition of the unit, if applicable", + "example": "https://not-a-real-url.org/standard-international-units/kgm" }, "attributes": { "name": "attributes", @@ -3264,13 +3249,13 @@ }, "required": [ "id", - "url" + "name" ] }, - "unit": { - "name": "unit", - "path": "units.csv", - "description": "The details of units which are used to measure service capacity.", + "url": { + "name": "url", + "path": "url.csv", + "description": "A URL with a label", "datapackage_metadata": { "format": "csv", "mediatype": "text/csv", @@ -3282,39 +3267,54 @@ "id": { "name": "id", "type": "string", - "format": "uuid", "title": "Identifier", - "description": "The identifier for the unit object. Each unit must have a unique identifier.", - "example": "8896b788-7b3e-11ef-8db9-7f3d040352b3" + "description": "The identifier for the URL object. Each URL must have a unique identifier.", + "format": "uuid", + "constraints": { + "unique": true + }, + "example": "30951f94-7b24-11ef-ba1b-a79405d4dcaa" }, - "name": { - "name": "name", + "label": { + "name": "label", "type": "string", - "title": "Name", - "description": "The human-readable name for this unit e.g. \u201cBed\u201d or \u201cHours\u201d", - "example": "Kilogram" + "title": "Label", + "description": "The human-readable label for this url e.g. \u201cTwitter\u201d or \u201cWebsite\u201d.", + "constraints": { + "unique": false + }, + "example": "Website" }, - "scheme": { - "name": "scheme", + "url": { + "name": "url", "type": "string", - "title": "Scheme", - "description": "The scheme which formalizes the unit, if applicable e.g. \u201cSI\u201d for Standard International Units such as Kilogram, Litre, etc.", - "example": "SI" + "format": "uri", + "title": "URL", + "description": "The URL for this URL object. This must be formatted as a valid URI.", + "constraints": { + "unique": false + }, + "example": "https://example.org" }, - "identifier": { - "name": "identifier", + "organization_id": { + "name": "organization_id", "type": "string", - "title": "Unit Identifier", - "description": "The identifier of the unit taken from the scheme if applicable e.g. `kgm` for Kilogram.", - "example": "kgm" + "format": "uuid", + "title": "Organization Identifier", + "description": "The identifier for the organization associated with this URL object", + "constraints": { + "unique": false + } }, - "uri": { - "name": "uri", + "service_id": { + "name": "service_id", "type": "string", - "format": "uri", - "title": "URI", - "description": "The URI to the definition of the unit, if applicable", - "example": "https://not-a-real-url.org/standard-international-units/kgm" + "format": "uuid", + "title": "Service Identifier", + "description": "The identifier for the service associated with this URL object", + "constraints": { + "unique": false + } }, "attributes": { "name": "attributes", @@ -3337,7 +3337,7 @@ }, "required": [ "id", - "name" + "url" ] } } diff --git a/schema/openapi.json b/schema/openapi.json index 03adcf1..ff37c95 100644 --- a/schema/openapi.json +++ b/schema/openapi.json @@ -833,7 +833,8 @@ "type": "boolean", "description": "A Boolean value indicating if there is an empty result set" } - } + }, + "required": ["empty"] } }, "parameters": { From ac0c99f991f34a7019f27ee9f168dcc8562744f7 Mon Sep 17 00:00:00 2001 From: kathryn-ods Date: Fri, 1 Nov 2024 11:13:07 +0000 Subject: [PATCH 2/3] running compile-all --- docs/extras/openapi30.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/extras/openapi30.json b/docs/extras/openapi30.json index ebc2db1..e1a5356 100644 --- a/docs/extras/openapi30.json +++ b/docs/extras/openapi30.json @@ -826,7 +826,10 @@ "type": "boolean", "description": "A Boolean value indicating if there is an empty result set" } - } + }, + "required": [ + "empty" + ] } }, "parameters": { From 8e780e053104fd90126c702ebf8254809bd9b224 Mon Sep 17 00:00:00 2001 From: kathryn-ods Date: Fri, 1 Nov 2024 11:20:47 +0000 Subject: [PATCH 3/3] updated changelog --- docs/hsds/changelog.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/hsds/changelog.md b/docs/hsds/changelog.md index 88311c3..36ca171 100644 --- a/docs/hsds/changelog.md +++ b/docs/hsds/changelog.md @@ -3,6 +3,9 @@ Changelog This page provides the list of changes that have been made to the HSDS schema. +## [v3.1.1](https://github.com/openreferral/specification/releases/tag/v3.1.1) +* Made Page.empty a required field for API responses + ## [v3.1](https://github.com/openreferral/specification/releases/tag/v3.1) ### New schemas