reqcord 0.1.0 → 0.1.1

data/examples/complex-spec-app/docs/api/api/v1/orders/list.md

@@ -0,0 +1,78 @@
+# List Orders
+
+`GET /api/v1/orders`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Accept | `application/json` |
+
+## Query Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `status` | string | no | `"pending"` \| `"shipped"` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/orders" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `[].id` | integer | yes | `2` |
+| `[].user_id` | integer | yes | `1` |
+| `[].status` | string | yes | `"pending"` \| `"shipped"` |
+| `[].currency` | string | yes | `"USD"` |
+| `[].total_cents` | integer | yes | `3200` |
+
+```json
+[
+  {
+    "id": 1,
+    "user_id": 1,
+    "status": "pending",
+    "currency": "USD",
+    "total_cents": 2700
+  },
+  {
+    "id": 2,
+    "user_id": 1,
+    "status": "shipped",
+    "currency": "USD",
+    "total_cents": 3200
+  }
+]
+```
+
+### 401 Unauthorized
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Unauthorized"` |
+
+```json
+{
+  "error": "Unauthorized"
+}
+```
+
+---
+
+Resource: [Orders](index.md)

data/examples/complex-spec-app/docs/api/api/v1/orders/show.md

@@ -0,0 +1,83 @@
+# Get Order
+
+`GET /api/v1/orders/:id`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Accept | `application/json` |
+
+## Path Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | string | yes | `"1"` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/orders/1" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `1` |
+| `user_id` | integer | yes | `1` |
+| `status` | string | yes | `"pending"` |
+| `currency` | string | yes | `"USD"` |
+| `total_cents` | integer | yes | `2700` |
+
+```json
+{
+  "id": 1,
+  "user_id": 1,
+  "status": "pending",
+  "currency": "USD",
+  "total_cents": 2700
+}
+```
+
+### 403 Forbidden
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Forbidden"` |
+
+```json
+{
+  "error": "Forbidden"
+}
+```
+
+### 404 Not Found
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Not Found"` |
+
+```json
+{
+  "error": "Not Found"
+}
+```
+
+---
+
+Resource: [Orders](index.md)

data/examples/complex-spec-app/docs/api/api/v1/products/index.md

@@ -0,0 +1,11 @@
+# Products
+
+Namespace: `api/v1`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/products`](list.md) | List Products |
+| `GET` | [`/api/v1/products/:id`](show.md) | Get Product |
+| `GET` | [`/api/v1/products/search`](search.md) | Search Products |

data/examples/complex-spec-app/docs/api/api/v1/products/list.md

@@ -0,0 +1,83 @@
+# List Products
+
+`GET /api/v1/products`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Accept | `application/json` |
+
+## Query Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `filter.category` | string | no | `"mugs"` \| `"tea"` |
+| `sort` | string | no | `"price_asc"` \| `"price_desc"` |
+| `page` | integer | no | `2` |
+| `per_page` | integer | no | `2` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/products" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `data[].id` | integer | yes | `2` |
+| `data[].sku` | string | yes | `"TEA-002"` |
+| `data[].name` | string | yes | `"Sencha"` |
+| `data[].category` | string | yes | `"mugs"` \| `"tea"` |
+| `data[].price_cents` | integer | yes | `1500` |
+| `data[].tags[]` | string | yes | `"ceramic"` \| `"green"` \| `"insulated"` |
+| `meta.page` | integer | yes | `1` |
+| `meta.per_page` | integer | yes | `2` |
+| `meta.total` | integer | yes | `4` |
+
+```json
+{
+  "data": [
+    {
+      "id": 1,
+      "sku": "TEA-001",
+      "name": "Earl Grey",
+      "category": "tea",
+      "price_cents": 1200,
+      "tags": [
+        "black",
+        "bergamot"
+      ]
+    },
+    {
+      "id": 2,
+      "sku": "TEA-002",
+      "name": "Sencha",
+      "category": "tea",
+      "price_cents": 1500,
+      "tags": [
+        "green"
+      ]
+    }
+  ],
+  "meta": {
+    "page": 1,
+    "per_page": 2,
+    "total": 4
+  }
+}
+```
+
+---
+
+Resource: [Products](index.md)

data/examples/complex-spec-app/docs/api/api/v1/products/search.md

@@ -0,0 +1,88 @@
+# Search Products
+
+`GET /api/v1/products/search`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Accept | `application/json` |
+
+## Query Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `q` | string | yes | `"mug"` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/products/search?q=mug" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `query` | string | yes | `"mug"` |
+| `results[].id` | integer | yes | `4` |
+| `results[].sku` | string | yes | `"MUG-002"` |
+| `results[].name` | string | yes | `"Travel Mug"` |
+| `results[].category` | string | yes | `"mugs"` |
+| `results[].price_cents` | integer | yes | `3200` |
+| `results[].tags[]` | string | yes | `"insulated"` |
+
+```json
+{
+  "query": "mug",
+  "results": [
+    {
+      "id": 3,
+      "sku": "MUG-001",
+      "name": "Stoneware Mug",
+      "category": "mugs",
+      "price_cents": 2400,
+      "tags": [
+        "ceramic"
+      ]
+    },
+    {
+      "id": 4,
+      "sku": "MUG-002",
+      "name": "Travel Mug",
+      "category": "mugs",
+      "price_cents": 3200,
+      "tags": [
+        "steel",
+        "insulated"
+      ]
+    }
+  ]
+}
+```
+
+### 400 Bad Request
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"q is required"` |
+
+```json
+{
+  "error": "q is required"
+}
+```
+
+---
+
+Resource: [Products](index.md)

data/examples/complex-spec-app/docs/api/api/v1/products/show.md

@@ -0,0 +1,71 @@
+# Get Product
+
+`GET /api/v1/products/:id`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Accept | `application/json` |
+
+## Path Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | string | yes | `"3"` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/products/3" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `3` |
+| `sku` | string | yes | `"MUG-001"` |
+| `name` | string | yes | `"Stoneware Mug"` |
+| `category` | string | yes | `"mugs"` |
+| `price_cents` | integer | yes | `2400` |
+| `tags[]` | string | yes | `"ceramic"` |
+
+```json
+{
+  "id": 3,
+  "sku": "MUG-001",
+  "name": "Stoneware Mug",
+  "category": "mugs",
+  "price_cents": 2400,
+  "tags": [
+    "ceramic"
+  ]
+}
+```
+
+### 404 Not Found
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Not Found"` |
+
+```json
+{
+  "error": "Not Found"
+}
+```
+
+---
+
+Resource: [Products](index.md)

data/examples/complex-spec-app/docs/api/api/v1/profiles/index.md

@@ -0,0 +1,10 @@
+# Profiles
+
+Namespace: `api/v1`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/profile`](show.md) | Get Profile |
+| `PATCH` | [`/api/v1/profile`](update.md) | Update Profile |

data/examples/complex-spec-app/docs/api/api/v1/profiles/show.md

@@ -0,0 +1,61 @@
+# Get Profile
+
+`GET /api/v1/profile`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Accept | `application/json` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/profile" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `1` |
+| `name` | string | yes | `"Ada Lovelace"` |
+| `email` | string | yes | `"ada@example.com"` |
+| `locale` | string | yes | `"en"` |
+
+```json
+{
+  "id": 1,
+  "name": "Ada Lovelace",
+  "email": "ada@example.com",
+  "locale": "en"
+}
+```
+
+### 401 Unauthorized
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Unauthorized"` |
+
+```json
+{
+  "error": "Unauthorized"
+}
+```
+
+---
+
+Resource: [Profiles](index.md)

data/examples/complex-spec-app/docs/api/api/v1/profiles/update.md

@@ -0,0 +1,91 @@
+# Update Profile
+
+`PATCH /api/v1/profile` (also `PUT`)
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Content-Type | `application/json` |
+| Accept | `application/json` |
+
+## Body Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `profile.name` | string | yes | `"Ada L."` |
+| `profile.locale` | string | yes | `"tr"` |
+
+## Example Request
+
+```json
+{
+  "profile": {
+    "name": "Ada L.",
+    "locale": "tr"
+  }
+}
+```
+
+## cURL
+
+```bash
+curl --request PATCH \
+  --url "http://localhost:3000/api/v1/profile" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Content-Type: application/json" \
+  --header "Accept: application/json" \
+  --data '{
+  "profile": {
+    "name": "Ada L.",
+    "locale": "tr"
+  }
+}'
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `1` |
+| `name` | string | yes | `"Ada L."` |
+| `email` | string | yes | `"ada@example.com"` |
+| `locale` | string | yes | `"tr"` |
+
+```json
+{
+  "id": 1,
+  "name": "Ada L.",
+  "email": "ada@example.com",
+  "locale": "tr"
+}
+```
+
+### 422 Unprocessable Content
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `errors.locale[]` | string | yes | `"is not included in the list"` |
+
+```json
+{
+  "errors": {
+    "locale": [
+      "is not included in the list"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Profiles](index.md)

data/examples/complex-spec-app/docs/api/api/v2/products/index.md

@@ -0,0 +1,9 @@
+# Products
+
+Namespace: `api/v2`
+
+API version: `v2`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v2/products`](list.md) | List Products |

data/examples/complex-spec-app/docs/api/api/v2/products/list.md

@@ -0,0 +1,77 @@
+# List Products
+
+`GET /api/v2/products`
+
+Namespace: `api/v2`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Accept | `application/json` |
+
+## Query Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `cursor` | string | no | `"eyJpZCI6Mn0"` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v2/products" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `items[].id` | integer | yes | `2` |
+| `items[].sku` | string | yes | `"TEA-002"` |
+| `items[].name` | string | yes | `"Sencha"` |
+| `items[].category` | string | yes | `"mugs"` \| `"tea"` |
+| `items[].price_cents` | integer | yes | `1500` |
+| `items[].tags[]` | string | yes | `"green"` \| `"insulated"` |
+| `items[].price` | string | yes | `"15.00"` |
+| `next_cursor` | null | string | yes | `"eyJpZCI6Mn0"` |
+
+```json
+{
+  "items": [
+    {
+      "id": 1,
+      "sku": "TEA-001",
+      "name": "Earl Grey",
+      "category": "tea",
+      "price_cents": 1200,
+      "tags": [
+        "black",
+        "bergamot"
+      ],
+      "price": "12.00"
+    },
+    {
+      "id": 2,
+      "sku": "TEA-002",
+      "name": "Sencha",
+      "category": "tea",
+      "price_cents": 1500,
+      "tags": [
+        "green"
+      ],
+      "price": "15.00"
+    }
+  ],
+  "next_cursor": "eyJpZCI6Mn0"
+}
+```
+
+---
+
+Resource: [Products](index.md)

data/examples/complex-spec-app/docs/api/curl/api/v1/admin/products/create.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Create Product
+# POST /api/v1/admin/products
+curl --request POST \
+  --url "http://localhost:3000/api/v1/admin/products" \
+  --header "X-Api-Key: {{api_key}}" \
+  --header "Content-Type: application/json" \
+  --header "Accept: application/json" \
+  --data '{
+  "product": {
+    "sku": "TEA-003",
+    "name": "Jasmine",
+    "category": "tea",
+    "price_cents": 1400
+  }
+}'

data/examples/complex-spec-app/docs/api/curl/api/v1/admin/products/destroy.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Delete Product
+# DELETE /api/v1/admin/products/:id
+curl --request DELETE \
+  --url "http://localhost:3000/api/v1/admin/products/4" \
+  --header "X-Api-Key: {{api_key}}" \
+  --header "Accept: application/json"

data/examples/complex-spec-app/docs/api/curl/api/v1/admin/products/list.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# List Products
+# GET /api/v1/admin/products
+curl --request GET \
+  --url "http://localhost:3000/api/v1/admin/products" \
+  --header "X-Api-Key: {{api_key}}" \
+  --header "Accept: application/json"