reqcord 0.1.1 → 0.1.2

data/examples/complex-test-app/docs/api/api/v1/notes/list.md

@@ -1,61 +0,0 @@
-# List Notes
-
-`GET /api/v1/orders/:order_id/notes`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Authorization | `Bearer {{token}}` |
-| Accept | `application/json` |
-
-## Path Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `order_id` | string | yes | `"1"` |
-
-## cURL
-
-```bash
-curl --request GET \
-  --url "http://localhost:3000/api/v1/orders/1/notes" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `[].id` | integer | yes | `2` |
-| `[].order_id` | integer | yes | `1` |
-| `[].body` | string | yes | `"Gift wrap please"` |
-| `[].author` | string | yes | `"ada"` |
-
-```json
-[
-  {
-    "id": 1,
-    "order_id": 1,
-    "body": "Leave at the door",
-    "author": "ada"
-  },
-  {
-    "id": 2,
-    "order_id": 1,
-    "body": "Gift wrap please",
-    "author": "ada"
-  }
-]
-```
-
----
-
-Resource: [Notes](index.md)

data/examples/complex-test-app/docs/api/api/v1/orders/cancel.md

@@ -1,69 +0,0 @@
-# Cancel Order
-
-`POST /api/v1/orders/:id/cancel`
-
-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 POST \
-  --url "http://localhost:3000/api/v1/orders/1/cancel" \
-  --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 | `"cancelled"` |
-| `currency` | string | yes | `"USD"` |
-| `total_cents` | integer | yes | `2700` |
-
-```json
-{
-  "id": 1,
-  "user_id": 1,
-  "status": "cancelled",
-  "currency": "USD",
-  "total_cents": 2700
-}
-```
-
-### 409 Conflict
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `error` | string | yes | `"Shipped orders cannot be cancelled"` |
-
-```json
-{
-  "error": "Shipped orders cannot be cancelled"
-}
-```
-
----
-
-Resource: [Orders](index.md)

data/examples/complex-test-app/docs/api/api/v1/orders/create.md

@@ -1,150 +0,0 @@
-# Create Order
-
-`POST /api/v1/orders`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Authorization | `Bearer {{token}}` |
-| Content-Type | `application/json` |
-| Accept | `application/json` |
-
-## Body Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `order.line_items[].sku` | string | yes | `"MUG-001"` |
-| `order.line_items[].quantity` | integer | yes | `1` |
-| `order.shipping_address.line1` | string | yes | `"1 Analytical Engine Way"` |
-| `order.shipping_address.city` | string | yes | `"London"` |
-| `order.shipping_address.country` | string | yes | `"GB"` \| `"IT"` |
-
-## Example Request
-
-```json
-{
-  "order": {
-    "line_items": [
-      {
-        "sku": "TEA-001",
-        "quantity": 2
-      },
-      {
-        "sku": "MUG-001",
-        "quantity": 1
-      }
-    ],
-    "shipping_address": {
-      "line1": "1 Analytical Engine Way",
-      "city": "London",
-      "country": "GB"
-    }
-  }
-}
-```
-
-## cURL
-
-```bash
-curl --request POST \
-  --url "http://localhost:3000/api/v1/orders" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Content-Type: application/json" \
-  --header "Accept: application/json" \
-  --data '{
-  "order": {
-    "line_items": [
-      {
-        "sku": "TEA-001",
-        "quantity": 2
-      },
-      {
-        "sku": "MUG-001",
-        "quantity": 1
-      }
-    ],
-    "shipping_address": {
-      "line1": "1 Analytical Engine Way",
-      "city": "London",
-      "country": "GB"
-    }
-  }
-}'
-```
-
-## Responses
-
-### 201 Created
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `4` |
-| `status` | string | yes | `"pending"` |
-| `currency` | string | yes | `"USD"` |
-| `total_cents` | integer | yes | `4800` |
-| `line_items[].sku` | string | yes | `"MUG-001"` |
-| `line_items[].name` | string | yes | `"Stoneware Mug"` |
-| `line_items[].quantity` | integer | yes | `1` |
-| `line_items[].unit_price_cents` | integer | yes | `2400` |
-| `line_items[].subtotal_cents` | integer | yes | `2400` |
-| `shipping_address.line1` | string | yes | `"1 Analytical Engine Way"` |
-| `shipping_address.city` | string | yes | `"London"` |
-| `shipping_address.country` | string | yes | `"GB"` \| `"IT"` |
-
-```json
-{
-  "id": 4,
-  "status": "pending",
-  "currency": "USD",
-  "total_cents": 4800,
-  "line_items": [
-    {
-      "sku": "TEA-001",
-      "name": "Earl Grey",
-      "quantity": 2,
-      "unit_price_cents": 1200,
-      "subtotal_cents": 2400
-    },
-    {
-      "sku": "MUG-001",
-      "name": "Stoneware Mug",
-      "quantity": 1,
-      "unit_price_cents": 2400,
-      "subtotal_cents": 2400
-    }
-  ],
-  "shipping_address": {
-    "line1": "1 Analytical Engine Way",
-    "city": "London",
-    "country": "GB"
-  }
-}
-```
-
-### 422 Unprocessable Content
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `errors.sku[]` | string | no | `"TEA-999 is not a known product"` |
-| `errors.line_items[]` | string | no | `"can't be blank"` |
-
-```json
-{
-  "errors": {
-    "sku": [
-      "TEA-999 is not a known product"
-    ]
-  }
-}
-```
-
----
-
-Resource: [Orders](index.md)

data/examples/complex-test-app/docs/api/api/v1/orders/destroy.md

@@ -1,37 +0,0 @@
-# Delete Order
-
-`DELETE /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 DELETE \
-  --url "http://localhost:3000/api/v1/orders/1" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 204 No Content
-
-_No response body._
-
----
-
-Resource: [Orders](index.md)

data/examples/complex-test-app/docs/api/api/v1/orders/index.md

@@ -1,13 +0,0 @@
-# Orders
-
-Namespace: `api/v1`
-
-API version: `v1`
-
-| Method | Path | Description |
-| --- | --- | --- |
-| `GET` | [`/api/v1/orders`](list.md) | List Orders |
-| `POST` | [`/api/v1/orders`](create.md) | Create Order |
-| `DELETE` | [`/api/v1/orders/:id`](destroy.md) | Delete Order |
-| `GET` | [`/api/v1/orders/:id`](show.md) | Get Order |
-| `POST` | [`/api/v1/orders/:id/cancel`](cancel.md) | Cancel Order |

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

@@ -1,71 +0,0 @@
-# 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?status=pending" \
-  --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"` \| `"shipped"` |
-| `[].currency` | string | yes | `"USD"` |
-| `[].total_cents` | integer | yes | `2700` |
-
-```json
-[
-  {
-    "id": 1,
-    "user_id": 1,
-    "status": "pending",
-    "currency": "USD",
-    "total_cents": 2700
-  }
-]
-```
-
-### 401 Unauthorized
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `error` | string | yes | `"Unauthorized"` |
-
-```json
-{
-  "error": "Unauthorized"
-}
-```
-
----
-
-Resource: [Orders](index.md)

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

@@ -1,83 +0,0 @@
-# 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-test-app/docs/api/api/v1/products/index.md

@@ -1,11 +0,0 @@
-# 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-test-app/docs/api/api/v1/products/list.md

@@ -1,83 +0,0 @@
-# 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?filter%5Bcategory%5D=tea" \
-  --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 | `2` |
-
-```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": 2
-  }
-}
-```
-
----
-
-Resource: [Products](index.md)

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

@@ -1,88 +0,0 @@
-# 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)