Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

PATCH: make Page.empty a required field #523

Open
wants to merge 3 commits into
base: 3.1.1-dev
Choose a base branch
from
Open

PATCH: make Page.empty a required field #523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0397823
adding empty as a required field for components/schema/Page
kathryn-ods Nov 1, 2024
ac0c99f
running compile-all
kathryn-ods Nov 1, 2024
8e780e0
updated changelog
kathryn-ods Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/extras/openapi30.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,10 @@
"type": "boolean",
"description": "A Boolean value indicating if there is an empty result set"
}
}
},
"required": [
"empty"
]
}
},
"parameters": {
Expand Down
3 changes: 3 additions & 0 deletions docs/hsds/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
146 changes: 73 additions & 73 deletions schema/compiled/service_with_definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -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",
Expand All @@ -3337,7 +3337,7 @@
},
"required": [
"id",
"name"
"url"
]
}
}
Expand Down
3 changes: 2 additions & 1 deletion schema/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -833,7 +833,8 @@
"type": "boolean",
"description": "A Boolean value indicating if there is an empty result set"
}
}
},
"required": ["empty"]
}
},
"parameters": {
Expand Down
Loading