aboutsummaryrefslogtreecommitdiffstats
path: root/fatcat-openapi2.yml
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-06-03 23:54:54 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-06-04 00:19:15 -0700
commit09c8fffe9fbf94a3004b5dda5dd9e50496591ad6 (patch)
treebced6f77377b812c25695e4be3047e09d3a63890 /fatcat-openapi2.yml
parent733962480b4ee084bb9e019351143a9181d2cbc2 (diff)
downloadfatcat-09c8fffe9fbf94a3004b5dda5dd9e50496591ad6.tar.gz
fatcat-09c8fffe9fbf94a3004b5dda5dd9e50496591ad6.zip
updates to schema(s): more complete, alignment
Diffstat (limited to 'fatcat-openapi2.yml')
-rw-r--r--fatcat-openapi2.yml38
1 files changed, 33 insertions, 5 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml
index a981cc44..c53ff4a7 100644
--- a/fatcat-openapi2.yml
+++ b/fatcat-openapi2.yml
@@ -80,12 +80,16 @@ definitions:
creator_entity:
type: object
required:
- - full_name
+ - display_name
properties:
<<: *ENTITYPROPS
- full_name:
+ display_name:
type: string
example: "Grace Hopper"
+ given_name:
+ type: string
+ surname:
+ type: string
orcid:
type: string
#format: custom
@@ -106,10 +110,17 @@ definitions:
type: string
#format: custom
example: "d41efcc592d1e40ac13905377399eb9b"
+ sha256:
+ type: string
+ #format: custom
+ example: "a77e4c11a57f1d757fca5754a8f83b5d4ece49a2d28596889127c1a2f3f28832"
url:
type: string
format: url
example: "https://example.edu/~frau/prcding.pdf"
+ mimetype:
+ type: string
+ example: "application/pdf"
releases:
type: array
items:
@@ -132,8 +143,11 @@ definitions:
example: "00000000-0000-0000-adce-000000000001"
release_type:
type: string
+ example: "book"
+ release_status:
+ type: string
example: "preprint"
- date:
+ release_date:
type: string
format: date
doi:
@@ -152,6 +166,8 @@ definitions:
example: "12"
publisher:
type: string
+ language:
+ type: string
contribs:
type: array
items:
@@ -269,8 +285,20 @@ definitions:
target_release_id:
type: string
#format: uuid
- stub:
+ raw:
+ type: string
+ key:
+ type: string
+ year:
+ type: integer
+ format: int64
+ container_title:
+ type: string
+ title:
+ type: string
+ locator:
type: string
+ example: "p123"
release_contrib:
type: object
properties:
@@ -280,7 +308,7 @@ definitions:
creator_id:
type: string
#format: uuid
- creator_stub:
+ raw:
type: string
role:
type: string