[incubator-sdap-nexus] 05/06: Updated openapi spec to support domsresults endpoint

[sk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

skperez pushed a commit to branch proxy-bugfix-apidocs
in repository https://gitbox.apache.org/repos/asf/incubator-sdap-nexus.git

commit 66380a29667386a750fda02091e21b2d24f5d768
Author: skorper <st...@gmail.com>
AuthorDate: Mon Aug 22 08:32:16 2022 -0700

    Updated openapi spec to support domsresults endpoint
---
 analysis/webservice/apidocs/openapi.yml | 55 +++++++++++++++++++++++++++++++--
 1 file changed, 53 insertions(+), 2 deletions(-)

diff --git a/analysis/webservice/apidocs/openapi.yml b/analysis/webservice/apidocs/openapi.yml
index 5e288b2..18de2f2 100644
--- a/analysis/webservice/apidocs/openapi.yml
+++ b/analysis/webservice/apidocs/openapi.yml
@@ -123,11 +123,13 @@ paths:
         - in: query
           name: parameter
           description: |
-            The parameter of interest used for the match up.
+            The parameter of interest used for the match up. This is
+            only used for insitu measurements. See `/cdmsschema` endpoint
+            for a list of valid options.
           required: false
           schema:
             type: string
-            default: sst
+            default: sea_surface_temperature
           example: sst
         - in: query
           name: matchOnce
@@ -687,6 +689,55 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /domsresults:
+    get:
+      summary: |
+        Convert matchup result
+      operationId: domsresults
+      tags:
+        - Matchup
+      parameters:
+        - in: query
+          name: id
+          description: |
+            The ID of the matchup execution. This comes from the
+            `executionId` field in matchup output.
+          required: true
+          schema:
+            type: string
+          example: dfc907ce-b8b4-453a-b0b6-d295572ba15e
+        - in: query
+          name: output
+          description: |
+            Format for output results.
+          required: true
+          schema:
+            type: string
+            enum: ['CSV', 'NETCDF']
+          example: CSV
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            text/csv:
+              schema:
+                type: string
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '500':
+          description: Server error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
   /stats:
     get:
       summary: |