Add schema and docs for prefix map.

Note that this makes [pull request 136](#136) obsolete.
phenoscape · Apr 11, 2022 · fb6f256 · fb6f256
1 parent d729e33
commit fb6f256
Showing 1 changed file with 20 additions and 17 deletions.
diff --git a/src/main/resources/docs/swagger.yaml b/src/main/resources/docs/swagger.yaml
@@ -107,9 +107,7 @@ paths:
             expression
           required: false
           schema:
-            type: string
-            format: JSON
-            example: '{"obo": "http://purl.obolibrary.org/obo/", "part_of": "http://purl.obolibrary.org/obo/BFO_0000050"}'
+            $ref: '#/components/schemas/prefixMap'
         - name: direct
           in: query
           required: false
@@ -198,9 +196,7 @@ paths:
             expression
           required: false
           schema:
-            type: string
-            format: JSON
-            example: '{"obo": "http://purl.obolibrary.org/obo/", "part_of": "http://purl.obolibrary.org/obo/BFO_0000050"}'
+            $ref: '#/components/schemas/prefixMap'
         - name: direct
           in: query
           required: false
@@ -289,9 +285,7 @@ paths:
             expression
           required: false
           schema:
-            type: string
-            format: JSON
-            example: '{"obo": "http://purl.obolibrary.org/obo/", "part_of": "http://purl.obolibrary.org/obo/BFO_0000050"}'
+            $ref: '#/components/schemas/prefixMap'
         - name: direct
           in: query
           required: false
@@ -365,9 +359,7 @@ paths:
             expression
           required: false
           schema:
-            type: string
-            format: JSON
-            example: '{"obo": "http://purl.obolibrary.org/obo/", "part_of": "http://purl.obolibrary.org/obo/BFO_0000050"}'
+            $ref: '#/components/schemas/prefixMap'
       responses:
         '200':
           description: satisfiability
@@ -409,8 +401,7 @@ paths:
           description: JSON format prefix map
           required: false
           schema:
-            type: string
-            format: JSON
+            $ref: '#/components/schemas/prefixMap'
         - name: direct
           in: query
           required: false
@@ -461,8 +452,7 @@ paths:
           description: JSON format prefix map
           required: false
           schema:
-            type: string
-            format: JSON
+            $ref: '#/components/schemas/prefixMap'
         - name: direct
           in: query
           required: false
@@ -613,4 +603,17 @@ paths:
         '200':
           description: SPARQL results
 components:
-  schemas: {}
+  schemas:
+    prefixMap:
+      description: >
+        JSON format prefix map, used to expand prefixes in
+        the 'object' expression.  A JSON format prefix map is a JSON
+        object whose keys are prefixes without the colon separator
+        (e.g., \"owl\"), and whose values are IRI prefixes
+        (typically WITH the hash-mark, \"#\" suffix).  Because these
+        are passed as parameters, they may need to be URL-encoded to
+        pass over HTTP.
+      type: string
+      format: JSON
+      example: '{"obo": "http://purl.obolibrary.org/obo/", "part_of": "http://purl.obolibrary.org/obo/BFO_0000050"}'
+