v0.4 schema changes (backport from fatcat repo using openapi2)

1 files changed, 95 insertions, 2 deletions

diff --git a/fatcat-openapi3.yml b/fatcat-openapi3.yml
index 7ac6d0f..cb90d54 100644
--- a/fatcat-openapi3.yml
+++ b/fatcat-openapi3.yml
@@ -1,7 +1,7 @@
 openapi: "3.0.0"
 info:
   title: fatcat
-  version: 0.3.3
+  version: 0.4.0
   description: |
     Fatcat is a scalable, versioned, API-oriented catalog of bibliographic
     entities and file metadata.
@@ -468,6 +468,10 @@ components:
           description: Type of container, eg 'journal' or 'proceedings'. See Guide for list
             of valid types.
           example: journal
+        publication_status:
+          type: string
+          description: "Whether the container is active, discontinued, etc"
+          example: "active"
         publisher:
           type: string
           description: |
@@ -482,6 +486,20 @@ components:
           minLength: 9
           maxLength: 9
           example: 1234-5678
+        issne:
+          description: Electronic ISSN number (ISSN-E). Should be valid and registered with issn.org
+          type: string
+          pattern: \d{4}-\d{3}[0-9X]
+          minLength: 9
+          maxLength: 9
+          example: 1234-5678
+        issnp:
+          description: Print ISSN number (ISSN-P). Should be valid and registered with issn.org
+          type: string
+          pattern: \d{4}-\d{3}[0-9X]
+          minLength: 9
+          maxLength: 9
+          example: 1234-5678
         wikidata_qid:
           type: string
           example: Q42812
@@ -808,12 +826,15 @@ components:
           maxLength: 64
           description: SHA-256 hash of data, in hex encoding
           example: cb1c378f464d5935ddaa8de28446d82638396c61f042295d7fb85e3cccc9e452
+        mimetype:
+          type: string
+          example: "application/pdf"
         extra:
           type: object
           additionalProperties: {}
           description: |
             Free-form additional metadata about this specific file in the set.
-            Eg, `mimetype`. See guide for nomative (but unenforced) schema
+            Eg, `original_url`. See guide for normative (but unenforced) schema
             fields.
     webcapture_entity:
       type: object
@@ -1259,6 +1280,9 @@ components:
         oai:
           type: string
           description: "OAI-PMH identifier; only used when an OAI-PMH record is the only authoritative metadata (eg, journal OAI-PMH feeds w/o DOIs)"
+        hdl:
+          type: string
+          description: "Handle identifier. Do not put DOIs in this field"
     release_abstract:
       type: object
       properties:
@@ -2364,6 +2388,30 @@ paths:
             minLength: 9
             maxLength: 9
             pattern: \d{4}-\d{3}[0-9X]
+        - name: issne
+          in: query
+          required: false
+          schema:
+            type: string
+            minLength: 9
+            maxLength: 9
+            pattern: \d{4}-\d{3}[0-9X]
+        - name: issnp
+          in: query
+          required: false
+          schema:
+            type: string
+            minLength: 9
+            maxLength: 9
+            pattern: \d{4}-\d{3}[0-9X]
+        - name: issn
+          in: query
+          required: false
+          schema:
+            type: string
+            minLength: 9
+            maxLength: 9
+            pattern: \d{4}-\d{3}[0-9X]
         - name: wikidata_qid
           in: query
           required: false
@@ -5420,6 +5468,11 @@ paths:
           required: false
           schema:
             type: string
+        - name: hdl
+          in: query
+          required: false
+          schema:
+            type: string
         - name: expand
           in: query
           required: false
@@ -6385,6 +6438,46 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/error_response"
+  /editor/lookup:
+    get:
+      operationId: lookup_editor
+      tags:  # TAGLINE
+        - editors  # TAGLINE
+      description: |
+        Fetches editor by, eg, username.
+
+        One (and only one) lookup identifier should be specified per request.
+      parameters:
+        - name: username
+          in: query
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/editor"
+        "400":
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/error_response"
+        "404":
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/error_response"
+        "500":
+          description: Generic Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/error_response"
   /editgroup:
     post:
       operationId: create_editgroup