Skip to content

Commit

Permalink
Update config
Browse files Browse the repository at this point in the history
  • Loading branch information
ajcastro committed Jul 12, 2021
1 parent 3f2a651 commit 0c2c78c
Show file tree
Hide file tree
Showing 18 changed files with 47,976 additions and 3,138 deletions.
4 changes: 2 additions & 2 deletions .scribe/.filehashes
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
# Scribe uses this file to know when you change something manually in your docs.
.scribe/intro.md=c8cb5fa262a4e2884e5c37d0ebead040
.scribe/auth.md=6470d4e160c3f81e40dae7d54d9d09c4
.scribe/intro.md=b10832d12f1d5852442eb62453d05d62
.scribe/auth.md=2c2586f2f50f9f8a5b093893d0dbf373
2 changes: 1 addition & 1 deletion .scribe/auth.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Authenticating requests

Authenticate requests to this API's endpoints by sending an **`Authorization`** header with the value **`"Bearer {YOUR_AUTH_KEY}"`**.
To authenticate requests, include an **`Authorization`** header with the value **`"Bearer {YOUR_AUTH_KEY}"`**.

All authenticated endpoints are marked with a `requires authentication` badge in the documentation below.

Expand Down
100 changes: 67 additions & 33 deletions .scribe/endpoints.cache/1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,40 +8,74 @@ endpoints:
- GET
uri: api/healthcheck
metadata:
title: Healthcheck
description: |-
Check that the service is up. If everything is okay, you'll get a 200 OK response.
Otherwise, the request will fail with a 400 error, and a response listing the failed services.
title: null
description: null
authenticated: false
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- DELETE
uri: 'api/side_projects/{id}'
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters:
id:
name: id
description: 'The ID of the side project.'
required: true
example: 12
type: integer
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- POST
uri: api/nested
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- POST
uri: api/array-body
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- POST
uri: api/file-input
metadata:
title: null
description: null
authenticated: false
headers:
Content-Type: application/json
Accept: application/json
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses:
-
status: 200
content: '{"status":"up","services":{"database":"up","redis":"up"}}'
headers:
cache-control: 'no-cache, private'
content-type: application/json
x-ratelimit-limit: '60'
x-ratelimit-remaining: '56'
access-control-allow-origin: '*'
description: null
-
status: 400
content: '{"status": "down", "services": {"database": "up", "redis": "down"}}'
headers: []
description: '400, Service is unhealthy'
responseFields:
status:
name: status
description: 'The status of this API (`up` or `down`).'
type: string
services:
name: services
description: 'Map of each downstream service and their status (`up` or `down`).'
type: object
responses: []
responseFields: []
253 changes: 197 additions & 56 deletions .scribe/endpoints.cache/2.yaml

Large diffs are not rendered by default.

180 changes: 145 additions & 35 deletions .scribe/endpoints.cache/3.yaml

Large diffs are not rendered by default.

133 changes: 0 additions & 133 deletions .scribe/endpoints.cache/4.yaml

This file was deleted.

100 changes: 67 additions & 33 deletions .scribe/endpoints/1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,74 @@ endpoints:
- GET
uri: api/healthcheck
metadata:
title: Healthcheck
description: |-
Check that the service is up. If everything is okay, you'll get a 200 OK response.
Otherwise, the request will fail with a 400 error, and a response listing the failed services.
title: null
description: null
authenticated: false
headers:
Content-Type: application/json
Accept: application/json
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses:
-
status: 200
content: '{"status":"up","services":{"database":"up","redis":"up"}}'
headers:
cache-control: 'no-cache, private'
content-type: application/json
x-ratelimit-limit: '60'
x-ratelimit-remaining: '56'
access-control-allow-origin: '*'
description: null
-
status: 400
content: '{"status": "down", "services": {"database": "up", "redis": "down"}}'
headers: []
description: '400, Service is unhealthy'
responseFields:
status:
name: status
description: 'The status of this API (`up` or `down`).'
type: string
services:
name: services
description: 'Map of each downstream service and their status (`up` or `down`).'
type: object
responses: []
responseFields: []
-
httpMethods:
- DELETE
uri: 'api/side_projects/{id}'
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters:
id:
name: id
description: 'The ID of the side project.'
required: true
example: 12
type: integer
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- POST
uri: api/nested
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- POST
uri: api/array-body
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
-
httpMethods:
- POST
uri: api/file-input
metadata:
title: null
description: null
authenticated: false
headers: []
urlParameters: []
queryParameters: []
bodyParameters: []
responses: []
responseFields: []
253 changes: 197 additions & 56 deletions .scribe/endpoints/2.yaml

Large diffs are not rendered by default.

Loading

0 comments on commit 0c2c78c

Please sign in to comment.