diff options
Diffstat (limited to 'rust/fatcat-api-spec/api/swagger.yaml')
| -rw-r--r-- | rust/fatcat-api-spec/api/swagger.yaml | 168 |
1 files changed, 145 insertions, 23 deletions
diff --git a/rust/fatcat-api-spec/api/swagger.yaml b/rust/fatcat-api-spec/api/swagger.yaml index 7a1c2755..927bb941 100644 --- a/rust/fatcat-api-spec/api/swagger.yaml +++ b/rust/fatcat-api-spec/api/swagger.yaml @@ -11,6 +11,8 @@ tags: - name: "containers" - name: "creators" - name: "files" +- name: "filesets" +- name: "webcaptures" - name: "releases" - name: "works" - name: "edit-lifecycle" @@ -133,6 +135,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -979,6 +993,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -1889,6 +1915,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -2748,6 +2786,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -3517,6 +3567,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -4286,6 +4348,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -5039,6 +5113,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"core_id_example\".to_string())" + - name: "arxiv_id" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"arxiv_id_example\".to_string())" + - name: "jstor_id" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"jstor_id_example\".to_string())" - name: "expand" in: "query" description: "List of sub-entities to expand in response." @@ -5346,6 +5432,18 @@ paths: type: "string" formatString: "{:?}" example: "Some(\"editgroup_id_example\".to_string())" + - name: "description" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"description_example\".to_string())" + - name: "extra" + in: "query" + required: false + type: "string" + formatString: "{:?}" + example: "Some(\"extra_example\".to_string())" - in: "body" name: "entity_list" required: true @@ -7273,10 +7371,6 @@ definitions: container_entity: type: "object" properties: - coden: - type: "string" - abbrev: - type: "string" wikidata_qid: type: "string" issnl: @@ -7288,6 +7382,9 @@ definitions: publisher: type: "string" example: "Society of Curious Students" + container_type: + type: "string" + description: "Eg, 'journal'" name: type: "string" example: "Journal of Important Results" @@ -7326,13 +7423,12 @@ definitions: - "deleted" example: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" - coden: "coden" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" + container_type: "container_type" name: "Journal of Important Results" publisher: "Society of Curious Students" issnl: "1234-5678" - abbrev: "abbrev" wikidata_qid: "wikidata_qid" state: "wip" edit_extra: "{}" @@ -7592,6 +7688,9 @@ 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." original_url: type: "string" format: "url" @@ -7651,14 +7750,14 @@ definitions: sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "wip" @@ -7684,6 +7783,9 @@ definitions: type: "array" items: $ref: "#/definitions/release_contrib" + license_slug: + type: "string" + description: "Short version of license name. Eg, 'CC-BY'" language: type: "string" description: "Two-letter RFC1766/ISO639-1 language code, with extensions" @@ -7696,6 +7798,10 @@ definitions: example: "12" volume: type: "string" + jstor_id: + type: "string" + arxiv_id: + type: "string" core_id: type: "string" pmcid: @@ -7718,7 +7824,7 @@ definitions: format: "date" release_status: type: "string" - example: "preprint" + example: "preprint, retracted" release_type: type: "string" example: "book" @@ -7746,9 +7852,14 @@ definitions: work_id: type: "string" example: "q3nouwy3nnbsvo3h5klxsx4a7y" + original_title: + type: "string" + description: "Title in original language (or, the language of the full text\ + \ of this release)" title: type: "string" - description: "Required for valid entities" + description: "Required for valid entities. The title used in citations and\ + \ for display; usually English" state: type: "string" enum: @@ -7784,13 +7895,12 @@ definitions: example: container: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" - coden: "coden" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" + container_type: "container_type" name: "Journal of Important Results" publisher: "Society of Curious Students" issnl: "1234-5678" - abbrev: "abbrev" wikidata_qid: "wikidata_qid" state: "wip" edit_extra: "{}" @@ -7810,14 +7920,14 @@ definitions: sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "wip" @@ -7841,14 +7951,14 @@ definitions: sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" surt: "org,asheesh)/apus/ch1/node15.html" status_code: 200 sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" extra: "{}" state: "wip" @@ -7862,7 +7972,8 @@ definitions: language: "language" title: "title" contribs: - - creator: + - raw_affiliation: "raw_affiliation" + creator: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" @@ -7879,7 +7990,8 @@ definitions: extra: "{}" creator_id: "creator_id" index: 1 - - creator: + - raw_affiliation: "raw_affiliation" + creator: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" ident: "q3nouwy3nnbsvo3h5klxsx4a7y" @@ -7901,9 +8013,11 @@ definitions: extra: "{}" state: "wip" edit_extra: "{}" + jstor_id: "jstor_id" redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" work_id: "q3nouwy3nnbsvo3h5klxsx4a7y" issue: "12" + original_title: "original_title" abstracts: - sha1: "e9dd75237c94b209dc3ccd52722de6931a310ba3" mimetype: "application/xml+jats" @@ -7917,9 +8031,10 @@ definitions: release_type: "book" wikidata_qid: "wikidata_qid" pmid: "pmid" - release_status: "preprint" + release_status: "preprint, retracted" revision: "86daea5b-1b6b-432a-bb67-ea97795f80fe" volume: "volume" + license_slug: "license_slug" refs: - target_release_id: "q3nouwy3nnbsvo3h5klxsx4a7y" container_name: "container_name" @@ -7979,6 +8094,7 @@ definitions: - "q3nouwy3nnbsvo3h5klxsx4a7y" edit_extra: "{}" md5: "1b39813549077b2347c0f370c3864b40" + arxiv_id: "arxiv_id" filesets: - redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" urls: @@ -8929,11 +9045,15 @@ definitions: $ref: "#/definitions/creator_entity" raw_name: type: "string" - extra: - type: "object" role: type: "string" + raw_affiliation: + type: "string" + description: "Raw affiliation string as displayed in text" + extra: + type: "object" example: + raw_affiliation: "raw_affiliation" creator: redirect: "q3nouwy3nnbsvo3h5klxsx4a7y" surname: "surname" @@ -9072,7 +9192,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" example: "http://www.asheesh.org:80/APUS/ch1/node15.html" @@ -9102,7 +9224,7 @@ definitions: sha256: "cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452" mimetype: "text/html" url: "http://www.asheesh.org:80/APUS/ch1/node15.html" - timestamp: "20020429162520" + timestamp: "2016-09-19T17:20:24Z" upperCaseName: "WEBCAPTURE_ENTITY_CDX" release_entity_abstracts: properties: |