diff options
| -rw-r--r-- | fatcat-openapi2.yml | 32 | ||||
| -rw-r--r-- | notes/schema/alignments.txt | 18 |
2 files changed, 41 insertions, 9 deletions
diff --git a/fatcat-openapi2.yml b/fatcat-openapi2.yml index b35d918e..0a5391c8 100644 --- a/fatcat-openapi2.yml +++ b/fatcat-openapi2.yml @@ -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 @@ -316,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" @@ -346,7 +352,7 @@ definitions: example: "book" release_status: type: string - example: "preprint" + example: "preprint, retracted" release_date: type: string format: date @@ -370,6 +376,10 @@ definitions: core_id: type: string #format: custom + arxiv_id: + type: string + jstor_id: + type: string volume: type: string issue: @@ -382,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: @@ -591,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: diff --git a/notes/schema/alignments.txt b/notes/schema/alignments.txt index e7678d93..7fc37606 100644 --- a/notes/schema/alignments.txt +++ b/notes/schema/alignments.txt @@ -27,9 +27,25 @@ Specifically, the "variables" and type definitions: <http://docs.citationstyles. - rights/license (for explicit OA) - version (eg, for software, standards) - url (eg, for blog posts and other web content; canonical only) +- authority (for things like patents) +- collection_title (for book series) +- short_title +- edition (eg, "4th") +- event (eg, conference) +- chapter_number +- submitted + +"extra" for citations: +- most of the above, or any fields from 'release" +- authors (an array) +- url +- issue, volume, date, edition +- accessed_date + +release_date aligns with... 'issued'? not original-date +pages aligns with 'page'. Should this be 'locator'? other things: -- align cite-items even closer with CSL? assuming this is what crossref is doing - anything specially needed for a blog post? url (original/canonical)? - press_release |