skorper opened a new pull request, #291:
URL: https://github.com/apache/incubator-sdap-nexus/pull/291

   Ticket: [SDAP-506](https://issues.apache.org/jira/browse/SDAP-506)
   
   Made the following changes:
   
   * Added new `/cdmscatalog` endpoint
      * `/cdmscatalog/{id}` is a STAC catalog
      * `/cdmscatalog/{id}/{format}` is a STAC collection
        * In the `links` section of this output, there are links to all pages 
of `/cdmsresults` for that execution ID. 
        * `pageSize` is an optional param. Default is 1000 if not provided, If 
provided, it will be used to calculate the `/cdmsresults` links on 
`/cdmscatalog/{id}/{format}`
   * Added link to `/cdmscatalog` endpoint in `/job` endpoint links
   * Updated openapi spec
   
   ---
   
   Example outputs:
   
   ```bash
   job?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9
   ```
   
   ```json
   {
        "status": "success",
        "message": "",
        "createdAt": "2023-12-07 23:45:10.877000",
        "updatedAt": "2023-12-07 23:49:23.176000",
        "links": [{
                "href": 
"https://localhost:8083/job?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9";,
                "title": "The current page",
                "type": "application/json",
                "rel": "self"
        }, {
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9";,
                "title": "STAC Catalog for execution results",
                "type": "application/json",
                "rel": "stac"
        }, {
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=CSV";,
                "title": "Download results",
                "type": "text/csv",
                "rel": "data"
        }, {
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON";,
                "title": "Download results",
                "type": "application/json",
                "rel": "data"
        }, {
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=NETCDF";,
                "title": "Download results",
                "type": "binary/octet-stream",
                "rel": "data"
        }],
        "params": {
                "primary": "MUR25-JPL-L4-GLOB-v04.2",
                "matchup": "AC2019-JPL",
                "startTime": "2019-01-14 00:00:00+00:00",
                "endTime": "2019-08-05 23:59:59+00:00",
                "bbox": "-180,-62,180,-44",
                "timeTolerance": 86400,
                "radiusTolerance": 25000,
                "platforms": "3B",
                "parameter": "sea_water_temperature",
                "depthMin": -20,
                "depthMax": 10
        },
        "jobID": "a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9"
   }
   ```
   
   ```bash
   /cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9
   ```
   
   ```json
   {
        "stac_version": "1.0.0",
        "type": "Catalog",
        "id": "a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9",
        "description": "STAC Catalog for CDMS output",
        "links": [{
                "rel": "collection",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/CSV";,
                "title": "Collection of pages for 
a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9 CSV output"
        }, {
                "rel": "collection",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/JSON";,
                "title": "Collection of pages for 
a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9 JSON output"
        }, {
                "rel": "collection",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/NETCDF";,
                "title": "Collection of pages for 
a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9 NETCDF output"
        }]
   }
   ```
   ```bash
   /cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/JSON
   ```
   
   ```json
   {
        "stac_version": "1.0.0",
        "type": "Collection",
        "license": "not-provided",
        "id": "a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9.JSON",
        "description": "Collection of results for CDMS execution and result 
format",
        "extent": {
                "spatial": {
                        "bbox": [
                                -180,
                                -62,
                                180,
                                -44
                        ]
                },
                "temporal": {
                        "interval": [
                                "2019-01-14T00:00:00+00:00",
                                "2019-08-05T23:59:59+00:00"
                        ]
                }
        },
        "links": [{
                "rel": "self",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/JSON";,
                "title": "The current page",
                "type": "application/json"
        }, {
                "rel": "root",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9";,
                "title": "Root catalog for a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9"
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=1&pageSize=1000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=1001&pageSize=1000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=2001&pageSize=1000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=3001&pageSize=1000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=4001&pageSize=1000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=5001&pageSize=1000";
        }]
   }
   ```
   
   Example with different page size:
   
   ```bash
   /cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/JSON?pageSize=2000
   ```
   
   ```json
   {
        "stac_version": "1.0.0",
        "type": "Collection",
        "license": "not-provided",
        "id": "a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9.JSON",
        "description": "Collection of results for CDMS execution and result 
format",
        "extent": {
                "spatial": {
                        "bbox": [
                                -180,
                                -62,
                                180,
                                -44
                        ]
                },
                "temporal": {
                        "interval": [
                                "2019-01-14T00:00:00+00:00",
                                "2019-08-05T23:59:59+00:00"
                        ]
                }
        },
        "links": [{
                "rel": "self",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9/JSON";,
                "title": "The current page",
                "type": "application/json"
        }, {
                "rel": "root",
                "href": 
"https://localhost:8083/cdmscatalog/a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9";,
                "title": "Root catalog for a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9"
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=1&pageSize=2000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=2001&pageSize=2000";
        }, {
                "rel": "data",
                "href": 
"https://localhost:8083/cdmsresults?id=a15bfac6-f9c5-4a64-b8ec-bedbf955d8c9&output=JSON&pageNum=4001&pageSize=2000";
        }]
   }
   ```


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscr...@sdap.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to