From 9915e3b7d8aa486c1770f59cd85e2da3b46620c9 Mon Sep 17 00:00:00 2001 From: Benjamin Sugden Date: Thu, 23 Jan 2025 15:23:18 +0100 Subject: [PATCH] PB-1169: Spec remove forecast params from Get search Decided to remove the forecast parameters because the variable name differs to the post variable names (using underscore instead of colon) and colons need url encoding. --- spec/components/parameters.yaml | 44 ---------------- spec/openapi.yaml | 8 +-- spec/static/spec/v1/openapi.yaml | 51 +------------------ spec/static/spec/v1/openapitransactional.yaml | 51 +------------------ 4 files changed, 4 insertions(+), 150 deletions(-) diff --git a/spec/components/parameters.yaml b/spec/components/parameters.yaml index 84b8ea24..63ca9bbd 100644 --- a/spec/components/parameters.yaml +++ b/spec/components/parameters.yaml @@ -117,47 +117,3 @@ components: required: false schema: type: string - forecast_reference_datetime: - explode: false - in: query - name: forecast_reference_datetime - required: false - schema: - $ref: "./schemas.yaml#/components/schemas/datetimeQuery" - example: 2018-02-12T00%3A00%3A00Z%2F2018-03-18T12%3A31%3A12Z - style: form - forecast_horizon: - explode: false - in: query - name: forecast_horizon - required: false - schema: - $ref: "./schemas.yaml#/components/schemas/duration" - example: P3DT6H - style: form - forecast_duration: - explode: false - in: query - name: forecast_duration - required: false - schema: - $ref: "./schemas.yaml#/components/schemas/duration" - example: P3DT6H - style: form - forecast_variable: - explode: false - in: query - name: forecast_variable - required: false - schema: - $ref: "./schemas.yaml#/components/schemas/forecast_variable" - example: air_temperature - style: form - forecast_perturbed: - explode: false - in: query - name: forecast_perturbed - required: false - schema: - $ref: "./schemas.yaml#/components/schemas/forecast_perturbed" - style: form diff --git a/spec/openapi.yaml b/spec/openapi.yaml index befc9641..a49fcec1 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -274,7 +274,8 @@ paths: get: description: >- Retrieve Items matching filters. Intended as a shorthand API for simple - queries. + queries. To filter by forecast properties please use the + [POST /search](#tag/STAC/operation/postSearchSTAC) request. operationId: getSearchSTAC parameters: @@ -283,11 +284,6 @@ paths: - $ref: "./components/parameters.yaml#/components/parameters/limit" - $ref: "./components/parameters.yaml#/components/parameters/ids" - $ref: "./components/parameters.yaml#/components/parameters/collectionsArray" - - $ref: "./components/parameters.yaml#/components/parameters/forecast_reference_datetime" - - $ref: "./components/parameters.yaml#/components/parameters/forecast_horizon" - - $ref: "./components/parameters.yaml#/components/parameters/forecast_duration" - - $ref: "./components/parameters.yaml#/components/parameters/forecast_variable" - - $ref: "./components/parameters.yaml#/components/parameters/forecast_perturbed" responses: "200": content: diff --git a/spec/static/spec/v1/openapi.yaml b/spec/static/spec/v1/openapi.yaml index 24663687..c6e61d31 100644 --- a/spec/static/spec/v1/openapi.yaml +++ b/spec/static/spec/v1/openapi.yaml @@ -115,50 +115,6 @@ components: required: false schema: type: string - forecast_reference_datetime: - explode: false - in: query - name: forecast_reference_datetime - required: false - schema: - $ref: "#/components/schemas/datetimeQuery" - example: 2018-02-12T00%3A00%3A00Z%2F2018-03-18T12%3A31%3A12Z - style: form - forecast_horizon: - explode: false - in: query - name: forecast_horizon - required: false - schema: - $ref: "#/components/schemas/duration" - example: P3DT6H - style: form - forecast_duration: - explode: false - in: query - name: forecast_duration - required: false - schema: - $ref: "#/components/schemas/duration" - example: P3DT6H - style: form - forecast_variable: - explode: false - in: query - name: forecast_variable - required: false - schema: - $ref: "#/components/schemas/forecast_variable" - example: air_temperature - style: form - forecast_perturbed: - explode: false - in: query - name: forecast_perturbed - required: false - schema: - $ref: "#/components/schemas/forecast_perturbed" - style: form responses: Collection: headers: @@ -2156,7 +2112,7 @@ paths: /search: get: description: >- - Retrieve Items matching filters. Intended as a shorthand API for simple queries. + Retrieve Items matching filters. Intended as a shorthand API for simple queries. To filter by forecast properties please use the [POST /search](#tag/STAC/operation/postSearchSTAC) request. operationId: getSearchSTAC parameters: - $ref: "#/components/parameters/bbox" @@ -2164,11 +2120,6 @@ paths: - $ref: "#/components/parameters/limit" - $ref: "#/components/parameters/ids" - $ref: "#/components/parameters/collectionsArray" - - $ref: "#/components/parameters/forecast_reference_datetime" - - $ref: "#/components/parameters/forecast_horizon" - - $ref: "#/components/parameters/forecast_duration" - - $ref: "#/components/parameters/forecast_variable" - - $ref: "#/components/parameters/forecast_perturbed" responses: "200": content: diff --git a/spec/static/spec/v1/openapitransactional.yaml b/spec/static/spec/v1/openapitransactional.yaml index e3230d2f..4133df4d 100644 --- a/spec/static/spec/v1/openapitransactional.yaml +++ b/spec/static/spec/v1/openapitransactional.yaml @@ -115,50 +115,6 @@ components: required: false schema: type: string - forecast_reference_datetime: - explode: false - in: query - name: forecast_reference_datetime - required: false - schema: - $ref: "#/components/schemas/datetimeQuery" - example: 2018-02-12T00%3A00%3A00Z%2F2018-03-18T12%3A31%3A12Z - style: form - forecast_horizon: - explode: false - in: query - name: forecast_horizon - required: false - schema: - $ref: "#/components/schemas/duration" - example: P3DT6H - style: form - forecast_duration: - explode: false - in: query - name: forecast_duration - required: false - schema: - $ref: "#/components/schemas/duration" - example: P3DT6H - style: form - forecast_variable: - explode: false - in: query - name: forecast_variable - required: false - schema: - $ref: "#/components/schemas/forecast_variable" - example: air_temperature - style: form - forecast_perturbed: - explode: false - in: query - name: forecast_perturbed - required: false - schema: - $ref: "#/components/schemas/forecast_perturbed" - style: form assetId: name: assetId in: path @@ -3576,7 +3532,7 @@ paths: /search: get: description: >- - Retrieve Items matching filters. Intended as a shorthand API for simple queries. + Retrieve Items matching filters. Intended as a shorthand API for simple queries. To filter by forecast properties please use the [POST /search](#tag/STAC/operation/postSearchSTAC) request. operationId: getSearchSTAC parameters: - $ref: "#/components/parameters/bbox" @@ -3584,11 +3540,6 @@ paths: - $ref: "#/components/parameters/limit" - $ref: "#/components/parameters/ids" - $ref: "#/components/parameters/collectionsArray" - - $ref: "#/components/parameters/forecast_reference_datetime" - - $ref: "#/components/parameters/forecast_horizon" - - $ref: "#/components/parameters/forecast_duration" - - $ref: "#/components/parameters/forecast_variable" - - $ref: "#/components/parameters/forecast_perturbed" responses: "200": content: