summaryrefslogtreecommitdiffstats
path: root/fatcat-openapi2.yml
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-06-19 18:30:30 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-06-19 18:30:31 -0700
commitb262ad227ba5293e210f1137e8080be0796a8c86 (patch)
tree36d9cc5f13c1e2dfd27132fd84bc1b0005493ee8 /fatcat-openapi2.yml
parentf0e49dfcf389a099fd5a46c1ee8f7d2b89efeb00 (diff)
downloadfatcat-b262ad227ba5293e210f1137e8080be0796a8c86.tar.gz
fatcat-b262ad227ba5293e210f1137e8080be0796a8c86.zip
add stats API endpoint (freeform)
This intentionally doesn't really have a schema, just an 'extra' JSON object field. If the stats values stabilize we can move from 'extra' to specified values.
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r--fatcat-openapi2.yml24
1 files changed, 23 insertions, 1 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index 44fde1f6..253cec04 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -39,7 +39,6 @@ x-entity-props: &ENTITYPROPS
type: object
additionalProperties: {}
-
definitions:
error_response:
type: object
@@ -312,6 +311,12 @@ definitions:
type: string
role:
type: string
+ stats_response:
+ type: object
+ properties:
+ extra:
+ type: object
+ additionalProperties: {}
x-entity-responses: &ENTITYRESPONSES
400:
@@ -788,3 +793,20 @@ paths:
description: Generic Error
schema:
$ref: "#/definitions/error_response"
+ /stats:
+ get:
+ operationId: "get_stats"
+ parameters:
+ - name: more
+ in: query
+ type: string
+ required: false
+ responses:
+ 200:
+ description: Success
+ schema:
+ $ref: "#/definitions/stats_response"
+ default:
+ description: Generic Error
+ schema:
+ $ref: "#/definitions/error_response"