make Page.empty a required field

openreferral · Dec 5, 2024 · 185a7d1 · 185a7d1
1 parent 733e148
commit 185a7d1
Show file tree

Hide file tree

Showing 4 changed files with 109 additions and 101 deletions.
diff --git 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": {

diff --git a/docs/hsds/changelog.md b/docs/hsds/changelog.md
@@ -1,6 +1,10 @@
 Changelog
 =========
 
+## [v3.1.1](https://github.com/openreferral/specification/releases/tag/v3.1.1)
+
+* Made Page.empty a required field for API responses
+
 This page provides the list of changes that have been made to the HSDS schema.
 
 ## [v3.1](https://github.com/openreferral/specification/releases/tag/v3.1)

diff --git a/schema/compiled/service_with_definitions.json b/schema/compiled/service_with_definitions.json
@@ -3075,10 +3075,10 @@
         "description"
       ]
     },
-    "url": {
-      "name": "url",
-      "path": "url.csv",
-      "description": "A URL with a label",
+    "service_capacity": {
+      "name": "service_capacity",
+      "path": "service_capacity.csv",
+      "description": "The details of service capacities for services.",
       "datapackage_metadata": {
         "format": "csv",
         "mediatype": "text/csv",
@@ -3089,57 +3089,86 @@
       "properties": {
         "id": {
           "name": "id",
-          "type": "string",
           "title": "Identifier",
-          "description": "The identifier for the URL object. Each URL must have a unique identifier.",
-          "format": "uuid",
+          "type": "string",
           "constraints": {
+            "required": true,
             "unique": true
           },
-          "example": "30951f94-7b24-11ef-ba1b-a79405d4dcaa"
+          "format": "uuid",
+          "description": "The identifier for the service_capacity object. Each service_capacity must have a unique identifier.",
+          "example": "8896b788-7b3e-11ef-8db9-7f3d040352b3"
         },
-        "label": {
-          "name": "label",
+        "service_id": {
+          "name": "service_id",
+          "title": "Service Identifier",
           "type": "string",
-          "title": "Label",
-          "description": "The human-readable label for this url e.g. \u201cTwitter\u201d or \u201cWebsite\u201d.",
+          "format": "uuid",
+          "description": "The identifier for the Service object associated with this service capacity object. Only required in the tabular representation.",
           "constraints": {
             "unique": false
           },
-          "example": "Website"
+          "example": "ac148810-d857-441c-9679-408f346de14b"
         },
-        "url": {
-          "name": "url",
+        "unit": {
+          "$ref": "#/definitions/unit"
+        },
+        "unit_id": {
+          "name": "unit_id",
+          "title": "Unit ID",
           "type": "string",
-          "format": "uri",
-          "title": "URL",
-          "description": "The URL for this URL object. This must be formatted as a valid URI.",
+          "format": "uuid",
+          "description": "The identifier for the unit object.",
           "constraints": {
             "unique": false
           },
-          "example": "https://example.org"
+          "example": "8896b788-7b3e-11ef-8db9-7f3d040352b3"
         },
-        "organization_id": {
-          "name": "organization_id",
+        "available": {
+          "name": "available",
+          "title": "Available",
+          "type": "number",
+          "constraints": {
+            "required": true,
+            "unique": false
+          },
+          "description": "The number of units available as of the last update.",
+          "example": "12"
+        },
+        "maximum": {
+          "name": "maximum",
+          "title": "Maximum",
+          "type": "number",
+          "constraints": {
+            "required": false,
+            "unique": false
+          },
+          "description": "The maximum number of units that can be available for this service, if applicable",
+          "example": "10"
+        },
+        "description": {
+          "name": "description",
+          "title": "Description",
           "type": "string",
-          "format": "uuid",
-          "title": "Organization Identifier",
-          "description": "The identifier for the organization associated with this URL object",
           "constraints": {
+            "required": false,
             "unique": false
           },
-          "example": "d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610"
+          "description": "A Human-Friendly description of this service capacity e.g. \u201cBeds available for people experiencing homelessness\u201d",
+          "example": "Beds available for people experiencing homelessness."
         },
-        "service_id": {
-          "name": "service_id",
+        "updated": {
+          "name": "updated",
+          "title": "Date Updated",
           "type": "string",
-          "format": "uuid",
-          "title": "Service Identifier",
-          "description": "The identifier for the service associated with this URL object",
           "constraints": {
+            "required": true,
             "unique": false
           },
-          "example": "ac148810-d857-441c-9679-408f346de14b"
+          "format": "date-time",
+          "datapackage_type": "datetime",
+          "description": "The datetime when this service_capacit y object was last updated or changed. Should have millisecond accuracy. ",
+          "example": "2024-09-25T14:23:06.5+01:00"
         },
         "attributes": {
           "name": "attributes",
@@ -3162,7 +3191,13 @@
       },
       "required": [
         "id",
-        "url"
+        "unit",
+        "available",
+        "updated"
+      ],
+      "tabular_required": [
+        "unit_id",
+        "service_id"
       ]
     },
     "unit": {
@@ -3258,10 +3293,10 @@
         "name"
       ]
     },
-    "service_capacity": {
-      "name": "service_capacity",
-      "path": "service_capacity.csv",
-      "description": "The details of service capacities for services.",
+    "url": {
+      "name": "url",
+      "path": "url.csv",
+      "description": "A URL with a label",
       "datapackage_metadata": {
         "format": "csv",
         "mediatype": "text/csv",
@@ -3272,86 +3307,57 @@
       "properties": {
         "id": {
           "name": "id",
-          "title": "Identifier",
           "type": "string",
+          "title": "Identifier",
+          "description": "The identifier for the URL object. Each URL must have a unique identifier.",
+          "format": "uuid",
           "constraints": {
-            "required": true,
             "unique": true
           },
-          "format": "uuid",
-          "description": "The identifier for the service_capacity object. Each service_capacity must have a unique identifier.",
-          "example": "8896b788-7b3e-11ef-8db9-7f3d040352b3"
+          "example": "30951f94-7b24-11ef-ba1b-a79405d4dcaa"
         },
-        "service_id": {
-          "name": "service_id",
-          "title": "Service Identifier",
+        "label": {
+          "name": "label",
           "type": "string",
-          "format": "uuid",
-          "description": "The identifier for the Service object associated with this service capacity object. Only required in the tabular representation.",
+          "title": "Label",
+          "description": "The human-readable label for this url e.g. \u201cTwitter\u201d or \u201cWebsite\u201d.",
           "constraints": {
             "unique": false
           },
-          "example": "ac148810-d857-441c-9679-408f346de14b"
-        },
-        "unit": {
-          "$ref": "#/definitions/unit"
+          "example": "Website"
         },
-        "unit_id": {
-          "name": "unit_id",
-          "title": "Unit ID",
+        "url": {
+          "name": "url",
           "type": "string",
-          "format": "uuid",
-          "description": "The identifier for the unit object.",
-          "constraints": {
-            "unique": false
-          },
-          "example": "8896b788-7b3e-11ef-8db9-7f3d040352b3"
-        },
-        "available": {
-          "name": "available",
-          "title": "Available",
-          "type": "number",
-          "constraints": {
-            "required": true,
-            "unique": false
-          },
-          "description": "The number of units available as of the last update.",
-          "example": "12"
-        },
-        "maximum": {
-          "name": "maximum",
-          "title": "Maximum",
-          "type": "number",
+          "format": "uri",
+          "title": "URL",
+          "description": "The URL for this URL object. This must be formatted as a valid URI.",
           "constraints": {
-            "required": false,
             "unique": false
           },
-          "description": "The maximum number of units that can be available for this service, if applicable",
-          "example": "10"
+          "example": "https://example.org"
         },
-        "description": {
-          "name": "description",
-          "title": "Description",
+        "organization_id": {
+          "name": "organization_id",
           "type": "string",
+          "format": "uuid",
+          "title": "Organization Identifier",
+          "description": "The identifier for the organization associated with this URL object",
           "constraints": {
-            "required": false,
             "unique": false
           },
-          "description": "A Human-Friendly description of this service capacity e.g. \u201cBeds available for people experiencing homelessness\u201d",
-          "example": "Beds available for people experiencing homelessness."
+          "example": "d9d5e0f5-d3ce-4f73-9a2f-4dd0ecc6c610"
         },
-        "updated": {
-          "name": "updated",
-          "title": "Date Updated",
+        "service_id": {
+          "name": "service_id",
           "type": "string",
+          "format": "uuid",
+          "title": "Service Identifier",
+          "description": "The identifier for the service associated with this URL object",
           "constraints": {
-            "required": true,
             "unique": false
           },
-          "format": "date-time",
-          "datapackage_type": "datetime",
-          "description": "The datetime when this service_capacit y object was last updated or changed. Should have millisecond accuracy. ",
-          "example": "2024-09-25T14:23:06.5+01:00"
+          "example": "ac148810-d857-441c-9679-408f346de14b"
         },
         "attributes": {
           "name": "attributes",
@@ -3374,13 +3380,7 @@
       },
       "required": [
         "id",
-        "unit",
-        "available",
-        "updated"
-      ],
-      "tabular_required": [
-        "unit_id",
-        "service_id"
+        "url"
       ]
     }
   }

diff --git 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": {