summaryrefslogtreecommitdiffstats
path: root/rust/fatcat-api/api.yaml
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@robocracy.org>2018-06-04 00:19:36 -0700
committerBryan Newbold <bnewbold@robocracy.org>2018-06-04 00:19:36 -0700
commit0ec7c973417f5d120db80d1c1dd3e329711a1ca4 (patch)
tree194c0ca49f13db09cb07f0a640edcd6430c61587 /rust/fatcat-api/api.yaml
parent09c8fffe9fbf94a3004b5dda5dd9e50496591ad6 (diff)
downloadfatcat-0ec7c973417f5d120db80d1c1dd3e329711a1ca4.tar.gz
fatcat-0ec7c973417f5d120db80d1c1dd3e329711a1ca4.zip
update rust/api for schema extensions
Diffstat (limited to 'rust/fatcat-api/api.yaml')
-rw-r--r--rust/fatcat-api/api.yaml50
1 files changed, 39 insertions, 11 deletions
diff --git a/rust/fatcat-api/api.yaml b/rust/fatcat-api/api.yaml
index 8ced937d..c53ff4a7 100644
--- a/rust/fatcat-api/api.yaml
+++ b/rust/fatcat-api/api.yaml
@@ -22,7 +22,7 @@ x-entity-props: &ENTITYPROPS
ident:
type: string
#format: uuid
- example: "f1f046a3-45c9-4b99-adce-000000000001"
+ example: "00000000-0000-0000-adce-000000000001"
revision:
type: integer
example: 42
@@ -30,7 +30,7 @@ x-entity-props: &ENTITYPROPS
redirect:
type: string
#format: uuid
- example: "f1f046a3-45c9-4b99-adce-000000000002"
+ example: "00000000-0000-0000-adce-000000000002"
editgroup_id:
type: integer
example: 16
@@ -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:
@@ -126,14 +137,17 @@ definitions:
type: string
work_id:
type: string
- example: "f1f046a3-45c9-4b99-adce-000000000001"
+ example: "00000000-0000-0000-adce-000000000001"
container_id:
type: string
- example: "f1f046a3-45c9-4b99-adce-000000000001"
+ 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:
@@ -179,14 +195,14 @@ definitions:
format: int64
ident:
type: string
- example: "f1f046a3-45c9-4b99-adce-000000000001"
+ example: "00000000-0000-0000-adce-000000000001"
revision:
type: integer
example: 42
format: int64
redirect_ident:
type: string
- example: "f1f046a3-45c9-4b99-adce-000000000002"
+ example: "00000000-0000-0000-adce-000000000002"
#format: uuid
editgroup_id:
type: integer
@@ -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