reqcord 0.1.0 → 0.1.1

data/examples/complex-spec-app/docs/api/README.md

@@ -0,0 +1,104 @@
+# API Documentation
+
+Generated by Reqcord from the application's integration tests.
+
+Base URL: `http://localhost:3000`
+
+## Placeholders
+
+| Header | Replace with |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| X-Api-Key | `{{api_key}}` |
+
+## Products
+
+Namespace: `api/v1/admin`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/admin/products`](api/v1/admin/products/list.md) | List Products |
+| `POST` | [`/api/v1/admin/products`](api/v1/admin/products/create.md) | Create Product |
+| `DELETE` | [`/api/v1/admin/products/:id`](api/v1/admin/products/destroy.md) | Delete Product |
+
+## Auth
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `POST` | [`/api/v1/auth/login`](api/v1/auth/login.md) | Login |
+
+## Cart Items
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `POST` | [`/api/v1/cart/items`](api/v1/cart-items/create.md) | Create Cart Item |
+| `DELETE` | [`/api/v1/cart/items/:sku`](api/v1/cart-items/destroy.md) | Delete Cart Item |
+
+## Carts
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/cart`](api/v1/carts/show.md) | Get Cart |
+| `POST` | [`/api/v1/cart/checkout`](api/v1/carts/checkout.md) | Checkout Cart |
+
+## Home
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1`](api/v1/home/list.md) | Home |
+
+## Notes
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/orders/:order_id/notes`](api/v1/notes/list.md) | List Notes |
+| `POST` | [`/api/v1/orders/:order_id/notes`](api/v1/notes/create.md) | Create Note |
+
+## Orders
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/orders`](api/v1/orders/list.md) | List Orders |
+| `POST` | [`/api/v1/orders`](api/v1/orders/create.md) | Create Order |
+| `DELETE` | [`/api/v1/orders/:id`](api/v1/orders/destroy.md) | Delete Order |
+| `GET` | [`/api/v1/orders/:id`](api/v1/orders/show.md) | Get Order |
+| `POST` | [`/api/v1/orders/:id/cancel`](api/v1/orders/cancel.md) | Cancel Order |
+
+## Products
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/products`](api/v1/products/list.md) | List Products |
+| `GET` | [`/api/v1/products/:id`](api/v1/products/show.md) | Get Product |
+| `GET` | [`/api/v1/products/search`](api/v1/products/search.md) | Search Products |
+
+## Profiles
+
+Namespace: `api/v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/profile`](api/v1/profiles/show.md) | Get Profile |
+| `PATCH` | [`/api/v1/profile`](api/v1/profiles/update.md) | Update Profile |
+
+## Products
+
+Namespace: `api/v2`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v2/products`](api/v2/products/list.md) | List Products |

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

@@ -0,0 +1,117 @@
+# Create Product
+
+`POST /api/v1/admin/products`
+
+Namespace: `api/v1/admin`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| X-Api-Key | `{{api_key}}` |
+| Content-Type | `application/json` |
+| Accept | `application/json` |
+
+## Body Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `product.sku` | string | yes | `"TEA-003"` |
+| `product.name` | string | yes | `"Jasmine"` |
+| `product.category` | string | yes | `"tea"` |
+| `product.price_cents` | integer | yes | `1400` |
+
+## Example Request
+
+```json
+{
+  "product": {
+    "sku": "TEA-003",
+    "name": "Jasmine",
+    "category": "tea",
+    "price_cents": 1400
+  }
+}
+```
+
+## cURL
+
+```bash
+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
+  }
+}'
+```
+
+## Responses
+
+### 201 Created
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | integer | yes | `5` |
+| `cost_cents` | integer | yes | `0` |
+| `tags` | array | yes | - |
+| `sku` | string | yes | `"TEA-003"` |
+| `name` | string | yes | `"Jasmine"` |
+| `category` | string | yes | `"tea"` |
+| `price_cents` | integer | yes | `1400` |
+
+```json
+{
+  "id": 5,
+  "cost_cents": 0,
+  "tags": [],
+  "sku": "TEA-003",
+  "name": "Jasmine",
+  "category": "tea",
+  "price_cents": 1400
+}
+```
+
+### 409 Conflict
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"sku TEA-001 already exists"` |
+
+```json
+{
+  "error": "sku TEA-001 already exists"
+}
+```
+
+### 422 Unprocessable Content
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `errors.sku[]` | string | yes | `"can't be blank"` |
+
+```json
+{
+  "errors": {
+    "sku": [
+      "can't be blank"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Products](index.md)

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

@@ -0,0 +1,51 @@
+# Delete Product
+
+`DELETE /api/v1/admin/products/:id`
+
+Namespace: `api/v1/admin`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| X-Api-Key | `{{api_key}}` |
+| Accept | `application/json` |
+
+## Path Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `id` | string | yes | `"4"` |
+
+## cURL
+
+```bash
+curl --request DELETE \
+  --url "http://localhost:3000/api/v1/admin/products/4" \
+  --header "X-Api-Key: {{api_key}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 204 No Content
+
+_No response body._
+
+### 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/admin/products/index.md

@@ -0,0 +1,11 @@
+# Products
+
+Namespace: `api/v1/admin`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `GET` | [`/api/v1/admin/products`](list.md) | List Products |
+| `POST` | [`/api/v1/admin/products`](create.md) | Create Product |
+| `DELETE` | [`/api/v1/admin/products/:id`](destroy.md) | Delete Product |

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

@@ -0,0 +1,106 @@
+# List Products
+
+`GET /api/v1/admin/products`
+
+Namespace: `api/v1/admin`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| X-Api-Key | `{{api_key}}` |
+| Accept | `application/json` |
+
+## cURL
+
+```bash
+curl --request GET \
+  --url "http://localhost:3000/api/v1/admin/products" \
+  --header "X-Api-Key: {{api_key}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `[].id` | integer | yes | `4` |
+| `[].sku` | string | yes | `"MUG-002"` |
+| `[].name` | string | yes | `"Travel Mug"` |
+| `[].category` | string | yes | `"mugs"` |
+| `[].price_cents` | integer | yes | `3200` |
+| `[].cost_cents` | integer | yes | `1400` |
+| `[].tags[]` | string | yes | `"insulated"` |
+
+```json
+[
+  {
+    "id": 1,
+    "sku": "TEA-001",
+    "name": "Earl Grey",
+    "category": "tea",
+    "price_cents": 1200,
+    "cost_cents": 500,
+    "tags": [
+      "black",
+      "bergamot"
+    ]
+  },
+  {
+    "id": 2,
+    "sku": "TEA-002",
+    "name": "Sencha",
+    "category": "tea",
+    "price_cents": 1500,
+    "cost_cents": 700,
+    "tags": [
+      "green"
+    ]
+  },
+  {
+    "id": 3,
+    "sku": "MUG-001",
+    "name": "Stoneware Mug",
+    "category": "mugs",
+    "price_cents": 2400,
+    "cost_cents": 900,
+    "tags": [
+      "ceramic"
+    ]
+  },
+  {
+    "id": 4,
+    "sku": "MUG-002",
+    "name": "Travel Mug",
+    "category": "mugs",
+    "price_cents": 3200,
+    "cost_cents": 1400,
+    "tags": [
+      "steel",
+      "insulated"
+    ]
+  }
+]
+```
+
+### 401 Unauthorized
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"API key required"` |
+
+```json
+{
+  "error": "API key required"
+}
+```
+
+---
+
+Resource: [Products](index.md)

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

@@ -0,0 +1,9 @@
+# Auth
+
+Namespace: `api/v1`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `POST` | [`/api/v1/auth/login`](login.md) | Login |

data/examples/complex-spec-app/docs/api/api/v1/auth/login.md

@@ -0,0 +1,76 @@
+# Login
+
+`POST /api/v1/auth/login`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Content-Type | `application/x-www-form-urlencoded` |
+
+## Body Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `email` | string | yes | `"ada@example.com"` |
+| `password` | string | yes | `"{{password}}"` |
+
+## Example Request
+
+Sent as `application/x-www-form-urlencoded`; the cURL below carries it in that encoding.
+
+```json
+{
+  "email": "ada@example.com",
+  "password": "{{password}}"
+}
+```
+
+## cURL
+
+```bash
+curl --request POST \
+  --url "http://localhost:3000/api/v1/auth/login" \
+  --header "Content-Type: application/x-www-form-urlencoded" \
+  --data 'email=ada%40example.com&password=%7B%7Bpassword%7D%7D'
+```
+
+## Responses
+
+### 200 OK
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `token` | string | yes | `"{{token}}"` |
+| `token_type` | string | yes | `"Bearer"` |
+| `expires_in` | integer | yes | `3600` |
+
+```json
+{
+  "token": "{{token}}",
+  "token_type": "Bearer",
+  "expires_in": 3600
+}
+```
+
+### 401 Unauthorized
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Invalid email or password"` |
+
+```json
+{
+  "error": "Invalid email or password"
+}
+```
+
+---
+
+Resource: [Auth](index.md)

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

@@ -0,0 +1,91 @@
+# Create Cart Item
+
+`POST /api/v1/cart/items`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Content-Type | `application/json` |
+| Accept | `application/json` |
+
+## Body Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `item.sku` | string | yes | `"TEA-002"` |
+| `item.quantity` | integer | yes | `3` |
+
+## Example Request
+
+```json
+{
+  "item": {
+    "sku": "TEA-002",
+    "quantity": 3
+  }
+}
+```
+
+## cURL
+
+```bash
+curl --request POST \
+  --url "http://localhost:3000/api/v1/cart/items" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Content-Type: application/json" \
+  --header "Accept: application/json" \
+  --data '{
+  "item": {
+    "sku": "TEA-002",
+    "quantity": 3
+  }
+}'
+```
+
+## Responses
+
+### 201 Created
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `sku` | string | yes | `"TEA-002"` |
+| `name` | string | yes | `"Sencha"` |
+| `quantity` | integer | yes | `3` |
+| `unit_price_cents` | integer | yes | `1500` |
+
+```json
+{
+  "sku": "TEA-002",
+  "name": "Sencha",
+  "quantity": 3,
+  "unit_price_cents": 1500
+}
+```
+
+### 422 Unprocessable Content
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `errors.sku[]` | string | yes | `"TEA-999 is not a known product"` |
+
+```json
+{
+  "errors": {
+    "sku": [
+      "TEA-999 is not a known product"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Cart Items](index.md)

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

@@ -0,0 +1,51 @@
+# Delete Cart Item
+
+`DELETE /api/v1/cart/items/:sku`
+
+Namespace: `api/v1`
+
+## Headers
+
+| Header | Value |
+| --- | --- |
+| Authorization | `Bearer {{token}}` |
+| Accept | `application/json` |
+
+## Path Parameters
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `sku` | string | yes | `"TEA-001"` |
+
+## cURL
+
+```bash
+curl --request DELETE \
+  --url "http://localhost:3000/api/v1/cart/items/TEA-001" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Accept: application/json"
+```
+
+## Responses
+
+### 204 No Content
+
+_No response body._
+
+### 404 Not Found
+
+#### Fields
+
+| Field | Type | Required | Values |
+| --- | --- | --- | --- |
+| `error` | string | yes | `"Not Found"` |
+
+```json
+{
+  "error": "Not Found"
+}
+```
+
+---
+
+Resource: [Cart Items](index.md)

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

@@ -0,0 +1,10 @@
+# Cart Items
+
+Namespace: `api/v1`
+
+API version: `v1`
+
+| Method | Path | Description |
+| --- | --- | --- |
+| `POST` | [`/api/v1/cart/items`](create.md) | Create Cart Item |
+| `DELETE` | [`/api/v1/cart/items/:sku`](destroy.md) | Delete Cart Item |