diff options
Diffstat (limited to 'rust/fatcat-api-spec/api.yaml')
| -rw-r--r-- | rust/fatcat-api-spec/api.yaml | 103 |
1 files changed, 93 insertions, 10 deletions
diff --git a/rust/fatcat-api-spec/api.yaml b/rust/fatcat-api-spec/api.yaml index 70a27b76..14b70c39 100644 --- a/rust/fatcat-api-spec/api.yaml +++ b/rust/fatcat-api-spec/api.yaml @@ -26,6 +26,10 @@ tags: # TAGLINE descriptions: "Creator entities: such as authors" # TAGLINE - name: files # TAGLINE descriptions: "File entities" # TAGLINE + - name: filesets # TAGLINE + descriptions: "Fileset entities" # TAGLINE + - name: webcaptures # TAGLINE + descriptions: "Webcapture entities" # TAGLINE - name: releases # TAGLINE descriptions: "Release entities: individual articles, pre-prints, books" # TAGLINE - name: works # TAGLINE @@ -132,6 +136,9 @@ definitions: type: string example: "Journal of Important Results" description: "Required for valid entities" + container_type: + type: string + description: "Eg, 'journal'" publisher: type: string example: "Society of Curious Students" @@ -139,10 +146,6 @@ definitions: <<: *FATCATISSN wikidata_qid: type: string - abbrev: - type: string - coden: - type: string creator_entity: type: object # required for creation: display_name @@ -249,7 +252,7 @@ definitions: properties: <<: *ENTITYPROPS cdx: - # limit of 200 CDX lines, at least to start + # limit of 200 CDX lines, at least to start? type: array items: type: object @@ -264,7 +267,9 @@ definitions: example: "org,asheesh)/apus/ch1/node15.html" timestamp: type: string - example: "20020429162520" + format: date-time + example: "2016-09-19T17:20:24Z" + description: "UTC, 'Z'-terminated, second (or better) precision" url: type: string # NOTE: not format:url to allow alternatives @@ -302,6 +307,7 @@ definitions: timestamp: type: string format: date-time + description: "same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Can be the earliest or average of CDX timestamps if that makes sense." release_ids: type: array items: @@ -313,7 +319,10 @@ definitions: <<: *ENTITYPROPS title: type: string - description: "Required for valid entities" + description: "Required for valid entities. The title used in citations and for display; usually English" + original_title: + type: string + description: "Title in original language (or, the language of the full text of this release)" work_id: type: string example: "q3nouwy3nnbsvo3h5klxsx4a7y" @@ -343,7 +352,7 @@ definitions: example: "book" release_status: type: string - example: "preprint" + example: "preprint, retracted" release_date: type: string format: date @@ -367,6 +376,10 @@ definitions: core_id: type: string #format: custom + arxiv_id: + type: string + jstor_id: + type: string volume: type: string issue: @@ -379,6 +392,9 @@ definitions: language: description: "Two-letter RFC1766/ISO639-1 language code, with extensions" type: string + license_slug: + type: string + description: "Short version of license name. Eg, 'CC-BY'" contribs: type: array items: @@ -588,11 +604,14 @@ definitions: description: "Optional; GET-only" raw_name: type: string + role: + type: string + raw_affiliation: + type: string + description: "Raw affiliation string as displayed in text" extra: type: object additionalProperties: {} - role: - type: string auth_oidc: type: object required: @@ -687,6 +706,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true @@ -945,6 +972,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true @@ -1226,6 +1261,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true @@ -1489,6 +1532,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true @@ -1718,6 +1769,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true @@ -1947,6 +2006,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true @@ -2201,6 +2268,14 @@ paths: in: query type: string required: false + - name: arxiv_id + in: query + type: string + required: false + - name: jstor_id + in: query + type: string + required: false - name: expand in: query type: string @@ -2291,6 +2366,14 @@ paths: type: string required: false description: "Editgroup to auto-accept and apply to all entities (required if 'autoaccept' is True)" + - name: description + in: query + type: string + required: false + - name: extra + in: query + type: string + required: false - name: entity_list in: body required: true |