docs updates

Author: russbiggs

package-lock.json

@@ -22,6 +22,7 @@
     "starlight-openapi": "^0.7.0"
   },
   "devDependencies": {
+    "@iconify-json/mdi": "^1.2.0",
     "@types/node": "^22.10.0",
     "knip": "^5.38.1",
     "typescript": "^5.7.2"

package.json

@@ -4,7 +4,7 @@ description:
   The Latest resource provides the most recent air quality measurements from
   sensors, including the measurement time, value, location coordinates, and
   sensor information. Track real-time air quality trends and gain insights into
-  the newest data available across locations and parameters.
+  the newest data available across Locations and Parameters.
 ---
 import FeedbackForm from '../../../components/FeedbackForm.astro';
 
@@ -31,8 +31,8 @@ The Latest resource provides access to the newest air quality data from sensors.
 It shows recent measurements and their geographic location, allowing users to
 track air quality trends quickly and make timely decisions.
 
-The Latest resource is accessible through either a single [location](locations),
-showing latest values for all sensors available at that location, or by
+The Latest resource is accessible through either a single [Location](locations),
+showing latest values for all sensors available at that Location, or by
 parameter, showing the latest value across all sensors that measure that
 parameter, e.g.:
 
@@ -55,7 +55,7 @@ https://api.openaq.org/v3/parameters/2/latest
 - coordinates: the location in WGS84 latitude and longitude of the reading.
 - sensorsId: the unique ID for the sensor that took the reading. See the
   [Sensors](sensors) resource page for more information.
-- locationsId: the unique ID for the location where the sensor is situated. See
+- locationsId: the unique ID for the :ocation where the sensor is situated. See
   the [Locations](locations) resource page for more information.
 
 ## Example response payload

src/content/docs/resources/latest.mdx

@@ -72,8 +72,8 @@ the selected time range.
 
 <Aside type="note">
   A call to the `/v3/sensors/{sensors_id}/measurements/hourly` is functionally
-  the same as `/v3/sensors/{sensors_id}/hours`. The `/hours` options is the
-  preferred resource.
+  the same as `/v3/sensors/{sensors_id}/hours`. The `/hours` resource is the
+  preferred option.
 </Aside>
 
 ### Daily
@@ -87,8 +87,8 @@ selected time range.
 
 <Aside type="note">
   A call to the `/v3/sensors/{sensors_id}/hours/daily` is functionally the same
-  as `/v3/sensors/{sensors_id}/days`. The `/days` options is the preferred
-  resource.
+  as `/v3/sensors/{sensors_id}/days`. The `/days` resource is the
+  preferred option.
 </Aside>
 
 ### Monthly
@@ -115,8 +115,8 @@ the selected time range.
 
 <Aside type="note">
   A call to the `/v3/sensors/{sensors_id}/hours/yearly` is functionally the same
-  as `/v3/sensors/{sensors_id}/years`. The `/years` options is the preferred
-  resource.
+  as `/v3/sensors/{sensors_id}/years`. The `/years` resource is the
+  preferred option.
 </Aside>
 
 ### Hour of day

src/content/docs/resources/measurements.mdx

@@ -10,9 +10,10 @@ import FeedbackForm from '../../../components/FeedbackForm.astro';
 
 
 The Sensors resource in the OpenAQ API provides details about individual air
-quality sensors that collect environmental data. Each sensor tracks a single
-parameter, such as air pollutant measurements or related measurements (e.g.,
-temperature and humidity) and reports on their concentration over time.
+quality sensors that collect environmental data. One or more sensors belong to a
+[Location](locations). Each sensor tracks a single parameter, such as air pollutant 
+measurements or related measurements (e.g., temperature and humidity) and 
+reports on their concentration over time.
 
 ## Purpose and Use
 

src/content/docs/resources/sensors.mdx

@@ -28,8 +28,9 @@ and address any problems that arise when using the API.
     <tbody>
         <tr><td>200</td><td>OK</td><td>Successful request.</td></tr>
         <tr><td>401</td><td>Unauthorized</td><td>Valid API key is missing.</td></tr>
+        <tr><td>403</td><td>Forbidden</td><td>The requested resource may exist but the user is not granted access. This may be a sign that the user account has been blocked for non-compliance of the terms of use.</td></tr>
         <tr><td>404</td><td>Not Found</td><td>The requested resource does not exist.</td></tr>
-        <tr><td>405</td><td>Method Not Allow</td><td>The HTTP method is not supported. The OpenAQ API currently only supports GET requests.</td></tr>
+        <tr><td>405</td><td>Method Not Allowed</td><td>The HTTP method is not supported. The OpenAQ API currently only supports GET requests.</td></tr>
         <tr><td>408</td><td>Request Timeout</td><td>The request timed out, the query may be too complex causing it to run too long.</td></tr>
         <tr><td>422</td><td>Unprocessable Content</td><td>The query provided is
         incorrect and does not follow the standards set by the API specification.</td></tr>

src/content/docs/using-the-api/errors.mdx

@@ -47,8 +47,70 @@ using the command line on your computer.
         --header "X-API-Key: YOUR-OPENAQ-API-KEY"
         ```
 
-4.  The JSON response will give you the data for location 8118. You have now
-    used the OpenAQ API successfully.
+4.  The JSON response will looks something like the following:
+
+        ```json
+        {
+        "meta": {
+            "name": "openaq-api",
+            "website": "/",
+            "page": 1,
+            "limit": 100,
+            "found": 1
+        },
+        "results": [
+            {
+            "id": 8118,
+            "name": "New Delhi",
+            "locality": "India",
+            "timezone": "Asia/Kolkata",
+            "country": { "id": 9, "code": "IN", "name": "India" },
+            "owner": { "id": 4, "name": "Unknown Governmental Organization" },
+            "provider": { "id": 119, "name": "AirNow" },
+            "isMobile": false,
+            "isMonitor": true,
+            "instruments": [{ "id": 2, "name": "Government Monitor" }],
+            "sensors": [
+                {
+                "id": 23534,
+                "name": "pm25 µg/m³",
+                "parameter": {
+                    "id": 2,
+                    "name": "pm25",
+                    "units": "µg/m³",
+                    "displayName": "PM2.5"
+                }
+                }
+            ],
+            "coordinates": { "latitude": 28.63576, "longitude": 77.22445 },
+            "licenses": [
+                {
+                "id": 33,
+                "name": "US Public Domain",
+                "attribution": {
+                    "name": "Unknown Governmental Organization",
+                    "url": null
+                },
+                "dateFrom": "2016-01-30",
+                "dateTo": null
+                }
+            ],
+            "bounds": [77.22445, 28.63576, 77.22445, 28.63576],
+            "distance": null,
+            "datetimeFirst": {
+                "utc": "2016-11-09T19:00:00Z",
+                "local": "2016-11-10T00:30:00+05:30"
+            },
+            "datetimeLast": {
+                "utc": "2024-12-13T14:30:00Z",
+                "local": "2024-12-13T20:00:00+05:30"
+            }
+            }
+        ]
+        }
+
+        ```
+
 
 </Steps>