Skip to content

Commit 0c2c78c

Browse files
ajcastroajcastro
committed
Update config
1 parent 3f2a651 commit 0c2c78c

File tree

18 files changed

+47976
-3138
lines changed

18 files changed

+47976
-3138
lines changed

‎.scribe/.filehashes‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
22
# Scribe uses this file to know when you change something manually in your docs.
3-
.scribe/intro.md=c8cb5fa262a4e2884e5c37d0ebead040
4-
.scribe/auth.md=6470d4e160c3f81e40dae7d54d9d09c4
3+
.scribe/intro.md=b10832d12f1d5852442eb62453d05d62
4+
.scribe/auth.md=2c2586f2f50f9f8a5b093893d0dbf373

‎.scribe/auth.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Authenticating requests
22

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

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

‎.scribe/endpoints.cache/1.yaml‎

Lines changed: 67 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,74 @@ endpoints:
88
- GET
99
uri: api/healthcheck
1010
metadata:
11-
title: Healthcheck
12-
description: |-
13-
Check that the service is up. If everything is okay, you'll get a 200 OK response.
14-
15-
Otherwise, the request will fail with a 400 error, and a response listing the failed services.
11+
title: null
12+
description: null
13+
authenticated: false
14+
headers: []
15+
urlParameters: []
16+
queryParameters: []
17+
bodyParameters: []
18+
responses: []
19+
responseFields: []
20+
-
21+
httpMethods:
22+
- DELETE
23+
uri: 'api/side_projects/{id}'
24+
metadata:
25+
title: null
26+
description: null
27+
authenticated: false
28+
headers: []
29+
urlParameters:
30+
id:
31+
name: id
32+
description: 'The ID of the side project.'
33+
required: true
34+
example: 12
35+
type: integer
36+
queryParameters: []
37+
bodyParameters: []
38+
responses: []
39+
responseFields: []
40+
-
41+
httpMethods:
42+
- POST
43+
uri: api/nested
44+
metadata:
45+
title: null
46+
description: null
47+
authenticated: false
48+
headers: []
49+
urlParameters: []
50+
queryParameters: []
51+
bodyParameters: []
52+
responses: []
53+
responseFields: []
54+
-
55+
httpMethods:
56+
- POST
57+
uri: api/array-body
58+
metadata:
59+
title: null
60+
description: null
61+
authenticated: false
62+
headers: []
63+
urlParameters: []
64+
queryParameters: []
65+
bodyParameters: []
66+
responses: []
67+
responseFields: []
68+
-
69+
httpMethods:
70+
- POST
71+
uri: api/file-input
72+
metadata:
73+
title: null
74+
description: null
1675
authenticated: false
17-
headers:
18-
Content-Type: application/json
19-
Accept: application/json
76+
headers: []
2077
urlParameters: []
2178
queryParameters: []
2279
bodyParameters: []
23-
responses:
24-
-
25-
status: 200
26-
content: '{"status":"up","services":{"database":"up","redis":"up"}}'
27-
headers:
28-
cache-control: 'no-cache, private'
29-
content-type: application/json
30-
x-ratelimit-limit: '60'
31-
x-ratelimit-remaining: '56'
32-
access-control-allow-origin: '*'
33-
description: null
34-
-
35-
status: 400
36-
content: '{"status": "down", "services": {"database": "up", "redis": "down"}}'
37-
headers: []
38-
description: '400, Service is unhealthy'
39-
responseFields:
40-
status:
41-
name: status
42-
description: 'The status of this API (`up` or `down`).'
43-
type: string
44-
services:
45-
name: services
46-
description: 'Map of each downstream service and their status (`up` or `down`).'
47-
type: object
80+
responses: []
81+
responseFields: []

‎.scribe/endpoints.cache/2.yaml‎

Lines changed: 197 additions & 56 deletions
Large diffs are not rendered by default.

‎.scribe/endpoints.cache/3.yaml‎

Lines changed: 145 additions & 35 deletions
Large diffs are not rendered by default.

‎.scribe/endpoints.cache/4.yaml‎

Lines changed: 0 additions & 133 deletions
This file was deleted.

‎.scribe/endpoints/1.yaml‎

Lines changed: 67 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,40 +6,74 @@ endpoints:
66
- GET
77
uri: api/healthcheck
88
metadata:
9-
title: Healthcheck
10-
description: |-
11-
Check that the service is up. If everything is okay, you'll get a 200 OK response.
12-
13-
Otherwise, the request will fail with a 400 error, and a response listing the failed services.
9+
title: null
10+
description: null
1411
authenticated: false
15-
headers:
16-
Content-Type: application/json
17-
Accept: application/json
12+
headers: []
1813
urlParameters: []
1914
queryParameters: []
2015
bodyParameters: []
21-
responses:
22-
-
23-
status: 200
24-
content: '{"status":"up","services":{"database":"up","redis":"up"}}'
25-
headers:
26-
cache-control: 'no-cache, private'
27-
content-type: application/json
28-
x-ratelimit-limit: '60'
29-
x-ratelimit-remaining: '56'
30-
access-control-allow-origin: '*'
31-
description: null
32-
-
33-
status: 400
34-
content: '{"status": "down", "services": {"database": "up", "redis": "down"}}'
35-
headers: []
36-
description: '400, Service is unhealthy'
37-
responseFields:
38-
status:
39-
name: status
40-
description: 'The status of this API (`up` or `down`).'
41-
type: string
42-
services:
43-
name: services
44-
description: 'Map of each downstream service and their status (`up` or `down`).'
45-
type: object
16+
responses: []
17+
responseFields: []
18+
-
19+
httpMethods:
20+
- DELETE
21+
uri: 'api/side_projects/{id}'
22+
metadata:
23+
title: null
24+
description: null
25+
authenticated: false
26+
headers: []
27+
urlParameters:
28+
id:
29+
name: id
30+
description: 'The ID of the side project.'
31+
required: true
32+
example: 12
33+
type: integer
34+
queryParameters: []
35+
bodyParameters: []
36+
responses: []
37+
responseFields: []
38+
-
39+
httpMethods:
40+
- POST
41+
uri: api/nested
42+
metadata:
43+
title: null
44+
description: null
45+
authenticated: false
46+
headers: []
47+
urlParameters: []
48+
queryParameters: []
49+
bodyParameters: []
50+
responses: []
51+
responseFields: []
52+
-
53+
httpMethods:
54+
- POST
55+
uri: api/array-body
56+
metadata:
57+
title: null
58+
description: null
59+
authenticated: false
60+
headers: []
61+
urlParameters: []
62+
queryParameters: []
63+
bodyParameters: []
64+
responses: []
65+
responseFields: []
66+
-
67+
httpMethods:
68+
- POST
69+
uri: api/file-input
70+
metadata:
71+
title: null
72+
description: null
73+
authenticated: false
74+
headers: []
75+
urlParameters: []
76+
queryParameters: []
77+
bodyParameters: []
78+
responses: []
79+
responseFields: []

‎.scribe/endpoints/2.yaml‎

Lines changed: 197 additions & 56 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)