reqcord 0.1.0 → 0.1.1

data/examples/complex-spec-app/docs/api/api/v1/carts/checkout.md

@@ -0,0 +1,102 @@
+# Checkout Cart
+
+`POST /api/v1/cart/checkout`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Content-Type | `application/json` |
+| Accept | `application/json` |
+
+## Body Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `payment_method` | string | yes | `"bank_transfer"` \| `"card"` |
+
+## Example Request
+
+```json
+{
+  "payment_method": "card"
+}
+```
+
+## cURL
+
+```bash
+curl --request POST \
+  --url "http://localhost:3000/api/v1/cart/checkout" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Content-Type: application/json" \
+  --header "Accept: application/json" \
+  --data '{
+  "payment_method": "card"
+}'
+```
+
+## Responses
+
+### 201 Created
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `5` |
+| `status` | string | yes | `"pending"` |
+| `payment_method` | string | yes | `"bank_transfer"` \| `"card"` |
+| `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` |
+
+```json
+{
+  "id": 5,
+  "status": "pending",
+  "payment_method": "card",
+  "total_cents": 4800,
+  "line_items": [
+    {
+      "sku": "TEA-001",
+      "name": "Earl Grey",
+      "quantity": 2,
+      "unit_price_cents": 1200
+    },
+    {
+      "sku": "MUG-001",
+      "name": "Stoneware Mug",
+      "quantity": 1,
+      "unit_price_cents": 2400
+    }
+  ]
+}
+```
+
+### 422 Unprocessable Content
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `errors.payment_method[]` | string | yes | `"is not included in the list"` |
+
+```json
+{
+  "errors": {
+    "payment_method": [
+      "is not included in the list"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Carts](index.md)

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

@@ -0,0 +1,10 @@
+# Carts
+
+Namespace: `api/v1`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/cart`](show.md) | Get Cart |
+| `POST` | [`/api/v1/cart/checkout`](checkout.md) | Checkout Cart |

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

@@ -0,0 +1,73 @@
+# Get Cart
+
+`GET /api/v1/cart`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Accept | `application/json` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/cart" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `items[].sku` | string | yes | `"MUG-001"` |
+| `items[].name` | string | yes | `"Stoneware Mug"` |
+| `items[].quantity` | integer | yes | `1` |
+| `items[].unit_price_cents` | integer | yes | `2400` |
+| `total_cents` | integer | yes | `4800` |
+
+```json
+{
+  "items": [
+    {
+      "sku": "TEA-001",
+      "name": "Earl Grey",
+      "quantity": 2,
+      "unit_price_cents": 1200
+    },
+    {
+      "sku": "MUG-001",
+      "name": "Stoneware Mug",
+      "quantity": 1,
+      "unit_price_cents": 2400
+    }
+  ],
+  "total_cents": 4800
+}
+```
+
+### 401 Unauthorized
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Unauthorized"` |
+
+```json
+{
+  "error": "Unauthorized"
+}
+```
+
+---
+
+Resource: [Carts](index.md)

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

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

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

@@ -0,0 +1,47 @@
+# Home
+
+`GET /api/v1`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Accept | `application/json` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `name` | string | yes | `"Store API"` |
+| `version` | string | yes | `"v1"` |
+| `links.products` | string | yes | `"/api/v1/products"` |
+| `links.orders` | string | yes | `"/api/v1/orders"` |
+
+```json
+{
+  "name": "Store API",
+  "version": "v1",
+  "links": {
+    "products": "/api/v1/products",
+    "orders": "/api/v1/orders"
+  }
+}
+```
+
+---
+
+Resource: [Home](index.md)

data/examples/complex-spec-app/docs/api/api/v1/notes/create.md

@@ -0,0 +1,94 @@
+# Create Note
+
+`POST /api/v1/orders/:order_id/notes`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Content-Type | `application/json` |
+| Accept | `application/json` |
+
+## Path Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `order_id` | string | yes | `"1"` |
+
+## Body Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `note.body` | string | yes | `"Ring the bell twice"` |
+
+## Example Request
+
+```json
+{
+  "note": {
+    "body": "Ring the bell twice"
+  }
+}
+```
+
+## cURL
+
+```bash
+curl --request POST \
+  --url "http://localhost:3000/api/v1/orders/1/notes" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Content-Type: application/json" \
+  --header "Accept: application/json" \
+  --data '{
+  "note": {
+    "body": "Ring the bell twice"
+  }
+}'
+```
+
+## Responses
+
+### 201 Created
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `3` |
+| `order_id` | integer | yes | `1` |
+| `body` | string | yes | `"Ring the bell twice"` |
+| `author` | string | yes | `"ada"` |
+
+```json
+{
+  "id": 3,
+  "order_id": 1,
+  "body": "Ring the bell twice",
+  "author": "ada"
+}
+```
+
+### 422 Unprocessable Content
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `errors.body[]` | string | yes | `"can't be blank"` |
+
+```json
+{
+  "errors": {
+    "body": [
+      "can't be blank"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Notes](index.md)

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

@@ -0,0 +1,10 @@
+# Notes
+
+Namespace: `api/v1`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/orders/:order_id/notes`](list.md) | List Notes |
+| `POST` | [`/api/v1/orders/:order_id/notes`](create.md) | Create Note |

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

@@ -0,0 +1,61 @@
+# 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-spec-app/docs/api/api/v1/orders/cancel.md

@@ -0,0 +1,69 @@
+# 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-spec-app/docs/api/api/v1/orders/create.md

@@ -0,0 +1,150 @@
+# 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.line_items[]` | string | no | `"can't be blank"` |
+| `errors.sku[]` | string | no | `"TEA-999 is not a known product"` |
+
+```json
+{
+  "errors": {
+    "line_items": [
+      "can't be blank"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Orders](index.md)

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

@@ -0,0 +1,37 @@
+# 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-spec-app/docs/api/api/v1/orders/index.md

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