reqcord 0.1.1 → 0.1.2

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

@@ -1,11 +0,0 @@
-# Customers
-
-Namespace: `api/v1`
-
-API version: `v1`
-
-| Method | Path | Description |
-| --- | --- | --- |
-| `GET` | [`/api/v1/customers`](list.md) | List Customers |
-| `POST` | [`/api/v1/customers`](create.md) | Create Customer |
-| `GET` | [`/api/v1/customers/:id`](show.md) | Get Customer |

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

@@ -1,67 +0,0 @@
-# List Customers
-
-`GET /api/v1/customers`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Authorization | `Bearer {{token}}` |
-| Accept | `application/json` |
-
-## Query Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `per_page` | integer | yes | `1` |
-
-## cURL
-
-```bash
-curl --request GET \
-  --url "http://localhost:3000/api/v1/customers?per_page=1" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `[].id` | integer | yes | `1` |
-| `[].name` | string | yes | `"John Doe"` |
-| `[].email` | string | yes | `"john@example.com"` |
-
-```json
-[
-  {
-    "id": 1,
-    "name": "John Doe",
-    "email": "john@example.com"
-  }
-]
-```
-
-### 401 Unauthorized
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `error` | string | yes | `"Unauthorized"` |
-
-```json
-{
-  "error": "Unauthorized"
-}
-```
-
----
-
-Resource: [Customers](index.md)

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

@@ -1,65 +0,0 @@
-# Get Customer
-
-`GET /api/v1/customers/: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/customers/1" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `1` |
-| `name` | string | yes | `"John Doe"` |
-| `email` | string | yes | `"john@example.com"` |
-
-```json
-{
-  "id": 1,
-  "name": "John Doe",
-  "email": "john@example.com"
-}
-```
-
-### 404 Not Found
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `error` | string | yes | `"Not Found"` |
-
-```json
-{
-  "error": "Not Found"
-}
-```
-
----
-
-Resource: [Customers](index.md)

data/examples/test-app/docs/api/api/v1/tasks/complete.md

@@ -1,51 +0,0 @@
-# Complete Task
-
-`POST /api/v1/tasks/:id/complete`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Accept | `application/json` |
-
-## Path Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | string | yes | `"1"` |
-
-## cURL
-
-```bash
-curl --request POST \
-  --url "http://localhost:3000/api/v1/tasks/1/complete" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `1` |
-| `title` | string | yes | `"Write the docs"` |
-| `status` | string | yes | `"done"` |
-| `priority` | string | yes | `"high"` |
-
-```json
-{
-  "id": 1,
-  "title": "Write the docs",
-  "status": "done",
-  "priority": "high"
-}
-```
-
----
-
-Resource: [Tasks](index.md)

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

@@ -1,90 +0,0 @@
-# Create Task
-
-`POST /api/v1/tasks`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Content-Type | `application/json` |
-| Accept | `application/json` |
-
-## Body Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `task.title` | string | yes | `"Review the release"` |
-| `task.priority` | string | yes | `"high"` \| `"low"` |
-
-## Example Request
-
-```json
-{
-  "task": {
-    "title": "Review the release",
-    "priority": "high"
-  }
-}
-```
-
-## cURL
-
-```bash
-curl --request POST \
-  --url "http://localhost:3000/api/v1/tasks" \
-  --header "Content-Type: application/json" \
-  --header "Accept: application/json" \
-  --data '{
-  "task": {
-    "title": "Review the release",
-    "priority": "high"
-  }
-}'
-```
-
-## Responses
-
-### 201 Created
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `4` |
-| `status` | string | yes | `"open"` |
-| `title` | string | yes | `"Review the release"` |
-| `priority` | string | yes | `"high"` \| `"low"` |
-
-```json
-{
-  "id": 4,
-  "status": "open",
-  "title": "Review the release",
-  "priority": "high"
-}
-```
-
-### 422 Unprocessable Content
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `errors.title[]` | string | no | `"can't be blank"` |
-| `errors.priority[]` | string | no | `"is not included in the list"` |
-
-```json
-{
-  "errors": {
-    "title": [
-      "can't be blank"
-    ]
-  }
-}
-```
-
----
-
-Resource: [Tasks](index.md)

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

@@ -1,35 +0,0 @@
-# Delete Task
-
-`DELETE /api/v1/tasks/:id`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Accept | `application/json` |
-
-## Path Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | string | yes | `"3"` |
-
-## cURL
-
-```bash
-curl --request DELETE \
-  --url "http://localhost:3000/api/v1/tasks/3" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 204 No Content
-
-_No response body._
-
----
-
-Resource: [Tasks](index.md)

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

@@ -1,14 +0,0 @@
-# Tasks
-
-Namespace: `api/v1`
-
-API version: `v1`
-
-| Method | Path | Description |
-| --- | --- | --- |
-| `GET` | [`/api/v1/tasks`](list.md) | List Tasks |
-| `POST` | [`/api/v1/tasks`](create.md) | Create Task |
-| `DELETE` | [`/api/v1/tasks/:id`](destroy.md) | Delete Task |
-| `GET` | [`/api/v1/tasks/:id`](show.md) | Get Task |
-| `PATCH` | [`/api/v1/tasks/:id`](update.md) | Update Task |
-| `POST` | [`/api/v1/tasks/:id/complete`](complete.md) | Complete Task |

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

@@ -1,65 +0,0 @@
-# List Tasks
-
-`GET /api/v1/tasks`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Accept | `application/json` |
-
-## Query Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `status` | string | no | `"done"` \| `"open"` |
-
-## cURL
-
-```bash
-curl --request GET \
-  --url "http://localhost:3000/api/v1/tasks" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `[].id` | integer | yes | `3` |
-| `[].title` | string | yes | `"Tidy the backlog"` |
-| `[].status` | string | yes | `"done"` \| `"open"` |
-| `[].priority` | string | yes | `"high"` \| `"low"` |
-
-```json
-[
-  {
-    "id": 1,
-    "title": "Write the docs",
-    "status": "open",
-    "priority": "high"
-  },
-  {
-    "id": 2,
-    "title": "Ship 0.1.1",
-    "status": "done",
-    "priority": "high"
-  },
-  {
-    "id": 3,
-    "title": "Tidy the backlog",
-    "status": "open",
-    "priority": "low"
-  }
-]
-```
-
----
-
-Resource: [Tasks](index.md)

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

@@ -1,65 +0,0 @@
-# Get Task
-
-`GET /api/v1/tasks/:id`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Accept | `application/json` |
-
-## Path Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | string | yes | `"1"` |
-
-## cURL
-
-```bash
-curl --request GET \
-  --url "http://localhost:3000/api/v1/tasks/1" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `1` |
-| `title` | string | yes | `"Write the docs"` |
-| `status` | string | yes | `"open"` |
-| `priority` | string | yes | `"high"` |
-
-```json
-{
-  "id": 1,
-  "title": "Write the docs",
-  "status": "open",
-  "priority": "high"
-}
-```
-
-### 404 Not Found
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `error` | string | yes | `"Not Found"` |
-
-```json
-{
-  "error": "Not Found"
-}
-```
-
----
-
-Resource: [Tasks](index.md)

data/examples/test-app/docs/api/api/v1/tasks/update.md

@@ -1,74 +0,0 @@
-# Update Task
-
-`PATCH /api/v1/tasks/:id` (also `PUT`)
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Content-Type | `application/json` |
-| Accept | `application/json` |
-
-## Path Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | string | yes | `"1"` |
-
-## Body Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `task.title` | string | yes | `"Write better docs"` |
-
-## Example Request
-
-```json
-{
-  "task": {
-    "title": "Write better docs"
-  }
-}
-```
-
-## cURL
-
-```bash
-curl --request PATCH \
-  --url "http://localhost:3000/api/v1/tasks/1" \
-  --header "Content-Type: application/json" \
-  --header "Accept: application/json" \
-  --data '{
-  "task": {
-    "title": "Write better docs"
-  }
-}'
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `1` |
-| `title` | string | yes | `"Write better docs"` |
-| `status` | string | yes | `"open"` |
-| `priority` | string | yes | `"high"` |
-
-```json
-{
-  "id": 1,
-  "title": "Write better docs",
-  "status": "open",
-  "priority": "high"
-}
-```
-
----
-
-Resource: [Tasks](index.md)

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

@@ -1,95 +0,0 @@
-# Create User
-
-`POST /api/v1/users`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Authorization | `Bearer {{token}}` |
-| Content-Type | `application/json` |
-| Accept | `application/json` |
-
-## Body Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `user.name` | string | yes | `"Ada Lovelace"` |
-| `user.email` | string | yes | `"ada@example.com"` |
-| `user.status` | string | yes | `"active"` \| `"inactive"` |
-
-## Example Request
-
-```json
-{
-  "user": {
-    "name": "Ada Lovelace",
-    "email": "ada@example.com",
-    "status": "active"
-  }
-}
-```
-
-## cURL
-
-```bash
-curl --request POST \
-  --url "http://localhost:3000/api/v1/users" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Content-Type: application/json" \
-  --header "Accept: application/json" \
-  --data '{
-  "user": {
-    "name": "Ada Lovelace",
-    "email": "ada@example.com",
-    "status": "active"
-  }
-}'
-```
-
-## Responses
-
-### 201 Created
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `id` | integer | yes | `3` |
-| `name` | string | yes | `"Ada Lovelace"` |
-| `email` | string | yes | `"ada@example.com"` |
-| `status` | string | yes | `"active"` \| `"inactive"` |
-
-```json
-{
-  "id": 3,
-  "name": "Ada Lovelace",
-  "email": "ada@example.com",
-  "status": "active"
-}
-```
-
-### 422 Unprocessable Content
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `errors.email[]` | string | no | `"can't be blank"` |
-| `errors.status[]` | string | no | `"is not included in the list"` |
-
-```json
-{
-  "errors": {
-    "email": [
-      "can't be blank"
-    ]
-  }
-}
-```
-
----
-
-Resource: [Users](index.md)

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

@@ -1,11 +0,0 @@
-# Users
-
-Namespace: `api/v1`
-
-API version: `v1`
-
-| Method | Path | Description |
-| --- | --- | --- |
-| `GET` | [`/api/v1/users`](list.md) | List Users |
-| `POST` | [`/api/v1/users`](create.md) | Create User |
-| `GET` | [`/api/v1/users/:id`](show.md) | Get User |

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

@@ -1,67 +0,0 @@
-# List Users
-
-`GET /api/v1/users`
-
-Namespace: `api/v1`
-
-## Headers
-
-| Header | Value |
-| --- | --- |
-| Authorization | `Bearer {{token}}` |
-| Accept | `application/json` |
-
-## Query Parameters
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `per_page` | integer | yes | `1` |
-
-## cURL
-
-```bash
-curl --request GET \
-  --url "http://localhost:3000/api/v1/users?per_page=1" \
-  --header "Authorization: Bearer {{token}}" \
-  --header "Accept: application/json"
-```
-
-## Responses
-
-### 200 OK
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `[].id` | integer | yes | `1` |
-| `[].name` | string | yes | `"John Doe"` |
-| `[].email` | string | yes | `"john@example.com"` |
-
-```json
-[
-  {
-    "id": 1,
-    "name": "John Doe",
-    "email": "john@example.com"
-  }
-]
-```
-
-### 401 Unauthorized
-
-#### Fields
-
-| Field | Type | Required | Values |
-| --- | --- | --- | --- |
-| `error` | string | yes | `"Unauthorized"` |
-
-```json
-{
-  "error": "Unauthorized"
-}
-```
-
----
-
-Resource: [Users](index.md)