aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-12-26 15:14:45 -0800
committerBryan Newbold <bnewbold@robocracy.org>2018-12-26 15:14:45 -0800
commit9d889483310d285da763b17e6ac756a417777df6 (patch)
tree2f83e9905b01939e8f26a12e58fe61c52c602675
parentcfd608f96c16771f4bbfc35c7ad0620e0cb86d65 (diff)
downloadfatcat-9d889483310d285da763b17e6ac756a417777df6.tar.gz
fatcat-9d889483310d285da763b17e6ac756a417777df6.zip
openapi schema: small consistency fixes
-rw-r--r--fatcat-openapi2.yml34
1 files changed, 26 insertions, 8 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index 4228daac..d272475b 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -220,7 +220,7 @@ definitions:
rel:
type: string
example: "webarchive"
- releases:
+ release_ids:
type: array
items:
type: string
@@ -251,13 +251,13 @@ definitions:
url:
type: string
example: "http://www.asheesh.org:80/APUS/ch1/node15.html"
+ mimetype:
+ type: string
+ example: "text/html"
status_code:
type: integer
example: 200
format: int64
- mimetype:
- type: string
- example: "text/html"
sha1:
type: string
#format: custom
@@ -284,11 +284,11 @@ definitions:
original_url:
type: string
#format: url
- example: "http://www.asheesh.org"
+ example: "http://asheesh.org"
timestamp:
type: string
format: date-time
- releases:
+ release_ids:
type: array
items:
type: string
@@ -312,6 +312,16 @@ definitions:
type: array
items:
$ref: "#/definitions/file_entity"
+ filesets:
+ description: "Optional; GET-only"
+ type: array
+ items:
+ $ref: "#/definitions/fileset_entity"
+ webcaptures:
+ description: "Optional; GET-only"
+ type: array
+ items:
+ $ref: "#/definitions/webcapture_entity"
container_id:
type: string
example: "q3nouwy3nnbsvo3h5klxsx4a7y"
@@ -470,6 +480,14 @@ definitions:
type: array
items:
$ref: "#/definitions/entity_edit"
+ filesets:
+ type: array
+ items:
+ $ref: "#/definitions/entity_edit"
+ webcaptures:
+ type: array
+ items:
+ $ref: "#/definitions/entity_edit"
releases:
type: array
items:
@@ -976,7 +994,7 @@ paths:
in: query
type: string
required: false
- description: "List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid."
+ description: "List of entity fields to elide in response. For creators, none implemented yet."
get:
operationId: "get_creator_releases"
tags: # TAGLINE
@@ -1801,7 +1819,7 @@ paths:
in: query
type: string
required: false
- description: "List of entity fields to elide in response. For releases, 'abstracts', 'refs', and 'contribs' are valid."
+ description: "List of entity fields to elide in response. For works, none implemented yet."
get:
operationId: "get_work_releases"
tags: # TAGLINE