You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sdap.apache.org by sk...@apache.org on 2024/01/06 00:03:49 UTC

(incubator-sdap-nexus) branch SDAP-506 updated: Updated openapi spec

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

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


The following commit(s) were added to refs/heads/SDAP-506 by this push:
     new 3563ae9  Updated openapi spec
3563ae9 is described below

commit 3563ae9820f3c8699e15f348f61b94d7f5aa65b5
Author: skorper <st...@gmail.com>
AuthorDate: Fri Jan 5 16:03:33 2024 -0800

    Updated openapi spec
---
 analysis/webservice/apidocs/openapi.yml | 52 +++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/analysis/webservice/apidocs/openapi.yml b/analysis/webservice/apidocs/openapi.yml
index ea9b16b..0420bf9 100644
--- a/analysis/webservice/apidocs/openapi.yml
+++ b/analysis/webservice/apidocs/openapi.yml
@@ -721,6 +721,58 @@ paths:
             type: string
             format: uuid
           example: c864a51b-3d87-4872-9070-632820b1cae2
+  /cdmscatalog/{executionId}:
+    get:
+      summary: |
+        Get STAC Catalog for execution
+      operationId: cdmscatalog
+      tags:
+        - Analytics
+      description: "Get STAC catalog by execution id"
+      parameters:
+        - in: path
+          name: executionId
+          description: |
+            The job execution ID
+          required: true
+          schema:
+            type: string
+            format: uuid
+          example: c864a51b-3d87-4872-9070-632820b1cae2
+  /cdmscatalog/{executionId}/{format}:
+    get:
+      summary: |
+        Get STAC Catalog format catalog for execution
+      operationId: cdmscatalogcollection
+      tags:
+        - Analytics
+      description: "Get STAC catalog by execution id"
+      parameters:
+        - in: path
+          name: executionId
+          description: |
+            The job execution ID
+          required: true
+          schema:
+            type: string
+            format: uuid
+          example: c864a51b-3d87-4872-9070-632820b1cae2
+        - in: path
+          name: format
+          description: |
+            CDMS results format
+          required: true
+          schema:
+            type: string
+            enum: [JSON,CSV,NETCDF]
+          example: JSON
+        - in: query
+          name: pageSize
+          description: |
+            How many primary matches on each page of CDMS results
+          required: false
+          schema:
+            type: integer
 externalDocs:
   description: Documentation
   url: https://incubator-sdap-nexus.readthedocs.io/en/latest/index.html