reqcord 0.1.0 → 0.1.1

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

@@ -0,0 +1,65 @@
+# 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/spec-app/docs/api/api/v1/tasks/show.md

@@ -0,0 +1,65 @@
+# 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/spec-app/docs/api/api/v1/tasks/update.md

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

@@ -0,0 +1,95 @@
+# 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.status[]` | string | no | `"is not included in the list"` |
+| `errors.email[]` | string | no | `"can't be blank"` |
+
+```json
+{
+  "errors": {
+    "status": [
+      "is not included in the list"
+    ]
+  }
+}
+```
+
+---
+
+Resource: [Users](index.md)

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

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

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

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

@@ -0,0 +1,65 @@
+# Get User
+
+`GET /api/v1/users/: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/users/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: [Users](index.md)

data/examples/spec-app/docs/api/curl/api/v1/customers/create.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Create Customer
+# POST /api/v1/customers
+curl --request POST \
+  --url "http://localhost:3000/api/v1/customers" \
+  --header "Authorization: Bearer {{token}}" \
+  --header "Content-Type: application/json" \
+  --header "Accept: application/json" \
+  --data '{
+  "customer": {
+    "name": "Ada Lovelace",
+    "email": "ada@example.com",
+    "status": "active"
+  }
+}'

data/examples/spec-app/docs/api/curl/api/v1/customers/list.sh

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

data/examples/spec-app/docs/api/curl/api/v1/customers/show.sh

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

data/examples/spec-app/docs/api/curl/api/v1/tasks/complete.sh

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

data/examples/spec-app/docs/api/curl/api/v1/tasks/create.sh

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

data/examples/spec-app/docs/api/curl/api/v1/tasks/destroy.sh

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

data/examples/spec-app/docs/api/curl/api/v1/tasks/list.sh

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

data/examples/spec-app/docs/api/curl/api/v1/tasks/show.sh

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

data/examples/spec-app/docs/api/curl/api/v1/tasks/update.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Update Task
+# PATCH /api/v1/tasks/:id
+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"
+  }
+}'

data/examples/spec-app/docs/api/curl/api/v1/users/create.sh

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

data/examples/spec-app/docs/api/curl/api/v1/users/list.sh

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

data/examples/spec-app/docs/api/curl/api/v1/users/show.sh

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