reqcord 0.1.1 → 0.1.2

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

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

@@ -1,10 +0,0 @@
-# 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-test-app/docs/api/api/v1/profiles/show.md

@@ -1,61 +0,0 @@
-# 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-test-app/docs/api/api/v1/profiles/update.md

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

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

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

@@ -1,77 +0,0 @@
-# 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?cursor=eyJpZCI6Mn0" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `items[].id` | integer | yes | `4` |
-| `items[].sku` | string | yes | `"MUG-002"` |
-| `items[].name` | string | yes | `"Travel Mug"` |
-| `items[].category` | string | yes | `"mugs"` \| `"tea"` |
-| `items[].price_cents` | integer | yes | `3200` |
-| `items[].tags[]` | string | yes | `"green"` \| `"insulated"` |
-| `items[].price` | string | yes | `"32.00"` |
-| `next_cursor` | null | string | yes | `"eyJpZCI6Mn0"` |
-
-```json
-{
-  "items": [
-    {
-      "id": 3,
-      "sku": "MUG-001",
-      "name": "Stoneware Mug",
-      "category": "mugs",
-      "price_cents": 2400,
-      "tags": [
-        "ceramic"
-      ],
-      "price": "24.00"
-    },
-    {
-      "id": 4,
-      "sku": "MUG-002",
-      "name": "Travel Mug",
-      "category": "mugs",
-      "price_cents": 3200,
-      "tags": [
-        "steel",
-        "insulated"
-      ],
-      "price": "32.00"
-    }
-  ],
-  "next_cursor": null
-}
-```
-
----
-
-Resource: [Products](index.md)

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

@@ -1,18 +0,0 @@
-#!/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-test-app/docs/api/curl/api/v1/admin/products/destroy.sh

@@ -1,9 +0,0 @@
-#!/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-test-app/docs/api/curl/api/v1/admin/products/list.sh

@@ -1,9 +0,0 @@
-#!/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"

data/examples/complex-test-app/docs/api/curl/api/v1/auth/login.sh

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Login
-# POST /api/v1/auth/login
-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'

data/examples/complex-test-app/docs/api/curl/api/v1/cart-items/create.sh

@@ -1,16 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Create Cart Item
-# POST /api/v1/cart/items
-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
-  }
-}'

data/examples/complex-test-app/docs/api/curl/api/v1/cart-items/destroy.sh

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Delete Cart Item
-# DELETE /api/v1/cart/items/:sku
-curl --request DELETE \
-  --url "http://localhost:3000/api/v1/cart/items/TEA-001" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

data/examples/complex-test-app/docs/api/curl/api/v1/carts/checkout.sh

@@ -1,13 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Checkout Cart
-# POST /api/v1/cart/checkout
-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"
-}'

data/examples/complex-test-app/docs/api/curl/api/v1/carts/show.sh

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Get Cart
-# GET /api/v1/cart
-curl --request GET \
-  --url "http://localhost:3000/api/v1/cart" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

data/examples/complex-test-app/docs/api/curl/api/v1/home/list.sh

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Home
-# GET /api/v1
-curl --request GET \
-  --url "http://localhost:3000/api/v1" \
-  --header "Accept: application/json"

data/examples/complex-test-app/docs/api/curl/api/v1/notes/create.sh

@@ -1,15 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Create Note
-# POST /api/v1/orders/:order_id/notes
-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"
-  }
-}'

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

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# List Notes
-# GET /api/v1/orders/:order_id/notes
-curl --request GET \
-  --url "http://localhost:3000/api/v1/orders/1/notes" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

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

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Cancel Order
-# POST /api/v1/orders/:id/cancel
-curl --request POST \
-  --url "http://localhost:3000/api/v1/orders/1/cancel" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

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

@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Create Order
-# POST /api/v1/orders
-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"
-    }
-  }
-}'

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

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Delete Order
-# DELETE /api/v1/orders/:id
-curl --request DELETE \
-  --url "http://localhost:3000/api/v1/orders/1" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

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

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# List Orders
-# GET /api/v1/orders
-curl --request GET \
-  --url "http://localhost:3000/api/v1/orders?status=pending" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

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

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Get Order
-# GET /api/v1/orders/:id
-curl --request GET \
-  --url "http://localhost:3000/api/v1/orders/1" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

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

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# List Products
-# GET /api/v1/products
-curl --request GET \
-  --url "http://localhost:3000/api/v1/products?filter%5Bcategory%5D=tea" \
-  --header "Accept: application/json"

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

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Search Products
-# GET /api/v1/products/search
-curl --request GET \
-  --url "http://localhost:3000/api/v1/products/search?q=mug" \
-  --header "Accept: application/json"

data/examples/complex-test-app/docs/api/curl/api/v1/products/show.sh

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Get Product
-# GET /api/v1/products/:id
-curl --request GET \
-  --url "http://localhost:3000/api/v1/products/3" \
-  --header "Accept: application/json"

data/examples/complex-test-app/docs/api/curl/api/v1/profiles/show.sh

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Get Profile
-# GET /api/v1/profile
-curl --request GET \
-  --url "http://localhost:3000/api/v1/profile" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"

data/examples/complex-test-app/docs/api/curl/api/v1/profiles/update.sh

@@ -1,16 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# Update Profile
-# PATCH /api/v1/profile
-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"
-  }
-}'

data/examples/complex-test-app/docs/api/curl/api/v2/products/list.sh

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-
-# List Products
-# GET /api/v2/products
-curl --request GET \
-  --url "http://localhost:3000/api/v2/products?cursor=eyJpZCI6Mn0" \
-  --header "Accept: application/json"