feat: finish updating api pages to use fancier components

crowbartools · Jan 11, 2025 · 5aea2b4 · 5aea2b4
1 parent 5ffe49f
commit 5aea2b4
Show file tree

Hide file tree

Showing 14 changed files with 1,679 additions and 2,738 deletions.
diff --git a/src/app/v5/dev/api/contacts/page.mdx b/src/app/v5/dev/api/contacts/page.mdx
diff --git a/src/app/v5/dev/api/counters/page.mdx b/src/app/v5/dev/api/counters/page.mdx
@@ -1,93 +1,119 @@
-# Counters API
-
-## `GET /counters`
-
-#### Description:
-
-Fetches all available counters.
-
-#### Example Request:
-
-```
-GET /counters
-```
+export const metadata = {
+  title: 'Counters',
+  description: 'Documentation for counter API endpoints.',
+}
 
-#### Example Response:
+# Counters
 
-```json
-[
-  {
-    "id": "counter1",
-    "name": "Counter 1",
-    "value": 10
-  },
-  {
-    "id": "counter2",
-    "name": "Counter 2",
-    "value": 15
-  }
-]
-```
+The Counters API allows you to manage and retrieve counter values.
 
 ---
 
-## `GET /counters/:counterId`
-
-#### Description:
-
-Fetches a specific counter by its `counterId`.
-
-#### Request Parameters:
-
-- `counterId`: The unique identifier of the counter.
-
-#### Example Request:
-
-```
-GET /counters/counter1
-```
-
-#### Example Response:
-
-```json
-{
-  "id": "counter1",
-  "name": "Counter 1",
-  "value": 10
-}
-```
+## List all counters  {{ tag: 'GET', label: '/counters' }}
+
+<Row>
+  <Col>
+    Retrieves a list of all counters
+  </Col>
+
+  <Col sticky>
+    <CodeGroup title="Request" tag="GET" label="/counters">
+    ```bash {{ title: 'cURL' }}
+    curl http://localhost:7472/api/v1/counters
+    ```
+    </CodeGroup>
+
+    ```json {{ title: 'Response' }}
+    [
+      {
+        "id": "counter1",
+        "name": "Counter 1",
+        "value": 10
+      },
+      {
+        "id": "counter2",
+        "name": "Counter 2",
+        "value": 15
+      }
+    ]
+    ```
+  </Col>
+</Row>
 
 ---
 
-## `POST /counters/:counterId`
-
-#### Description:
-
-Updates the value of an existing counter. Optionally, you can override the current value.
-
-#### Request Parameters:
-
-- `counterId`: The unique identifier of the counter to be updated.
-
-#### Request Body:
+## Retrieve a counter  {{ tag: 'GET', label: '/counters/:counterId' }}
+
+<Row>
+  <Col>
+    Fetches a specific counter by its `counterId`.
+
+    ### URL Parameters
+    <Properties>
+      <Property name="counterId" type="string" required>
+        The unique identifier of the counter
+      </Property>
+    </Properties>
+  </Col>
+
+  <Col sticky>
+    <CodeGroup title="Request" tag="GET" label="/counters/counter1">
+    ```bash {{ title: 'cURL' }}
+    curl http://localhost:7472/api/v1/counters/counter1
+    ```
+    </CodeGroup>
+
+    ```json {{ title: 'Response' }}
+    {
+      "id": "counter1",
+      "name": "Counter 1",
+      "value": 10
+    }
+    ```
+  </Col>
+</Row>
 
-- `value`: The new value to set for the counter (required).
-- `override`: A boolean indicating whether to override the counter's current value (optional, defaults to `false`).
-
-#### Example Request:
-
-```json
-{
-  "value": 20,
-  "override": true
-}
-```
-
-#### Example Response:
+---
 
-```json
-{
-  "oldValue": 10,
-  "newValue": 20
-}
-```
+## Update a counter  {{ tag: 'POST', label: '/counters/:counterId' }}
+
+<Row>
+  <Col>
+    Updates the value of an existing counter. Optionally, you can override the current value.
+
+    ### Request Parameters
+    <Properties>
+      <Property name="counterId" type="string" required>
+        The unique identifier of the counter to be updated
+      </Property>
+    </Properties>
+
+    ### Request Body
+    <Properties>
+      <Property name="value" type="number" required>
+        The new value to set for the counter
+      </Property>
+      <Property name="override" type="boolean">
+        A boolean indicating whether to override the counter's current value.
+        If false, the new value will be added to the current value (optional, defaults to `false`)
+      </Property>
+    </Properties>
+  </Col>
+
+  <Col sticky>
+    <CodeGroup title="Request" tag="POST" label="/counters/counter1">
+    ```bash {{ title: 'cURL' }}
+    curl -X POST http://localhost:7472/api/v1/counters/counter1 \
+      -H "Content-Type: application/json" \
+      -d '{"value": 20, "override": true}'
+    ```
+    </CodeGroup>
+
+    ```json {{ title: 'Response' }}
+    {
+      "oldValue": 10,
+      "newValue": 20
+    }
+    ```
+  </Col>
+</Row>