diff --git a/.github/coveragereport/badge_methodcoverage.svg b/.github/coveragereport/badge_methodcoverage.svg index 3f134e5d..d449fc9f 100644 --- a/.github/coveragereport/badge_methodcoverage.svg +++ b/.github/coveragereport/badge_methodcoverage.svg @@ -102,7 +102,7 @@ Coverage - 93.2%93.2% + 93.1%93.1% diff --git a/cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/PublishedController.java b/cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/PublishedController.java new file mode 100644 index 00000000..cf4e1784 --- /dev/null +++ b/cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/PublishedController.java @@ -0,0 +1,52 @@ +/* + * MIT License + * + * Copyright (c) 2026 Hydrologic Engineering Center + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package mil.army.usace.hec.cwms.data.api.client.controllers; + +import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_HEADER_V1; +import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER; + +import java.io.IOException; +import mil.army.usace.hec.cwms.data.api.client.model.LocationToPublishedDataList; +import mil.army.usace.hec.cwms.data.api.client.model.RadarObjectMapper; +import mil.army.usace.hec.cwms.http.client.ApiConnectionInfo; +import mil.army.usace.hec.cwms.http.client.HttpRequestBuilderImpl; +import mil.army.usace.hec.cwms.http.client.HttpRequestResponse; +import mil.army.usace.hec.cwms.http.client.request.HttpRequestExecutor; + +public final class PublishedController { + + private static final String PUBLISHED_ENDPOINT = "published"; + + public LocationToPublishedDataList retrievePublishedData(ApiConnectionInfo apiConnectionInfo, PublishedEndpointInput.GetAll input) + throws IOException { + HttpRequestExecutor executor = new HttpRequestBuilderImpl(apiConnectionInfo, PUBLISHED_ENDPOINT) + .addQueryHeader(ACCEPT_QUERY_HEADER, ACCEPT_HEADER_V1) + .addEndpointInput(input) + .get(); + try (HttpRequestResponse response = executor.execute()) { + return RadarObjectMapper.mapJsonToObject(response.getBody(), LocationToPublishedDataList.class); + } + } +} diff --git a/cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/PublishedEndpointInput.java b/cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/PublishedEndpointInput.java new file mode 100644 index 00000000..b6e28bf9 --- /dev/null +++ b/cwms-data-api-client/src/main/java/mil/army/usace/hec/cwms/data/api/client/controllers/PublishedEndpointInput.java @@ -0,0 +1,88 @@ +/* + * MIT License + * + * Copyright (c) 2026 Hydrologic Engineering Center + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package mil.army.usace.hec.cwms.data.api.client.controllers; + +import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_HEADER_V1; +import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER; + +import java.util.Objects; +import mil.army.usace.hec.cwms.http.client.EndpointInput; +import mil.army.usace.hec.cwms.http.client.HttpRequestBuilder; + +public final class PublishedEndpointInput { + + private PublishedEndpointInput() { + throw new AssertionError("Factory class"); + } + + public static GetAll getAll() { + return new GetAll(); + } + + public static final class GetAll extends EndpointInput { + + static final String OFFICE_MASK_QUERY_PARAMETER = "office-mask"; + static final String LOCATION_MASK_QUERY_PARAMETER = "location-mask"; + static final String PAGE_QUERY_PARAMETER = "page"; + static final String PAGE_SIZE_QUERY_PARAMETER = "page-size"; + + private String officeIdMask; + private String locationIdMask; + private String page; + private Integer pageSize; + + private GetAll() { + } + + public GetAll withOfficeIdMask(String officeIdMask) { + this.officeIdMask = officeIdMask; + return this; + } + + public GetAll withLocationIdMask(String locationIdMask) { + this.locationIdMask = locationIdMask; + return this; + } + + public GetAll withPage(String page) { + this.page = page; + return this; + } + + public GetAll withPageSize(int pageSize) { + this.pageSize = pageSize; + return this; + } + + @Override + protected HttpRequestBuilder addInputParameters(HttpRequestBuilder httpRequestBuilder) { + return httpRequestBuilder.addQueryParameter(OFFICE_MASK_QUERY_PARAMETER, officeIdMask) + .addQueryParameter(LOCATION_MASK_QUERY_PARAMETER, locationIdMask) + .addQueryParameter(PAGE_QUERY_PARAMETER, page) + .addQueryParameter(PAGE_SIZE_QUERY_PARAMETER, getNullableFieldString(pageSize)) + .addQueryHeader(ACCEPT_QUERY_HEADER, ACCEPT_HEADER_V1); + } + } +} diff --git a/cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestPublishedController.java b/cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestPublishedController.java new file mode 100644 index 00000000..39c31082 --- /dev/null +++ b/cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestPublishedController.java @@ -0,0 +1,52 @@ +/* + * MIT License + * + * Copyright (c) 2026 Hydrologic Engineering Center + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package mil.army.usace.hec.cwms.data.api.client.controllers; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import java.io.IOException; +import mil.army.usace.hec.cwms.data.api.client.model.LocationToPublishedData; +import mil.army.usace.hec.cwms.data.api.client.model.LocationToPublishedDataList; +import org.junit.jupiter.api.Test; + +class TestPublishedController extends TestController { + + @Test + void testRetrievePublishedTimeSeries() throws IOException { + String json = readJsonFile("radar/v1/json/published_time_series.json"); + mockHttpServer.enqueue(json); + mockHttpServer.start(); + PublishedEndpointInput.GetAll input = PublishedEndpointInput.getAll().withOfficeIdMask("SWT"); + LocationToPublishedDataList result = new PublishedController().retrievePublishedData(buildConnectionInfo(), input); + assertNotNull(result); + assertFalse(result.getLocationToPublishedData().isEmpty()); + LocationToPublishedData entry = result.getLocationToPublishedData().get(0); + assertEquals("AARK", entry.getLocationId().getName()); + assertEquals("SPK", entry.getLocationId().getOfficeId()); + assertEquals("AARK.Stage.Inst.15Minutes.0.Ccp-Rev", entry.getPublishedTimesSeries().get("STAGE").getTimeSeriesId().getName()); + } +} diff --git a/cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestPublishedEndpointInput.java b/cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestPublishedEndpointInput.java new file mode 100644 index 00000000..048a7b04 --- /dev/null +++ b/cwms-data-api-client/src/test/java/mil/army/usace/hec/cwms/data/api/client/controllers/TestPublishedEndpointInput.java @@ -0,0 +1,50 @@ +/* + * MIT License + * + * Copyright (c) 2026 Hydrologic Engineering Center + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ + +package mil.army.usace.hec.cwms.data.api.client.controllers; + +import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_HEADER_V1; +import static mil.army.usace.hec.cwms.data.api.client.controllers.CdaEndpointConstants.ACCEPT_QUERY_HEADER; +import static org.junit.jupiter.api.Assertions.assertEquals; + +import org.junit.jupiter.api.Test; + +class TestPublishedEndpointInput { + + @Test + void testGetAllQueryRequest() { + MockHttpRequestBuilder mockHttpRequestBuilder = new MockHttpRequestBuilder(); + PublishedEndpointInput.GetAll input = PublishedEndpointInput.getAll() + .withOfficeIdMask("SPK") + .withLocationIdMask("BURL") + .withPage("cursor") + .withPageSize(50); + input.addInputParameters(mockHttpRequestBuilder); + assertEquals("SPK", mockHttpRequestBuilder.getQueryParameter(PublishedEndpointInput.GetAll.OFFICE_MASK_QUERY_PARAMETER)); + assertEquals("BURL", mockHttpRequestBuilder.getQueryParameter(PublishedEndpointInput.GetAll.LOCATION_MASK_QUERY_PARAMETER)); + assertEquals("cursor", mockHttpRequestBuilder.getQueryParameter(PublishedEndpointInput.GetAll.PAGE_QUERY_PARAMETER)); + assertEquals("50", mockHttpRequestBuilder.getQueryParameter(PublishedEndpointInput.GetAll.PAGE_SIZE_QUERY_PARAMETER)); + assertEquals(ACCEPT_HEADER_V1, mockHttpRequestBuilder.getQueryHeader(ACCEPT_QUERY_HEADER)); + } +} diff --git a/cwms-data-api-client/src/test/resources/radar/v1/json/published_time_series.json b/cwms-data-api-client/src/test/resources/radar/v1/json/published_time_series.json new file mode 100644 index 00000000..f807cbde --- /dev/null +++ b/cwms-data-api-client/src/test/resources/radar/v1/json/published_time_series.json @@ -0,0 +1,137 @@ +{ + "cursor": "cursor", + "page-size": 20, + "total": 3, + "next-page": "", + "location-to-published-data": [ + { + "location-id": { + "office-id": "SPK", + "name": "AARK" + }, + "bounding-office-id": "SPK", + "kind": "SITE", + "published-times-series": { + "STAGE": { + "time-series-id": { + "office-id": "SPK", + "name": "AARK.Stage.Inst.15Minutes.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Stage data for AARK" + }, + "INFLOW": { + "time-series-id": { + "office-id": "SPK", + "name": "AARK.Flow.Inst.1Hour.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Flow data for AARK" + }, + "PRECIP": { + "time-series-id": { + "office-id": "SPK", + "name": "AARK.Precip.Inst.1Hour.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Precip data for AARK" + } + } + }, + { + "location-id": { + "office-id": "SWT", + "name": "ADDI" + }, + "bounding-office-id": "SWT", + "kind": "SITE", + "published-times-series": { + "STAGE": { + "time-series-id": { + "office-id": "SWT", + "name": "ADDI.Stage.Inst.15Minutes.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Stage data for ADDI" + }, + "INFLOW": { + "time-series-id": { + "office-id": "SWT", + "name": "ADDI.Flow.Inst.1Hour.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Flow data for ADDI" + }, + "PRECIP": { + "time-series-id": { + "office-id": "SWT", + "name": "ADDI.Precip.Inst.1Hour.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Precip data for ADDI" + } + } + }, + { + "location-id": { + "office-id": "NWD", + "name": "BBNK" + }, + "bounding-office-id": "NWD", + "kind": "SITE", + "published-times-series": { + "STAGE": { + "time-series-id": { + "office-id": "NWD", + "name": "BBNK.Stage.Inst.15Minutes.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Stage data for BBNK" + }, + "INFLOW": { + "time-series-id": { + "office-id": "NWD", + "name": "BBNK.Flow.Inst.1Hour.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Flow data for BBNK" + }, + "PRECIP": { + "time-series-id": { + "office-id": "NWD", + "name": "BBNK.Precip.Inst.1Hour.0.Ccp-Rev" + }, + "timezone-name": "UTC", + "interval-offset-minutes": 0, + "active": true, + "date-refreshed": "2025-03-03T12:00:00Z", + "notes": "Precip data for BBNK" + } + } + } + ] +} diff --git a/cwms-data-api-model/cwms-data-api-swagger.yaml b/cwms-data-api-model/cwms-data-api-swagger.yaml index 7a8d533b..e79564a3 100644 --- a/cwms-data-api-model/cwms-data-api-swagger.yaml +++ b/cwms-data-api-model/cwms-data-api-swagger.yaml @@ -1,15 +1,14 @@ ---- openapi: 3.0.1 info: title: CWMS Data API description: CWMS REST API for Data Retrieval - version: 2025.12.17-develop + version: 2026.06.05-feature-Adding_Access_To_Water_Endpoint servers: - - url: "/cwms-data" + - url: /cwms-data security: - CdaAccessManager: [] paths: - "/": + /: get: summary: Get operationId: get @@ -19,35 +18,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/auth/keys/{key-name}": + '/auth/keys/{key-name}': get: tags: - Authorization @@ -57,8 +56,9 @@ paths: parameters: - name: key-name in: path - description: 'Name of the specific key to get more information for. NOTE: - Case-sensitive.' + description: >- + Name of the specific key to get more information for. NOTE: + Case-sensitive. required: true schema: type: string @@ -68,37 +68,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ApiKey" + $ref: '#/components/schemas/ApiKey' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -111,6 +111,9 @@ paths: parameters: - name: key-name in: path + description: >- + Name of the specific key to get more information for. NOTE: + Case-sensitive. required: true schema: type: string @@ -120,41 +123,41 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ApiKey" + $ref: '#/components/schemas/ApiKey' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/auth/keys": + /auth/keys: get: tags: - Authorization @@ -169,37 +172,37 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/ApiKey" + $ref: '#/components/schemas/ApiKey' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -207,55 +210,56 @@ paths: tags: - Authorization summary: Post auth keys - description: Create a new API Key for user. The randomly generated key is returned - to the caller. A provided key will be ignored. + description: >- + Create a new API Key for user. The randomly generated key is returned to + the caller. A provided key will be ignored. operationId: postAuthKeys requestBody: content: application/json: schema: - "$ref": "#/components/schemas/ApiKey" + $ref: '#/components/schemas/ApiKey' responses: '201': description: Created content: application/json: schema: - "$ref": "#/components/schemas/ApiKey" + $ref: '#/components/schemas/ApiKey' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/location/category/{category-id}": + '/location/category/{category-id}': get: tags: - Location Categories @@ -271,8 +275,9 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the Location Category whose data - is to be included in the response. + description: >- + Specifies the owning office of the Location Category whose data is + to be included in the response. required: true schema: type: string @@ -282,37 +287,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LocationCategory" + $ref: '#/components/schemas/LocationCategory' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -337,8 +342,9 @@ paths: type: string - name: cascade-delete in: query - description: 'Specifies whether to delete any location groups in this location - category. Default: false' + description: >- + Specifies whether to delete any location groups in this location + category. Default: false schema: type: boolean responses: @@ -347,35 +353,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/location/category": + /location/category: get: tags: - Location Categories @@ -385,9 +391,11 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the location category(ies) whose - data is to be included in the response. If this field is not specified, - matching location category information from all offices shall be returned. + description: >- + Specifies the owning office of the location category(ies) whose data + is to be included in the response. If this field is not specified, + matching location category information from all offices shall be + returned. schema: type: string responses: @@ -398,37 +406,37 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/LocationCategory" + $ref: '#/components/schemas/LocationCategory' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -442,7 +450,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LocationCategory" + $ref: '#/components/schemas/LocationCategory' required: true responses: '400': @@ -450,76 +458,81 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/location/group/{group-id}": + '/location/group/{group-id}': get: tags: - Location Groups summary: Get location group with groupId - description: Retrieves requested Location Group. This endpoint supports GEO - JSON responses with application/geo+json.For more information about accept + description: >- + Retrieves requested Location Group. This endpoint supports GEO JSON + responses with application/geo+json.For more information about accept header usage, see this page. operationId: getLocationGroupWithGroupId parameters: - name: group-id in: path - description: Specifies the location_group whose data is to be included in - the response + description: >- + Specifies the location_group whose data is to be included in the + response required: true schema: type: string - name: office in: query - description: Specifies the owning office of the location group whose data - is to be included in the response. + description: >- + Specifies the owning office of the location group whose data is to + be included in the response. required: true schema: type: string - name: group-office-id in: query - description: Specifies the owning office of the location group whose data - is to be included in the response. - required: true + description: >- + Specifies the owning office of the location group whose data is to + be included in the response. Required for GEO JSON format. schema: type: string - name: category-office-id in: query - description: Specifies the owning office of the category the location group - belongs to whose data is to be included in the response. - required: true + description: >- + Specifies the owning office of the category the location group + belongs to whose data is to be included in the response. Required + for GEO JSON format. schema: type: string - name: category-id in: query - description: Specifies the category containing the location group whose data - is to be included in the response. + description: >- + Specifies the category containing the location group whose data is + to be included in the response. required: true schema: type: string @@ -529,43 +542,43 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LocationGroup" + $ref: '#/components/schemas/LocationGroup' text/csv: schema: - "$ref": "#/components/schemas/CsvV1LocationGroup" + $ref: '#/components/schemas/CsvV1LocationGroup' application/geo+json: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -596,8 +609,9 @@ paths: type: string - name: cascade-delete in: query - description: 'Specifies whether to unassign any location assignments. Default: - false' + description: >- + Specifies whether to unassign any location assignments. Default: + false schema: type: boolean responses: @@ -606,31 +620,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -638,26 +652,31 @@ paths: tags: - Location Groups summary: Patch location group with groupId - description: Update existing LocationGroup. Allows for renaming group, assigning - new locations, and unassigning all locations from the group. + description: >- + Update existing LocationGroup. Allows for renaming group, assigning new + locations, and unassigning all locations from the group. operationId: patchLocationGroupWithGroupId parameters: - name: group-id in: path + description: Specifies the location_group to be renamed. required: true schema: type: string - name: replace-assigned-locs in: query - description: 'Specifies whether to unassign all existing locations before - assigning new locations specified in the content body Default: false' + description: >- + Specifies whether to unassign all existing locations before + assigning new locations specified in the content body Default: false schema: type: boolean - name: office in: query - description: Specifies the office of the user making the request. This is - the office that the location, group, and category belong to. If the group - and/or category belong to the CWMS office, this only identifies the location. + description: >- + Specifies the office of the user making the request. This is the + office that the location, group, and category belong to. If the + group and/or category belong to the CWMS office, this only + identifies the location. required: true schema: type: string @@ -665,7 +684,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LocationGroup" + $ref: '#/components/schemas/LocationGroup' required: true responses: '400': @@ -673,35 +692,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/location/group": + /location/group: get: tags: - Location Groups @@ -711,35 +730,39 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the location group whose data - is to be included in the response. If this field is not specified, matching - location groups information from all offices shall be returned. + description: >- + Specifies the owning office of the location group whose data is to + be included in the response. If this field is not specified, + matching location groups information from all offices shall be + returned. schema: type: string - name: include-assigned in: query - description: 'Include the assigned locations in the returned location groups. - (default: false)' + description: >- + Include the assigned locations in the returned location groups. + (default: false) schema: type: boolean - name: location-category-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the location category id schema: type: string - name: category-office-id in: query - description: Specifies the owning office of the category the location group + description: >- + Specifies the owning office of the category the location group belongs to whose data is to be included in the response. - required: true schema: type: string - name: location-office-id in: query - description: Specifies the owning office of the location assigned to the location + description: >- + Specifies the owning office of the location assigned to the location group whose data is to be included in the response. - required: true schema: type: string responses: @@ -750,42 +773,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/LocationGroup" + $ref: '#/components/schemas/LocationGroup' text/csv: schema: type: array items: - "$ref": "#/components/schemas/CsvV1LocationGroup" + $ref: '#/components/schemas/CsvV1LocationGroup' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -799,7 +822,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LocationGroup" + $ref: '#/components/schemas/LocationGroup' required: true responses: '400': @@ -807,70 +830,75 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/locations/with-kinds": + /locations/with-kinds: get: tags: - REGI summary: Get locations withKinds - description: Returns CWMS Location Data. The Catalog end-point is also capable - of retrieving lists of locations and can filter on additional fields. + description: >- + Returns CWMS Location Data. The Catalog end-point is also capable of + retrieving lists of locations and can filter on additional fields. operationId: getLocationsWithKinds parameters: - name: names in: query - description: Specifies the name(s) of the location(s) whose data is to be - included in the response. This parameter is a Posix regular - expression matching against the id + description: >- + Specifies the name(s) of the location(s) whose data is to be + included in the response. This parameter is a Posix regular expression matching against the id schema: type: string - name: location-kind-like in: query - description: Specifies the location kind(s) whose data is to be included in - the response. This parameter is a Posix regular expression - matching against the location kind. If this field is not specified, all - location kinds shall be returned. + description: >- + Specifies the location kind(s) whose data is to be included in the + response. This parameter is a Posix regular + expression matching against the location kind. If this field is + not specified, all location kinds shall be returned. schema: type: string - name: office in: query - description: Specifies the owning office of the location level(s) whose data - is to be included in the response. If this field is not specified, matching - location level information from all offices shall be returned. + description: >- + Specifies the owning office of the location level(s) whose data is + to be included in the response. If this field is not specified, + matching location level information from all offices shall be + returned. schema: type: string responses: '200': description: OK content: - application/json;version=2: + application/json;version=1: schema: type: array items: @@ -880,35 +908,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/locations/{location-id}": + '/locations/{location-id}': get: tags: - Locations @@ -918,73 +946,90 @@ paths: parameters: - name: location-id in: path + description: The ID of the location to get required: true schema: type: string - name: office in: query - description: Specifies the owning office of the location level(s) whose data - is to be included in the response. If this field is not specified, matching - location level information from all offices shall be returned. + description: >- + Specifies the owning office of the location level(s) whose data is + to be included in the response. If this field is not specified, + matching location level information from all offices shall be + returned. required: true schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are: \n* `EN` Specifies English unit system. Location - values will be in the default English units for their parameters. This is - the default behavior.\n* `SI` Specifies the SI unit system. Location values - will be in the default SI units for their parameters." + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` Specifies English unit system. Location values will be in + the default English units for their parameters. This is the default + behavior. + + * `SI` Specifies the SI unit system. Location values will be in + the default SI units for their parameters. schema: type: string - name: include-aliases in: query - description: 'Specifies whether to include location aliases in the response. - Default: false' + description: >- + Specifies whether to include location aliases in the response. + Default: false schema: type: boolean + - name: datum + in: query + description: >- + Specifies the elevation datum of the response. This field affects + only vertical datum. Valid values: NAVD88, NGVD29. + schema: + type: string responses: '200': description: OK content: application/json;version=2: schema: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' application/xml;version=2: schema: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the location was - not found. + description: >- + Based on the combination of inputs provided the location was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -997,16 +1042,25 @@ paths: parameters: - name: location-id in: path + description: The ID of the location to delete required: true schema: type: string - name: office in: query - description: Specifies the owning office of the location whose data is to - be deleted. If this field is not specified, matching location information - will be deleted from all offices. + description: >- + Specifies the owning office of the location whose data is to be + deleted. If this field is not specified, matching location + information will be deleted from all offices. schema: type: string + - name: cascade-delete + in: query + description: >- + Specifies whether to delete associated data for this location before + deleting the location itself. Default: false + schema: + type: boolean responses: '200': description: Location successfully deleted from CWMS. @@ -1015,32 +1069,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the location was - not found. + description: >- + Based on the combination of inputs provided the location was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -1053,6 +1108,7 @@ paths: parameters: - name: location-id in: path + description: The ID of the location to update required: true schema: type: string @@ -1060,10 +1116,10 @@ paths: content: application/xml: schema: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' application/json: schema: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' required: true responses: '400': @@ -1071,91 +1127,117 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the location was - not found. + description: >- + Based on the combination of inputs provided the location was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/locations": + /locations: get: tags: - Locations summary: Get locations - description: Returns CWMS Location Data. The Catalog end-point is also capable - of retrieving lists of locations and can filter on additional fields. + description: >- + Returns CWMS Location Data. The Catalog end-point is also capable of + retrieving lists of locations and can filter on additional fields. operationId: getLocations parameters: - name: names in: query - description: Specifies the name(s) of the location(s) whose data is to be - included in the response. When the `format` parameter is not provided and - `application/json;version=2` is specified in the accept header, this parameter - is a Posix regular expression matching against - the id + description: >- + Specifies the name(s) of the location(s) whose data is to be + included in the response. When the `format` parameter is not + provided and `application/json;version=2` is specified in the accept + header, this parameter is a Posix regular + expression matching against the id schema: type: string - name: office in: query - description: Specifies the owning office of the location level(s) whose data - is to be included in the response. If this field is not specified, matching - location level information from all offices shall be returned. + description: >- + Specifies the owning office of the location level(s) whose data is + to be included in the response. If this field is not specified, + matching location level information from all offices shall be + returned. schema: type: string - name: unit in: query - description: |- - Specifies the unit or unit system of the response. Default is SI. Valid values for the unit field are: - * `EN` Specifies English unit system. Location level values will be in the default English units for their parameters. - * `SI` Specifies the SI unit system. Location level values will be in the default SI units for their parameters. - * `Other` Any unit returned in the response to the units URI request that is appropriate for the requested parameters. + description: >- + Specifies the unit or unit system of the response. Default is SI. + Valid values for the unit field are: + + * `EN` Specifies English unit system. Location level values will + be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location level values will be + in the default SI units for their parameters. + + * `Other` Any unit returned in the response to the units URI + request that is appropriate for the requested parameters. schema: type: string - name: datum in: query - description: |- - Specifies the elevation datum of the response. This field affects only vertical datum. Valid values for this field are: - * `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum. - * `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum. + description: >- + Specifies the elevation datum of the response. This field affects + only vertical datum. Valid values for this field are: + + * `NAVD88` The elevation values will in the specified or default + units above the NAVD-88 datum. + + * `NGVD29` The elevation values will be in the specified or default + units above the NGVD-29 datum. schema: type: string - name: format in: query - description: |- - Specifies the encoding format of the response. Valid values for the format field for this URI are: - + description: >- + Specifies the encoding format of the response. Valid values for the + format field for this URI are: + + * `tab` + * `csv` + * `xml` + * `wml2` (only if name field is specified) + * `json` (default) - + + * `geojson` - - See this page for more information about accept header usage. + + + See this page for more information + about accept header usage. schema: type: string responses: @@ -1166,10 +1248,10 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' application/json: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' text/tab-separated-values: schema: type: string @@ -1178,46 +1260,46 @@ paths: type: string application/xml: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/vnd.opengis.waterml+xml: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/geo+json: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' '': schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -1230,55 +1312,321 @@ paths: parameters: - name: fail-if-exists in: query - description: 'Specifies whether to fail if the location already exists. Default: - true. If true, an error will be returned if the location already exists. - If false, the existing location will be updated with the new values.' + description: >- + Specifies whether to fail if the location already exists. Default: + true. If true, an error will be returned if the location already + exists. If false, the existing location will be updated with the new + values. schema: type: boolean requestBody: content: application/json: schema: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' application/xml: schema: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' + required: true + responses: + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + '/location/{location-id}/vertical-datum': + get: + tags: + - Locations + summary: Get location with locationId verticalDatum + description: Returns Vertical Datum Info for the specified location. + operationId: getLocationWithLocationIdVerticalDatum + parameters: + - name: location-id + in: path + description: Specifies the location-id. + required: true + schema: + type: string + - name: office + in: query + description: Specifies the owning office. + required: true + schema: + type: string + - name: unit + in: query + description: >- + Specifies the unit of measure for elevation/offsets (e.g., m or ft). + Default is m. + schema: + type: string + responses: + '200': + description: OK + content: + application/json;version=1: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + application/json: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + application/xml;version=1: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + application/xml: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + post: + tags: + - Locations + summary: Post location with locationId verticalDatum + description: Create Vertical Datum Info for a Location + operationId: postLocationWithLocationIdVerticalDatum + parameters: + - name: location-id + in: path + required: true + schema: + type: string + - name: location-id + in: query + description: Specifies the location id for this vertical-datum-info. + required: true + schema: + type: string + - name: office + in: query + description: Specifies the owning office. + required: true + schema: + type: string + requestBody: + content: + application/json;version=1: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + application/xml;version=1: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + required: true + responses: + '201': + description: Vertical Datum Info successfully stored to CWMS. + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + delete: + tags: + - Locations + summary: Delete location with locationId verticalDatum + description: Delete Vertical Datum Info for a Location + operationId: deleteLocationWithLocationIdVerticalDatum + parameters: + - name: location-id + in: path + description: Specifies the location-id for the vertical-datum being deleted. + required: true + schema: + type: string + - name: office + in: query + description: Specifies the owning office. + required: true + schema: + type: string + responses: + '200': + description: Vertical Datum Info successfully deleted from CWMS. + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '404': + description: Vertical Datum Info not found. + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + patch: + tags: + - Locations + summary: Patch location with locationId verticalDatum + description: Update Vertical Datum Info for a Location + operationId: patchLocationWithLocationIdVerticalDatum + parameters: + - name: location-id + in: path + description: The ID of the location to update + required: true + schema: + type: string + - name: office + in: query + description: Specifies the owning office. + required: true + schema: + type: string + requestBody: + content: + application/json;version=1: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' + application/xml;version=1: + schema: + $ref: '#/components/schemas/VerticalDatumInfo' required: true responses: + '200': + description: Updated Vertical Datum Info '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/entity/{entity-id}": + '/entity/{entity-id}': get: tags: - Entity @@ -1288,14 +1636,14 @@ paths: parameters: - name: entity-id in: path - description: Specifies the Entity ID of the entity to be retrieved. (e.g., - NWS). + description: 'Specifies the Entity ID of the entity to be retrieved. (e.g., NWS).' required: true schema: type: string - name: office in: query - description: Specifies the owning office of the entity to be retrieved. e.g., + description: >- + Specifies the owning office of the entity to be retrieved. e.g., SPK) required: true schema: @@ -1304,39 +1652,39 @@ paths: '200': description: OK content: - application/json;version=2: + application/json;version=1: schema: - "$ref": "#/components/schemas/Entity" + $ref: '#/components/schemas/Entity' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -1349,20 +1697,21 @@ paths: parameters: - name: entity-id in: path - description: Specifies the entity ID of the Entity to be deleted (e.g., NWS). + description: 'Specifies the entity ID of the Entity to be deleted (e.g., NWS).' required: true schema: type: string - name: office in: query - description: Specifies the owning office of the entity to be updated. (e.g., + description: >- + Specifies the owning office of the entity to be updated. (e.g., SPK) required: true schema: type: string - name: cascade-delete in: query - description: If true, also delete all descendant child entities. + description: 'If true, also delete all descendant child entities.' required: true schema: type: boolean @@ -1374,31 +1723,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Entity not found for the given parameters. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -1411,23 +1760,15 @@ paths: parameters: - name: entity-id in: path - description: Specifies the entity ID of the Entity to be updated. (e.g., - NWS) - required: true - schema: - type: string - - name: office - in: query - description: Specifies the owning office of the entity to be updated. (e.g., - SPK) + description: 'Specifies the entity ID of the Entity to be updated. (e.g., NWS)' required: true schema: type: string requestBody: content: - application/json;version=2: + application/json;version=1: schema: - "$ref": "#/components/schemas/Entity" + $ref: '#/components/schemas/Entity' required: true responses: '200': @@ -1437,35 +1778,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/entity": + /entity: get: tags: - Entity @@ -1475,75 +1816,79 @@ paths: parameters: - name: office in: query - description: Office ID to filter entities (e.g., SPK). If omitted, returns + description: >- + Office ID to filter entities (e.g., SPK). If omitted, returns entities for all offices. schema: type: string - name: entity-id in: query - description: Entity ID to filter by specific entity. If omitted, returns all + description: >- + Entity ID to filter by specific entity. If omitted, returns all entities. (e.g., GOV or NWS). schema: type: string - name: parent-entity-id in: query - description: Parent Entity ID to filter entities by parent (e.g., NOAA). + description: 'Parent Entity ID to filter entities by parent (e.g., NOAA).' schema: type: string - name: category-id in: query - description: Category ID to filter entities by category (e.g., GOV). + description: 'Category ID to filter entities by category (e.g., GOV).' schema: type: string - name: long-name in: query - description: Entity long name to filter entities (e.g., National Weather Service). + description: >- + Entity long name to filter entities (e.g., National Weather + Service). schema: type: string - name: match-null-parents in: query - description: If true, include entities with null parent IDs. Default is true. + description: 'If true, include entities with null parent IDs. Default is true.' schema: type: boolean responses: '200': description: OK content: - application/json;version=2: + application/json;version=1: schema: type: array items: - "$ref": "#/components/schemas/Entity" + $ref: '#/components/schemas/Entity' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -1555,9 +1900,9 @@ paths: operationId: postEntity requestBody: content: - application/json;version=2: + application/json;version=1: schema: - "$ref": "#/components/schemas/Entity" + $ref: '#/components/schemas/Entity' required: true responses: '201': @@ -1567,35 +1912,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/states": + /states: get: tags: - States @@ -1609,41 +1954,41 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/State" + $ref: '#/components/schemas/State' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/counties": + /counties: get: tags: - Counties @@ -1657,41 +2002,41 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/County" + $ref: '#/components/schemas/County' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/offices/{office}": + '/offices/{office}': get: tags: - Offices @@ -1706,10 +2051,7 @@ paths: type: string - name: format in: query - description: "(CWMS-Data-Format-Deprecated: 2024-11-01 in favor of Accept - header) Specifies the encoding format of the response. Valid value for the - format field for this URI are:\r\n* `tab`\r\n* `csv`\r\n* `xml`\r\n* `json` - (default)" + description: "(CWMS-Data-Format-Deprecated: 2024-11-01 in favor of Accept header) Specifies the encoding format of the response. Valid value for the format field for this URI are:\r\n* `tab`\r\n* `csv`\r\n* `xml`\r\n* `json` (default)" deprecated: true schema: type: string @@ -1719,59 +2061,59 @@ paths: content: '': schema: - "$ref": "#/components/schemas/OfficeFormatV1" + $ref: '#/components/schemas/OfficeFormatV1' application/json: schema: - "$ref": "#/components/schemas/Office" + $ref: '#/components/schemas/Office' application/json;version=1: schema: - "$ref": "#/components/schemas/OfficeFormatV1" + $ref: '#/components/schemas/OfficeFormatV1' application/json;version=2: schema: - "$ref": "#/components/schemas/Office" + $ref: '#/components/schemas/Office' application/xml: schema: - "$ref": "#/components/schemas/Office" + $ref: '#/components/schemas/Office' application/xml;version=1: schema: - "$ref": "#/components/schemas/OfficeFormatV1" + $ref: '#/components/schemas/OfficeFormatV1' application/xml;version=2: schema: - "$ref": "#/components/schemas/Office" + $ref: '#/components/schemas/Office' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/offices": + /offices: get: tags: - Offices @@ -1780,18 +2122,17 @@ paths: parameters: - name: format in: query - description: "(CWMS-Data-Format-Deprecated: 2024-11-01 in favor of Accept - header) Specifies the encoding format of the response. Valid value for the - format field for this URI are:\r\n\n* `tab`\r\n\n* `csv`\r\n \n* `xml`\r\n\n* - `json` (default)" + description: "(CWMS-Data-Format-Deprecated: 2024-11-01 in favor of Accept header) Specifies the encoding format of the response. Valid value for the format field for this URI are:\r\n\n* `tab`\r\n\n* `csv`\r\n \n* `xml`\r\n\n* `json` (default)" deprecated: true schema: type: string - name: has-data in: query - description: 'A flag (''True''/''False'') When set to true this returns offices - that have operational data. Default value is False,. Feature #321' + description: >- + A flag ('True'/'False') When set to true this returns offices that + have operational data. Default value is False,. Feature #321 schema: type: boolean responses: @@ -1802,51 +2143,51 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Office" + $ref: '#/components/schemas/Office' application/json;version=1: schema: type: array items: - "$ref": "#/components/schemas/OfficeFormatV1" + $ref: '#/components/schemas/OfficeFormatV1' application/json;version=2: schema: type: array items: - "$ref": "#/components/schemas/Office" + $ref: '#/components/schemas/Office' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/units": + /units: get: tags: - Units @@ -1855,14 +2196,21 @@ paths: parameters: - name: format in: query - description: |- - Specifies the encoding format of the response. Valid value for the format field for this URI are: + description: >- + Specifies the encoding format of the response. Valid value for the + format field for this URI are: + * `tab` + * `csv` + * `xml` + * `json` (default) - - See this page for more information about accept header usage. + + + See this page for more information + about accept header usage. schema: type: string responses: @@ -1873,37 +2221,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: The format requested is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/parameters": + /parameters: get: tags: - Parameters @@ -1912,22 +2260,30 @@ paths: parameters: - name: format in: query - description: |- - Specifies the encoding format of the response. Valid value for the format field for this URI are: - * `tab` - * `csv` + description: >- + Specifies the encoding format of the response. Valid value for the + format field for this URI are: + + * `tab` (deprecated) + + * `csv` (deprecated) + * `xml` + * `json` (default) - - See this page for more information about accept header usage. + + + See this page for more information + about accept header usage. deprecated: true schema: type: string - name: office in: query - description: Specifies the owning office of the parameters whose data is to - be included in the response. If this field is not specified, the session - user's default office will be used. + description: >- + Specifies the owning office of the parameters whose data is to be + included in the response. If this field is not specified, the + session user's default office will be used. schema: type: string responses: @@ -1938,46 +2294,46 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Parameter" + $ref: '#/components/schemas/Parameter' application/json: schema: type: array items: - "$ref": "#/components/schemas/Parameter" + $ref: '#/components/schemas/Parameter' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timezones": + /timezones: get: tags: - TimeZones @@ -1986,10 +2342,21 @@ paths: parameters: - name: format in: query - description: "Specifies the encoding format of the response. Valid value for - the format field for this URI are:\n* `tab` \n* `csv` \n* `xml` \n* `json` - \ (default)\n\nSee this page for more information - about accept header usage." + description: >- + Specifies the encoding format of the response. Valid value for the + format field for this URI are: + + * `tab` + + * `csv` + + * `xml` + + * `json` (default) + + + See this page for more information + about accept header usage. schema: type: string responses: @@ -1998,46 +2365,46 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeZoneIds" + $ref: '#/components/schemas/TimeZoneIds' application/json: schema: - "$ref": "#/components/schemas/TimeZoneIds" + $ref: '#/components/schemas/TimeZoneIds' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: The format requested is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/levels/{level-id}": + '/levels/{level-id}': get: tags: - Levels @@ -2059,35 +2426,52 @@ paths: type: string - name: effective-date in: query - description: Specifies the effective date of Location Level to be returned.Expected - formats are `YYYY-MM-DDTHH:MM` or `YYYY-MM-DDTHH:MM:SS` + description: >- + Specifies the effective date of Location Level to be + returned.Expected formats are `YYYY-MM-DDTHH:MM` or + `YYYY-MM-DDTHH:MM:SS` required: true schema: type: string + - name: date + in: query + description: >- + Specifies the effective date of Location Level that will be + returned. Deprecated, use effective-date instead + deprecated: true + schema: + type: string - name: use-exact-effective-date in: query - description: If true only a level with the exact provided date will be returned. - If false The most recent level on or before this time will be returned. - The default is false. + description: >- + If true only a level with the exact provided date will be returned. + If false The most recent level on or before this time will be + returned. The default is false. schema: type: boolean - name: timezone in: query - description: Specifies the time zone of the values of the effective date field - (unless otherwise specified), as well as the time zone of any times in the - response. If this field is not specified, the default time zone of UTC shall - be used. + description: >- + Specifies the time zone of the values of the effective date field + (unless otherwise specified), as well as the time zone of any times + in the response. If this field is not specified, the default time + zone of UTC shall be used. schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are:\n* `EN` Specifies English unit system. Location - level values will be in the default English units for their parameters.\n* - `SI` Specifies the SI unit system. Location level values will be in the - default SI units for their parameters.\n* `Other` Any unit returned in - the response to the units URI request that is appropriate for the requested - parameters. " + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` Specifies English unit system. Location level values will + be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location level values will be + in the default SI units for their parameters. + + * `Other` Any unit returned in the response to the units URI + request that is appropriate for the requested parameters. schema: type: string responses: @@ -2096,37 +2480,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/LocationLevel" + $ref: '#/components/schemas/LocationLevel' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -2150,22 +2534,33 @@ paths: type: boolean - name: office in: query - description: Specifies the owning office of the location level whose data - is to be deleted. If this field is not specified, matching location level + description: >- + Specifies the owning office of the location level whose data is to + be deleted. If this field is not specified, matching location level information will be deleted from all offices. schema: type: string - name: effective-date in: query - description: Specifies the effective date of the level to be deleted. If not + description: >- + Specifies the effective date of the level to be deleted. If not provided will delete all data and reference to the location level. schema: type: string + - name: date + in: query + description: >- + Specifies the effective date of Location Level that will be deleted. + Deprecated, use effective-date instead + deprecated: true + schema: + type: string - name: timezone in: query - description: Specifies the time zone of the value of the effective date field - (unless otherwise specified).If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the value of the effective date field + (unless otherwise specified).If this field is not specified, the + default time zone of UTC shall be used. schema: type: string responses: @@ -2174,31 +2569,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -2220,11 +2615,19 @@ paths: description: Specifies the effective date of Location Level that will be updated schema: type: string + - name: date + in: query + description: >- + Specifies the effective date of Location Level that will be updated. + Deprecated, use effective-date instead + deprecated: true + schema: + type: string requestBody: content: application/json: schema: - "$ref": "#/components/schemas/LocationLevel" + $ref: '#/components/schemas/LocationLevel' required: true responses: '400': @@ -2232,35 +2635,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/levels": + /levels: get: tags: - Levels @@ -2269,78 +2672,117 @@ paths: parameters: - name: level-id-mask in: query - description: Specifies the name(s) of the location level(s) whose data is - to be included in the response. Uses * for all. + description: >- + Specifies the name(s) of the location level(s) whose data is to be + included in the response. Uses * for all. + schema: + type: string + - name: name + in: query + description: >- + Specifies the name(s) of the location level(s) whose data is to be + included in the response. Uses * for all. Deprecated, use + level-id-mask instead + deprecated: true schema: type: string - name: office in: query - description: Specifies the owning office of the location level(s) whose data - is to be included in the response. If this field is not specified, matching - location level information from all offices shall be returned. + description: >- + Specifies the owning office of the location level(s) whose data is + to be included in the response. If this field is not specified, + matching location level information from all offices shall be + returned. schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are:\n* `EN` Specifies English unit system. Location - level values will be in the default English units for their parameters.\n* - `SI` Specifies the SI unit system. Location level values will be in the - default SI units for their parameters. \n\nThe default unit system is SI." + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` Specifies English unit system. Location level values will + be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location level values will be + in the default SI units for their parameters. + + + The default unit system is SI. schema: type: string - name: datum in: query - description: |- - Specifies the elevation datum of the response. This field affects only elevation location levels. Valid values for this field are: - * `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum. - * `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum. + description: >- + Specifies the elevation datum of the response. This field affects + only elevation location levels. Valid values for this field are: + + * `NAVD88` The elevation values will in the specified or default + units above the NAVD-88 datum. + + * `NGVD29` The elevation values will be in the specified or default + units above the NGVD-29 datum. schema: type: string - name: begin in: query - description: Specifies the start of the time window for data to be included - in the response. If this field is not specified, no beginning time will + description: >- + Specifies the start of the time window for data to be included in + the response. If this field is not specified, no beginning time will be used. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included - in the response. If this field is not specified, no end time will be used. + description: >- + Specifies the end of the time window for data to be included in the + response. If this field is not specified, no end time will be used. schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified), as well as the time zone of any times in the - response. If this field is not specified, the default time zone of UTC shall - be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified), as well as the time zone of any times + in the response. If this field is not specified, the default time + zone of UTC shall be used. schema: type: string - name: format in: query - description: |- - Specifies the encoding format of the response. Requests specifying an Accept header:application/json;version=2 must not include this field. Valid format field values for this URI are: + description: >- + Specifies the encoding format of the response. Requests specifying + an Accept header:application/json;version=2 must not include this + field. Valid format field values for this URI are: + * `tab` + * `csv` + * `xml` + * `wml2` (only if name field is specified) + * `json` (default) - - See this page for more information about accept header usage. + + + See this page for more information + about accept header usage. schema: type: string - name: include-aliases in: query - description: Whether to include the aliases for the location levels in the + description: >- + Whether to include the aliases for the location levels in the response. The default is false. schema: type: boolean - name: page in: query - description: This identifies where in the request you are. This is an opaque - value, and can be obtained from the 'next-page' value in the response. + description: >- + This identifies where in the request you are. This is an opaque + value, and can be obtained from the 'next-page' value in the + response. schema: type: string - name: page-size @@ -2355,43 +2797,43 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' '': schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/json;version=2: schema: - "$ref": "#/components/schemas/LocationLevels" + $ref: '#/components/schemas/LocationLevels' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -2405,7 +2847,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LocationLevel" + $ref: '#/components/schemas/LocationLevel' required: true responses: '400': @@ -2413,35 +2855,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/levels/{level-id}/timeseries": + '/levels/{level-id}/timeseries': get: tags: - Levels @@ -2463,35 +2905,38 @@ paths: type: string - name: interval in: query - description: 'Interval time step for the returned time series. Pseudo-regular - interval definitions will be treated like local regular. Irregular interval - will generate daily time steps. Default: 0' + description: >- + Interval time step for the returned time series. Pseudo-regular + interval definitions will be treated like local regular. Irregular + interval will generate daily time steps. Default: 0 schema: type: string - name: begin in: query - description: Specifies the start of the time window for data to be included - in the response. If this field is not specified, any required time window - begins 24 hours prior to the specified or default end time. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + Specifies the start of the time window for data to be included in + the response. If this field is not specified, any required time + window begins 24 hours prior to the specified or default end time. + The format for this field is ISO 8601 + extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included - in the response. If this field is not specified, any required time window - ends at the current time. The format for this field - is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'. + description: >- + Specifies the end of the time window for data to be included in the + response. If this field is not specified, any required time window + ends at the current time. The format for this + field is ISO 8601 extended, with optional offset and timezone, + i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: timezone in: query - description: "Specifies the time zone of the values of the begin and end fields - (unless otherwise specified), as well as the time zone of any times in the - response. If this field is not specified, the default time zone of UTC shall - be used.\r\nIgnored if begin was specified with offset and timezone." + description: "Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone." schema: type: string - name: unit @@ -2502,54 +2947,53 @@ paths: type: string responses: '200': - description: A CWMS Time Series representation of the specified location - level. + description: A CWMS Time Series representation of the specified location level. content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/json: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' '': schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a timeseries. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -2564,13 +3008,15 @@ paths: parameters: - name: level-id-mask in: query - description: Specifies the name(s) of the location level(s) whose data is to be + description: >- + Specifies the name(s) of the location level(s) whose data is to be included in the response. Uses * for all. schema: type: string - name: office in: query - description: Specifies the owning office of the location level(s) whose data is + description: >- + Specifies the owning office of the location level(s) whose data is to be included in the response. If this field is not specified, matching location level information from all offices shall be returned. @@ -2578,20 +3024,23 @@ paths: type: string - name: begin in: query - description: Specifies the start of the time window for data to be included in + description: >- + Specifies the start of the time window for data to be included in the response. If this field is not specified, no beginning time will be used. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included in the + description: >- + Specifies the end of the time window for data to be included in the response. If this field is not specified, no end time will be used. schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields + description: >- + Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response. If this field is not specified, the default time zone of UTC shall be used. @@ -2599,13 +3048,15 @@ paths: type: string - name: include-aliases in: query - description: Whether to include the aliases for the location levels in the + description: >- + Whether to include the aliases for the location levels in the response. The default is false. schema: type: boolean - name: page in: query - description: This identifies where in the request you are. This is an opaque + description: >- + This identifies where in the request you are. This is an opaque value, and can be obtained from the 'next-page' value in the response. schema: @@ -2617,52 +3068,54 @@ paths: type: integer format: int32 responses: - "200": + '200': description: OK content: - "": + '': schema: - $ref: "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/json;version=1: schema: - $ref: "#/components/schemas/LocationLevelRefs" - "*/*": + $ref: '#/components/schemas/LocationLevelRefs' + '*/*': schema: - $ref: "#/components/schemas/LocationLevelRefs" + $ref: '#/components/schemas/LocationLevelRefs' application/json: schema: - $ref: "#/components/schemas/LocationLevelRefs" - "400": + $ref: '#/components/schemas/LocationLevelRefs' + '400': description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "401": + $ref: '#/components/schemas/CdaError' + '401': description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "403": + $ref: '#/components/schemas/CdaError' + '403': description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "404": + $ref: '#/components/schemas/CdaError' + '404': description: Not Found content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "500": + $ref: '#/components/schemas/CdaError' + '500': description: Server Error content: application/json: schema: - $ref: "#/components/schemas/CdaError" - security: [] + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] /timeseries/recent: get: tags: @@ -2673,36 +3126,42 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the timeseries group(s) whose - data is to be included in the response. If this field is not specified, - matching timeseries groups information from all offices shall be returned. + description: >- + Specifies the owning office of the timeseries group(s) whose data is + to be included in the response. If this field is not specified, + matching timeseries groups information from all offices shall be + returned. schema: type: string - name: category-id in: query - description: Specifies the category id of the timeseries to be included in - the response. Optional. + description: >- + Specifies the category id of the timeseries to be included in the + response. Optional. schema: type: string - name: group-id in: query - description: Specifies the group id of the timeseries to be included in the + description: >- + Specifies the group id of the timeseries to be included in the response. Optional. schema: type: string - name: ts-ids in: query - description: Accepts a comma separated list of timeseries ids to be included - in the response. Optional. Cannot be used in combination with category_id - and group_id. + description: >- + Accepts a comma separated list of timeseries ids to be included in + the response. Optional. Cannot be used in combination with + category_id and group_id. schema: type: string - name: unit-system in: query - description: Unit System desired in response. Can be SI (International Scientific) - or EN (Imperial.) If unspecified, defaults to EN. + description: >- + Unit System desired in response. Can be SI (International + Scientific) or EN (Imperial.) If unspecified, defaults to EN. schema: - "$ref": "#/components/schemas/UnitSystem" + $ref: '#/components/schemas/UnitSystem' responses: '200': description: OK @@ -2711,44 +3170,45 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Tsv" + $ref: '#/components/schemas/RecentValue' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the timeseries - group(s) were not found. + description: >- + Based on the combination of inputs provided the timeseries group(s) + were not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/filtered": + /timeseries/filtered: get: tags: - TimeSeries @@ -2757,107 +3217,154 @@ paths: parameters: - name: name in: query - description: Specifies the name of the time series whose data is to be included - in the response. A case insensitive comparison is used to match names. + description: >- + Specifies the name of the time series whose data is to be included + in the response. A case insensitive comparison is used to match + names. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the time series(s) whose data - is to be included in the response. Required for:application/json;version=2 - and application/xml;version=2. For other formats, if this field is not specified, - matching location level information from all offices shall be returned. + description: >- + Specifies the owning office of the time series(s) whose data is to + be included in the response. Required for:application/json;version=2 + and application/xml;version=2. For other formats, if this field is + not specified, matching location level information from all offices + shall be returned. schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are: \n* `EN` (default) Specifies English unit system. - \ Location level values will be in the default English units for their parameters.\n* - `SI` Specifies the SI unit system. Location level values will be in the - default SI units for their parameters.\n* `Other` Any unit returned in - the response to the units URI request that is appropriate for the requested - parameters." + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` (default) Specifies English unit system. Location level + values will be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location level values will be + in the default SI units for their parameters. + + * `Other` Any unit returned in the response to the units URI + request that is appropriate for the requested parameters. schema: type: string - name: version-date in: query - description: Specifies the version date of a time series trace to be selected. - The format for this field is ISO 8601 extended, - with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'. If field is empty, query will return - a max aggregate for the timeseries. Only supported for:application/json;version=2 - and application/xml;version=2 + description: >- + Specifies the version date of a time series trace to be selected. + The format for this field is ISO 8601 + extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. If field is empty, query will return a + max aggregate for the timeseries. Only supported + for:application/json;version=2 and application/xml;version=2 schema: type: string - name: begin in: query - description: Specifies the start of the time window for data to be included - in the response. If this field is not specified, any required time window - begins 24 hours prior to the specified or default end time. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + Specifies the start of the time window for data to be included in + the response. If this field is not specified, any required time + window begins 24 hours prior to the specified or default end time. + The format for this field is ISO 8601 + extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included - in the response. If this field is not specified, any required time window - ends at the current time. The format for this field - is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'. + description: >- + Specifies the end of the time window for data to be included in the + response. If this field is not specified, any required time window + ends at the current time. The format for this + field is ISO 8601 extended, with optional offset and timezone, + i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: timezone in: query - description: "Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). For application/json;version=2 and application/xml;version=2 - the results are returned in UTC. For other formats this parameter affects - the time zone of times in the response. If this field is not specified, - the default time zone of UTC shall be used.\r\nIgnored if begin was specified - with offset and timezone." + description: "Specifies the time zone of the values of the begin and end fields (unless otherwise specified). For application/json;version=2 and application/xml;version=2 the results are returned in UTC. For other formats this parameter affects the time zone of times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone." schema: type: string - name: trim in: query - description: Specifies whether to trim missing values from the beginning and - end of the retrieved values. Only supported for:application/json;version=2 - and application/xml;version=2. Default is true. + description: >- + Specifies whether to trim missing values from the beginning and end + of the retrieved values. When true and values are returned, the + contained time-series begin and end fields reflect the returned data + window. Only supported for:application/json;version=2 and + application/xml;version=2. Default is true. schema: type: boolean - name: include-entry-date in: query - description: Specifies whether to include the data entry date of each value - in the response. Including the data entry date will increase the size of - the array containing each data value from three to four, changing the format - of the response. Default is false. + description: >- + Specifies whether to include the data entry date of each value in + the response. Including the data entry date will increase the size + of the array containing each data value from three to four, changing + the format of the response. Default is false. schema: type: boolean - name: query in: query - description: |- - Specifies an RSQL-like query string to filter the results. Expressions may reference "value, date_time, quality, data_entry_date". Example Queries: + description: >- + Specifies an RSQL-like query string to filter + the results. Expressions may reference "value, date_time, quality, + data_entry_date". Example Queries: + * `value!=null` Excludes null values - * `date_time>2020-04-01T00:00:00Z and date_time<2024-04-01T00:00:00Z` Returns values within a date range. - * `data_entry_date=2025-05-15T00:00:00Z` Returns data entered at a specific data_entry_date - * `value>=0 and value < 215.0` Returns points when the value is within a specified range. - * `value<0 or value > 215.0` Returns points when the value is outside a specified range. - * `(value==null or value<0) and date_time>2019-11-01T00:00:00Z and data_entry_date>2024-03-01T00:00:00Z and data_entry_date<2024-04-01T00:00:00Z` Find null or negative values for times after start of pandemic that were entered in March 2024. - * `quality=in=(255,256,1023,1024)` Returns points with specific quality codes. + + * `date_time>2020-04-01T00:00:00Z and + date_time<2024-04-01T00:00:00Z` Returns values within a date range. + + * `data_entry_date=2025-05-15T00:00:00Z` Returns data entered at a + specific data_entry_date + + * `value>=0 and value < 215.0` Returns points when the value is + within a specified range. + + * `value<0 or value > 215.0` Returns points when the value is + outside a specified range. + + * `(value==null or value<0) and date_time>2019-11-01T00:00:00Z and + data_entry_date>2024-03-01T00:00:00Z and + data_entry_date<2024-04-01T00:00:00Z` Find null or negative values + for times after start of pandemic that were entered in March 2024. + + * `quality=in=(255,256,1023,1024)` Returns points with specific + quality codes. schema: type: string - name: page in: query - description: This end point can return large amounts of data as a series of - pages. This parameter is used to describes the current location in the response - stream. This is an opaque value, and can be obtained from the 'next-page' - value in the response. + description: >- + This end point can return large amounts of data as a series of + pages. This parameter is used to describes the current location in + the response stream. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size in: query - description: How many entries per page returned. Default 500. + description: >- + How many entries per page returned. Default 500. Use 0 to return an + empty values array, or -1 to return the entire window in one + response without a next-page cursor. Values less than -1 are + invalid. schema: type: integer format: int32 @@ -2867,55 +3374,55 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/json: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' '': schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a timeseries. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/standard-text-id/{standard-text-id}": + '/standard-text-id/{standard-text-id}': get: tags: - Standard Text @@ -2925,14 +3432,16 @@ paths: parameters: - name: standard-text-id in: path - description: Specifies the text id of the standard text to retrieve. Default + description: >- + Specifies the text id of the standard text to retrieve. Default includes all text ids required: true schema: type: string - name: office in: query - description: Specifies the owning office of thestandard text. Default includes + description: >- + Specifies the owning office of thestandard text. Default includes all offices required: true schema: @@ -2943,37 +3452,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/StandardTextValue" + $ref: '#/components/schemas/StandardTextValue' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3001,42 +3510,42 @@ paths: description: Specifies the delete method used. required: true schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/standard-text-id": + /standard-text-id: get: tags: - Standard Text @@ -3054,43 +3563,51 @@ paths: description: Specifies the text id filter of the standard text schema: type: string + - name: name-mask + in: query + description: >- + Specifies the text id filter of the standard text. Deprecated, use + standard-text-id-mask + deprecated: true + schema: + type: string responses: '200': description: OK content: application/json;version=2: schema: - "$ref": "#/components/schemas/StandardTextCatalog" + $ref: '#/components/schemas/StandardTextCatalog' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3110,7 +3627,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/StandardTextValue" + $ref: '#/components/schemas/StandardTextValue' required: true responses: '400': @@ -3118,47 +3635,50 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/text": + /timeseries/text: get: tags: - Text-TimeSeries - summary: Retrieve text time series values for a provided time window and date - version.If individual values exceed 64 kilobytes, a URL to a separate download - is provided instead of being included in the returned payload from this request. + summary: >- + Retrieve text time series values for a provided time window and date + version.If individual values exceed 64 kilobytes, a URL to a separate + download is provided instead of being included in the returned payload + from this request. operationId: getTimeseriesText parameters: - name: office in: query - description: Specifies the owning office of the Text TimeSeries whose data - is to be included in the response. + description: >- + Specifies the owning office of the Text TimeSeries whose data is to + be included in the response. required: true schema: type: string @@ -3170,9 +3690,17 @@ paths: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. + schema: + type: string + - name: version-date + in: query + description: >- + Specifies the version date of the text timeseries. If not specified, + the latest version will be used. schema: type: string - name: begin @@ -3193,37 +3721,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TextTimeSeries" + $ref: '#/components/schemas/TextTimeSeries' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3236,7 +3764,8 @@ paths: parameters: - name: replace-all in: query - description: Whether to replace any and all existing text with the specified + description: >- + Whether to replace any and all existing text with the specified text. Default is false schema: type: boolean @@ -3244,7 +3773,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TextTimeSeries" + $ref: '#/components/schemas/TextTimeSeries' required: true responses: '400': @@ -3252,35 +3781,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/text/{name}": + '/timeseries/text/{name}': delete: tags: - Text-TimeSeries @@ -3296,24 +3825,28 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the timeseries identifier to be + description: >- + Specifies the owning office of the timeseries identifier to be deleted required: true schema: type: string - name: text-mask in: query - description: The standard text pattern to match. Use glob-style wildcard characters - instead of sql-style wildcard characters for pattern matching. For StandardTextTimeSeries - this should be the Standard_Text_Id (such as 'E' for ESTIMATED) + description: >- + The standard text pattern to match. Use glob-style wildcard + characters instead of sql-style wildcard characters for pattern + matching. For StandardTextTimeSeries this should be the + Standard_Text_Id (such as 'E' for ESTIMATED) required: true schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. schema: type: string - name: begin @@ -3330,7 +3863,8 @@ paths: type: string - name: version-date in: query - description: The version date for the time series. If not specified, maximum + description: >- + The version date for the time series. If not specified, maximum version date is used. schema: type: string @@ -3340,31 +3874,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3383,7 +3917,8 @@ paths: type: string - name: replace-all in: query - description: Whether to replace any and all existing text with the specified + description: >- + Whether to replace any and all existing text with the specified text. Default is:true schema: type: boolean @@ -3391,7 +3926,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TextTimeSeries" + $ref: '#/components/schemas/TextTimeSeries' required: true responses: '400': @@ -3399,35 +3934,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/text/{name}/value": + '/timeseries/text/{name}/value': get: tags: - Text-TimeSeries @@ -3442,33 +3977,18 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the Text TimeSeries whose data - is to be included in the response. - required: true - schema: - type: string - - name: timezone - in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. - schema: - type: string - - name: date - in: query - description: The date of the text value to retrieve + description: >- + Specifies the owning office of the Text TimeSeries whose data is to + be included in the response. required: true schema: type: string - - name: version-date - in: query - description: The version date for the value to retrieve. - schema: - type: string - name: clob-id in: query - description: Will be removed in a schema update. This is a placeholder for + description: >- + Will be removed in a schema update. This is a placeholder for integration testing with schema 23.3.16 + required: true deprecated: true schema: type: string @@ -3484,47 +4004,50 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/binary": + /timeseries/binary: get: tags: - Binary-TimeSeries - summary: Retrieve binary time series values for a provided time window and date - version.If individual values exceed 64 kilobytes, a URL to a separate download - is provided instead of being included in the returned payload from this request. + summary: >- + Retrieve binary time series values for a provided time window and date + version.If individual values exceed 64 kilobytes, a URL to a separate + download is provided instead of being included in the returned payload + from this request. operationId: getTimeseriesBinary parameters: - name: office in: query - description: Specifies the owning office of the Binary TimeSeries whose data - is to be included in the response. + description: >- + Specifies the owning office of the Binary TimeSeries whose data is + to be included in the response. required: true schema: type: string @@ -3536,17 +4059,19 @@ paths: type: string - name: binary-type-mask in: query - description: The data type pattern expressed as either an internet media type - (e.g. 'image/*') or a file extension (e.g. '.*'). Use glob-style wildcard - characters as shown above instead of sql-style wildcard characters for pattern - matching. Default is:* + description: >- + The data type pattern expressed as either an internet media type + (e.g. 'image/*') or a file extension (e.g. '.*'). Use glob-style + wildcard characters as shown above instead of sql-style wildcard + characters for pattern matching. Default is:* schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. schema: type: string - name: begin @@ -3572,37 +4097,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/BinaryTimeSeries" + $ref: '#/components/schemas/BinaryTimeSeries' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3621,7 +4146,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/BinaryTimeSeries" + $ref: '#/components/schemas/BinaryTimeSeries' required: true responses: '400': @@ -3629,35 +4154,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/binary/{name}": + '/timeseries/binary/{name}': delete: tags: - Binary-TimeSeries @@ -3673,24 +4198,27 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the timeseries identifier to be + description: >- + Specifies the owning office of the timeseries identifier to be deleted required: true schema: type: string - name: binary-type-mask in: query - description: The data type pattern expressed as either an internet media type - (e.g. 'image/*') or a file extension (e.g. '.*'). Use glob-style wildcard - characters as shown above instead of sql-style wildcard characters for pattern - matching. Default:* + description: >- + The data type pattern expressed as either an internet media type + (e.g. 'image/*') or a file extension (e.g. '.*'). Use glob-style + wildcard characters as shown above instead of sql-style wildcard + characters for pattern matching. Default:* schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. schema: type: string - name: begin @@ -3707,8 +4235,9 @@ paths: type: string - name: version-date in: query - description: The version date for the time series. If not specified, the - maximum version date is used. + description: >- + The version date for the time series. If not specified, the maximum + version date is used. schema: type: string responses: @@ -3717,31 +4246,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3766,7 +4295,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/BinaryTimeSeries" + $ref: '#/components/schemas/BinaryTimeSeries' required: true responses: '400': @@ -3774,35 +4303,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/binary/{name}/value": + '/timeseries/binary/{name}/value': get: tags: - Binary-TimeSeries @@ -3811,39 +4340,24 @@ paths: parameters: - name: name in: path - description: Specifies the id of the binary timeseries - required: true - schema: - type: string - - name: office - in: query - description: Specifies the owning office of the Binary TimeSeries whose data - is to be included in the response. - required: true - schema: - type: string - - name: timezone - in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. - schema: - type: string - - name: date - in: query - description: The date of the binary value to retrieve + description: Specifies the id of the binary timeseries required: true schema: type: string - - name: version-date + - name: office in: query - description: The version date for the value to retrieve. + description: >- + Specifies the owning office of the Binary TimeSeries whose data is + to be included in the response. + required: true schema: type: string - name: blob-id in: query - description: Will be removed in a schema update. This is a placeholder for + description: >- + Will be removed in a schema update. This is a placeholder for integration testing with schema 23.3.16 + required: true deprecated: true schema: type: string @@ -3860,35 +4374,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/profile/{location-id}/{parameter-id}": + '/timeseries/profile/{location-id}/{parameter-id}': get: tags: - TimeSeries @@ -3910,6 +4424,7 @@ paths: - name: office in: query description: The office ID associated with the time series profile + required: true schema: type: string responses: @@ -3918,40 +4433,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TimeSeriesProfile" + $ref: '#/components/schemas/TimeSeriesProfile' application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfile" + $ref: '#/components/schemas/TimeSeriesProfile' '400': description: Invalid input content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -3976,6 +4491,7 @@ paths: - name: office in: query description: The office associated with the time series profile + required: true schema: type: string responses: @@ -3986,37 +4502,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Time series profile not found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Internal server error security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/profile": + /timeseries/profile: get: tags: - TimeSeries @@ -4035,8 +4551,7 @@ paths: type: string - name: parameter-id-mask in: query - description: The key parameter mask for the time series profile. Default is - * + description: The key parameter mask for the time series profile. Default is * schema: type: string - name: page @@ -4055,40 +4570,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TimeSeriesProfileList" + $ref: '#/components/schemas/TimeSeriesProfileList' application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfileList" + $ref: '#/components/schemas/TimeSeriesProfileList' '400': description: Invalid input content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: No data matching input parameters found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -4100,7 +4615,8 @@ paths: parameters: - name: fail-if-exists in: query - description: If true, the parser will fail to save if the TimeSeriesProfile + description: >- + If true, the parser will fail to save if the TimeSeriesProfile already exists. Default true. schema: type: boolean @@ -4108,42 +4624,42 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfile" + $ref: '#/components/schemas/TimeSeriesProfile' responses: '400': description: Invalid input content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/profile-parser/{location-id}/{parameter-id}": + '/timeseries/profile-parser/{location-id}/{parameter-id}': get: tags: - TimeSeries @@ -4174,41 +4690,42 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TimeSeriesProfileParser" + $ref: '#/components/schemas/TimeSeriesProfileParser' application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfileParser" + $ref: '#/components/schemas/TimeSeriesProfileParser' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a TimeSeriesProfileParser - object + description: >- + The provided combination of parameters did not find a + TimeSeriesProfileParser object content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -4246,59 +4763,59 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided ID did not find a TimeSeriesProfileParser object content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/profile-parser": + /timeseries/profile-parser: get: tags: - TimeSeries - summary: Retrieve a list of TimeSeries Profile Parsers that match the provided + summary: >- + Retrieve a list of TimeSeries Profile Parsers that match the provided mask parameters operationId: getTimeseriesProfileParser parameters: - name: parameter-id-mask in: query - description: The ID mask of the TimeSeriesProfileParser parameter. Default - is * + description: The ID mask of the TimeSeriesProfileParser parameter. Default is * schema: type: string - name: office-mask in: query - description: The office mask associated with the TimeSeriesProfile. Default - is * + description: The office mask associated with the TimeSeriesProfile. Default is * schema: type: string - name: location-mask in: query - description: The location ID mask associated with the TimeSeriesProfile. Default + description: >- + The location ID mask associated with the TimeSeriesProfile. Default is * schema: type: string @@ -4310,43 +4827,44 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/TimeSeriesProfileParser" + $ref: '#/components/schemas/TimeSeriesProfileParser' application/json: schema: type: array items: - "$ref": "#/components/schemas/TimeSeriesProfileParser" + $ref: '#/components/schemas/TimeSeriesProfileParser' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a TimeSeriesProfileParser - object + description: >- + The provided combination of parameters did not find a + TimeSeriesProfileParser object content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -4360,7 +4878,8 @@ paths: parameters: - name: fail-if-exists in: query - description: If true, the parser will fail to save if the TimeSeriesProfileParser + description: >- + If true, the parser will fail to save if the TimeSeriesProfileParser already exists schema: type: boolean @@ -4368,10 +4887,10 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TimeSeriesProfileParserIndexed" + $ref: '#/components/schemas/TimeSeriesProfileParserIndexed' application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfileParserColumnar" + $ref: '#/components/schemas/TimeSeriesProfileParserColumnar' required: true responses: '400': @@ -4379,35 +4898,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/profile-instance/{location-id}/{parameter-id}/{version}": + '/timeseries/profile-instance/{location-id}/{parameter-id}/{version}': get: tags: - TimeSeries @@ -4440,55 +4959,65 @@ paths: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. schema: type: string - name: version-date in: query - description: The version date of the time series profile instance. Accepts - ISO8601 formats. Default is the min or max version date, depending on the - maxVersion + description: >- + The version date of the time series profile instance. Accepts + ISO8601 formats. Default is the min or max version date, depending + on the maxVersion schema: type: string format: date-time - name: unit in: query - description: The units of the time series profile instance. Provided as a - list separated by ',' + description: >- + The units of the time series profile instance. Provided as a list + separated by ',' required: true schema: type: string - name: start-time-inclusive in: query - description: The start inclusive of the time series profile instance. Default - is true + description: >- + The start inclusive of the time series profile instance. Default is + true schema: type: boolean - name: end-time-inclusive in: query - description: The end inclusive of the time series profile instance. Default - is true + description: >- + The end inclusive of the time series profile instance. Default is + true schema: type: boolean - name: previous in: query - description: Whether to include the previous time window of the time series + description: >- + Whether to include the data point with the closest timestamp prior + to the specified start of the time window for the time series profile instance. Default is false schema: type: boolean - name: next in: query - description: Whether to include the next time window of the time series profile + description: >- + Whether to include the data point with the closest timestamp after + the specified end of the time window for the time series profile instance. Default is false schema: type: boolean - name: max-version in: query - description: Whether to use the max version date of the time series profile - instance. Default is false. If no version date is provided, and maxVersion - is false, the min version date will be used. + description: >- + Whether to use the max version date of the time series profile + instance. Default is false. If no version date is provided, and + maxVersion is false, the min version date will be used. schema: type: boolean - name: start @@ -4512,8 +5041,7 @@ paths: type: string - name: page-size in: query - description: The page size of the time series profile instance. Default is - 500 + description: The page size of the time series profile instance. Default is 500 schema: type: integer format: int32 @@ -4523,40 +5051,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TimeSeriesProfileInstance" + $ref: '#/components/schemas/TimeSeriesProfileInstance' application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfileInstance" + $ref: '#/components/schemas/TimeSeriesProfileInstance' '400': description: Invalid input content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -4592,13 +5120,16 @@ paths: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields. - If this field is not specified, the default time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields. + If this field is not specified, the default time zone of UTC shall + be used. schema: type: string - name: version-date in: query - description: The version date of the time series profile instance. Accepts + description: >- + The version date of the time series profile instance. Accepts ISO8601 format. required: true schema: @@ -4613,8 +5144,9 @@ paths: format: date-time - name: override-protection in: query - description: Override protection for the time series profile instance. Default - is true + description: >- + Override protection for the time series profile instance. Default is + true schema: type: boolean responses: @@ -4623,66 +5155,67 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/profile-instance": + /timeseries/profile-instance: get: tags: - TimeSeries - summary: Get all time series profile instances that match the provided masks. - This endpoint will return a list of time series profile instances without - the associated data. Data for an instance can be retrieved using the singular - retrieval endpoint. + summary: >- + Get all time series profile instances that match the provided masks. + This endpoint will return a list of time series profile instances + without the associated data. Data for an instance can be retrieved using + the singular retrieval endpoint. operationId: getTimeseriesProfileInstance parameters: - name: office-mask in: query - description: The office mask of the time series profile instance. Default - is * + description: The office mask of the time series profile instance. Default is * schema: type: string - name: location-mask in: query - description: The location ID mask of the time series profile instance. Default - is * + description: >- + The location ID mask of the time series profile instance. Default is + * schema: type: string - name: parameter-id-mask in: query - description: The parameter ID mask of the time series profile instance. Default + description: >- + The parameter ID mask of the time series profile instance. Default is * schema: type: string - name: version-mask in: query - description: The version mask of the time series profile instance. Default - is * + description: The version mask of the time series profile instance. Default is * schema: type: string responses: @@ -4691,40 +5224,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TimeSeriesProfileInstance" + $ref: '#/components/schemas/TimeSeriesProfileInstance' application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfileInstance" + $ref: '#/components/schemas/TimeSeriesProfileInstance' '400': description: Invalid input content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -4736,19 +5269,27 @@ paths: parameters: - name: method in: query - description: The method of storing the time series profile instance. Default - is REPLACE_ALL + description: >- + The method of storing the time series profile instance. Default is + REPLACE_ALL schema: - "$ref": "#/components/schemas/StoreRule" + $ref: '#/components/schemas/StoreRule' - name: override-protection in: query - description: Override protection for the time series profile instance. Default - is false + description: >- + Override protection for the time series profile instance. Default is + false schema: type: boolean + - name: timezone + in: query + description: "Specifies the time zone of the values of version-date fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if version-date was specified with offset and timezone." + schema: + type: string - name: version-date in: query - description: The version date of the time series profile instance. Accepts + description: >- + The version date of the time series profile instance. Accepts ISO8601 format. required: true schema: @@ -4770,7 +5311,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesProfile" + $ref: '#/components/schemas/TimeSeriesProfile' responses: '201': description: Time series profile instance created @@ -4779,25 +5320,25 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '409': description: Time series profile instance already exists '500': @@ -4805,11 +5346,11 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/category/{category-id}": + '/timeseries/category/{category-id}': get: tags: - TimeSeries Categories @@ -4825,8 +5366,9 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the timeseries category whose - data is to be included in the response. + description: >- + Specifies the owning office of the timeseries category whose data is + to be included in the response. required: true schema: type: string @@ -4836,38 +5378,39 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesCategory" + $ref: '#/components/schemas/TimeSeriesCategory' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the timeseries - category was not found. + description: >- + Based on the combination of inputs provided the timeseries category + was not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -4888,52 +5431,112 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the time series category to be + description: >- + Specifies the owning office of the time series category to be deleted required: true schema: type: string - name: cascade-delete in: query - description: 'Specifies whether to delete any time series groups in this time - series category. Default: false' + description: >- + Specifies whether to delete any time series groups in this time + series category. Default: false + schema: + type: boolean + responses: + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + patch: + tags: + - TimeSeries Categories + summary: Patch timeseries category with categoryId + description: Update existing TimeSeriesCategory. Allows for renaming of the category. + operationId: patchTimeseriesCategoryWithCategoryId + parameters: + - name: category-id + in: path + description: Specifies the original timeseries category to rename. + required: true + schema: + type: string + - name: ignore-nulls + in: query + description: 'Ignore null values in the request body. Default: true' schema: type: boolean + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TimeSeriesCategory' + required: true responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/category": + /timeseries/category: get: tags: - TimeSeries Categories @@ -4943,9 +5546,11 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the timeseries category(ies) whose - data is to be included in the response. If this field is not specified, - matching timeseries category information from all offices shall be returned. + description: >- + Specifies the owning office of the timeseries category(ies) whose + data is to be included in the response. If this field is not + specified, matching timeseries category information from all offices + shall be returned. schema: type: string responses: @@ -4956,38 +5561,39 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/TimeSeriesCategory" + $ref: '#/components/schemas/TimeSeriesCategory' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the categories - were not found. + description: >- + Based on the combination of inputs provided the categories were not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -5005,11 +5611,16 @@ paths: description: 'Create will fail if provided ID already exists. Default: true' schema: type: boolean + - name: ignore-nulls + in: query + description: 'Ignore null values in the request body. Default: true' + schema: + type: boolean requestBody: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesCategory" + $ref: '#/components/schemas/TimeSeriesCategory' required: true responses: '400': @@ -5017,35 +5628,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/identifier-descriptor/{timeseries-id}": + '/timeseries/identifier-descriptor/{timeseries-id}': get: tags: - TimeSeries Identifier @@ -5055,14 +5666,16 @@ paths: parameters: - name: timeseries-id in: path - description: Specifies the identifier of the timeseries to be included in - the response. + description: >- + Specifies the identifier of the timeseries to be included in the + response. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the timeseries identifier to be + description: >- + Specifies the owning office of the timeseries identifier to be included in the response. required: true schema: @@ -5073,38 +5686,39 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeriesIdentifierDescriptor" + $ref: '#/components/schemas/TimeSeriesIdentifierDescriptor' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the timeseries + description: >- + Based on the combination of inputs provided the timeseries identifier descriptor was not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -5134,38 +5748,38 @@ paths: description: Specifies the delete method used. required: true schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -5188,44 +5802,50 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the timeseries identifier to be + description: >- + Specifies the owning office of the timeseries identifier to be updated required: true schema: type: string - name: timeseries-id in: query - description: A new timeseries-id. If specified a rename operation will be - performed and snap-forward, snap-backward, and active must not be provided + description: >- + A new timeseries-id. If specified a rename operation will be + performed and snap-forward, snap-backward, and active must not be + provided schema: type: string - name: interval-offset in: query - description: The offset into the data interval in minutes. If specified and - a new timeseries-id is also specified both will be passed to a rename operation. May - also be passed to update operation. + description: >- + The offset into the data interval in minutes. If specified and a + new timeseries-id is also specified both will be passed to a rename + operation. May also be passed to update operation. schema: type: integer format: int64 - name: snap-forward in: query - description: The new snap forward tolerance in minutes. This specifies how - many minutes before the expected data time that data will be considered + description: >- + The new snap forward tolerance in minutes. This specifies how many + minutes before the expected data time that data will be considered to be on time. schema: type: integer format: int64 - name: snap-backward in: query - description: The new snap backward tolerance in minutes. This specifies how - many minutes after the expected data time that data will be considered to + description: >- + The new snap backward tolerance in minutes. This specifies how many + minutes after the expected data time that data will be considered to be on time. schema: type: integer format: int64 - name: active in: query - description: "'True' or 'true' if the time series is active" + description: '''True'' or ''true'' if the time series is active' schema: type: boolean responses: @@ -5234,68 +5854,74 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/identifier-descriptor": + /timeseries/identifier-descriptor: get: tags: - TimeSeries Identifier summary: Get timeseries identifierDescriptor - description: Returns CWMS timeseries identifier descriptorData. Currently includes + description: >- + Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results. operationId: getTimeseriesIdentifierDescriptor parameters: - name: office in: query - description: Specifies the owning office of the timeseries identifier(s) whose - data is to be included in the response. If this field is not specified, - matching timeseries identifier information from all offices shall be returned. + description: >- + Specifies the owning office of the timeseries identifier(s) whose + data is to be included in the response. If this field is not + specified, matching timeseries identifier information from all + offices shall be returned. schema: type: string - name: timeseries-id-regex in: query - description: A case insensitive RegExp that will be applied to the timeseries-id - field. If this field is not specified the results will not be constrained - by timeseries-id. + description: >- + A case insensitive RegExp that will be applied to the timeseries-id + field. If this field is not specified the results will not be + constrained by timeseries-id. schema: type: string - name: include-aliases in: query - description: Specifies whether to include aliased items as content in the + description: >- + Specifies whether to include aliased items as content in the results. Default is false. schema: type: boolean - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. schema: type: string - name: page-size @@ -5310,38 +5936,39 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeriesIdentifierDescriptors" + $ref: '#/components/schemas/TimeSeriesIdentifierDescriptors' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the time series + description: >- + Based on the combination of inputs provided the time series identifier descriptors were not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -5363,10 +5990,10 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeriesIdentifierDescriptor" + $ref: '#/components/schemas/TimeSeriesIdentifierDescriptor' application/xml;version=2: schema: - "$ref": "#/components/schemas/TimeSeriesIdentifierDescriptor" + $ref: '#/components/schemas/TimeSeriesIdentifierDescriptor' required: true responses: '400': @@ -5374,35 +6001,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/group/{group-id}": + '/timeseries/group/{group-id}': get: tags: - Timeseries Groups @@ -5412,36 +6039,36 @@ paths: parameters: - name: group-id in: path - description: Specifies the timeseries group whose data is to be included in - the response + description: >- + Specifies the timeseries group whose data is to be included in the + response required: true schema: type: string - name: office in: query - description: Specifies the owning office of the timeseries assigned to the - group whose data is to be included in the response. This will limit the - assigned timeseries returned to only those assigned to the specified office. - required: true + description: >- + Specifies the owning office of the timeseries assigned to the group + whose data is to be included in the response. This will limit the + assigned timeseries returned to only those assigned to the specified + office. schema: type: string - name: category-office-id in: query description: Specifies the owning office of the timeseries group category - required: true schema: type: string - name: group-office-id in: query description: Specifies the owning office of the timeseries group - required: true schema: type: string - name: category-id in: query - description: Specifies the category containing the timeseries group whose - data is to be included in the response. - required: true + description: >- + Specifies the category containing the timeseries group whose data is + to be included in the response. schema: type: string responses: @@ -5450,37 +6077,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesGroup" + $ref: '#/components/schemas/TimeSeriesGroup' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -5499,8 +6126,9 @@ paths: type: string - name: category-id in: query - description: Specifies the time series category of the time series group to - be deleted + description: >- + Specifies the time series category of the time series group to be + deleted required: true schema: type: string @@ -5510,37 +6138,44 @@ paths: required: true schema: type: string + - name: cascade-delete + in: query + description: >- + Specifies whether to unassign time series in this group before + deleting. Default: false + schema: + type: boolean responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -5548,26 +6183,33 @@ paths: tags: - Timeseries Groups summary: Patch timeseries group with groupId - description: Update existing TimeSeriesGroup. Allows for renaming of the group, - assigning new time series, and unassigning all time series from the group. + description: >- + Update existing TimeSeriesGroup. Allows for renaming of the group, + assigning new time series, and unassigning all time series from the + group. operationId: patchTimeseriesGroupWithGroupId parameters: - name: group-id in: path + description: Specifies the original timeseries group to rename. required: true schema: type: string - name: replace-assigned-ts in: query - description: 'Specifies whether to unassign all existing time series before - assigning new time series specified in the content body Default: false' + description: >- + Specifies whether to unassign all existing time series before + assigning new time series specified in the content body Default: + false schema: type: boolean - name: office in: query - description: Specifies the office of the user making the request. This is - the office that the timeseries, group, and category belong to. If the group - and/or category belong to the CWMS office, this only identifies the timeseries. + description: >- + Specifies the office of the user making the request. This is the + office that the timeseries, group, and category belong to. If the + group and/or category belong to the CWMS office, this only + identifies the timeseries. required: true schema: type: string @@ -5575,7 +6217,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesGroup" + $ref: '#/components/schemas/TimeSeriesGroup' required: true responses: '400': @@ -5583,35 +6225,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/group": + /timeseries/group: get: tags: - Timeseries Groups @@ -5621,20 +6263,29 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the timeseries assigned to the - group(s) whose data is to be included in the response. If this field is - not specified, group information for all assigned TS offices shall be returned. + description: >- + Specifies the owning office of the timeseries assigned to the + group(s) whose data is to be included in the response. If this field + is not specified, group information for all assigned TS offices + shall be returned. + schema: + type: string + - name: group-office-id + in: query + description: Specifies the owning office of the timeseries group schema: type: string - name: include-assigned in: query - description: 'Include the assigned timeseries in the returned timeseries groups. - (default: true)' + description: >- + Include the assigned timeseries in the returned timeseries groups. + (default: true) schema: type: boolean - name: timeseries-category-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the timeseries category id schema: type: string @@ -5645,7 +6296,8 @@ paths: type: string - name: timeseries-group-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the timeseries group id schema: type: string @@ -5657,38 +6309,39 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/TimeSeriesGroup" + $ref: '#/components/schemas/TimeSeriesGroup' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the timeseries - group(s) were not found. + description: >- + Based on the combination of inputs provided the timeseries group(s) + were not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -5706,11 +6359,25 @@ paths: description: 'Create will fail if provided ID already exists. Default: true' schema: type: boolean + - name: ignore-nulls + in: query + description: >- + Ignore null values in the request body. Caution, if fail-if-exists + is false and ignore-nulls is false, then the create will proceed + whether there was an existing group or not. If there was an + existing group with a description and the provided body does not + specify a description (its null) the combination of flags will cause + the database to replace the description with null. If ignore-nulls + is false and the provided body does not specify the list of assigned + time series this will result in the database replacing the list with + an empty list.Default: true + schema: + type: boolean requestBody: content: application/json: schema: - "$ref": "#/components/schemas/TimeSeriesGroup" + $ref: '#/components/schemas/TimeSeriesGroup' required: true responses: '400': @@ -5718,35 +6385,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries": + /timeseries: get: tags: - TimeSeries @@ -5755,127 +6422,176 @@ paths: parameters: - name: name in: query - description: Specifies the name of the time series whose data is to be included - in the response. A case insensitive comparison is used to match names. + description: >- + Specifies the name of the time series whose data is to be included + in the response. A case insensitive comparison is used to match + names. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the time series(s) whose data - is to be included in the response. Required for:application/json;version=2 - and application/xml;version=2. For other formats, if this field is not specified, - matching location level information from all offices shall be returned. + description: >- + Specifies the owning office of the time series(s) whose data is to + be included in the response. Required for:application/json;version=2 + and application/xml;version=2. For other formats, if this field is + not specified, matching location level information from all offices + shall be returned. schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are: \n* `EN` (default) Specifies English unit system. - \ Location level values will be in the default English units for their parameters.\n* - `SI` Specifies the SI unit system. Location level values will be in the - default SI units for their parameters.\n* `Other` Any unit returned in - the response to the units URI request that is appropriate for the requested - parameters." + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` (default) Specifies English unit system. Location level + values will be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location level values will be + in the default SI units for their parameters. + + * `Other` Any unit returned in the response to the units URI + request that is appropriate for the requested parameters. deprecated: true schema: type: string - name: units in: query - description: "Specifies the units or unit system of the response. Valid values - for the units field are: \n* `EN` (default) Specifies English unit system. - \ Location level values will be in the default English units for their parameters.\n* - `SI` Specifies the SI unit system. Location level values will be in the - default SI units for their parameters.\n* `Other` Any units returned in - the response to the units URI request that is appropriate for the requested - parameters." + description: >- + Specifies the units or unit system of the response. Valid values for + the units field are: + + * `EN` (default) Specifies English unit system. Location level + values will be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location level values will be + in the default SI units for their parameters. + + * `Other` Any units returned in the response to the units URI + request that is appropriate for the requested parameters. schema: type: string - name: version-date in: query - description: Specifies the version date of a time series trace to be selected. - The format for this field is ISO 8601 extended, - with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'.If field is empty, query will return a - max aggregate for the timeseries. Only supported for:application/json;version=2 - and application/xml;version=2 + description: >- + Specifies the version date of a time series trace to be selected. + The format for this field is ISO 8601 + extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'.If field is empty, query will return a + max aggregate for the timeseries. Only supported + for:application/json;version=2 and application/xml;version=2 schema: type: string - name: datum in: query - description: |- - Specifies the elevation datum of the response. This field affects only elevation location levels. Valid values for this field are: - * `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum. - * `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum. This parameter is not supported for:application/json;version=2 or application/xml;version=2 + description: >- + Specifies the elevation datum of the response. This field affects + only elevation location levels. Valid values for this field are: + + * `NAVD88` The elevation values will in the specified or default + units above the NAVD-88 datum. + + * `NGVD29` The elevation values will be in the specified or default + units above the NGVD-29 datum. This parameter is not supported + for:application/json;version=2 or application/xml;version=2 schema: type: string - name: begin in: query - description: Specifies the start of the time window for data to be included - in the response. If this field is not specified, any required time window - begins 24 hours prior to the specified or default end time. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + Specifies the start of the time window for data to be included in + the response. If this field is not specified, any required time + window begins 24 hours prior to the specified or default end time. + The format for this field is ISO 8601 + extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included - in the response. If this field is not specified, any required time window - ends at the current time. The format for this field - is ISO 8601 extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'. + description: >- + Specifies the end of the time window for data to be included in the + response. If this field is not specified, any required time window + ends at the current time. The format for this + field is ISO 8601 extended, with optional offset and timezone, + i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: timezone in: query - description: "Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). For application/json;version=2 and application/xml;version=2 - the results are returned in UTC. For other formats this parameter affects - the time zone of times in the response. If this field is not specified, - the default time zone of UTC shall be used.\r\nIgnored if begin was specified - with offset and timezone." + description: "Specifies the time zone of the values of the begin and end fields (unless otherwise specified). For application/json;version=2 and application/xml;version=2 the results are returned in UTC. For other formats this parameter affects the time zone of times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone." schema: type: string - name: trim in: query - description: Specifies whether to trim missing values from the beginning and - end of the retrieved values. Only supported for:application/json;version=2 - and application/xml;version=2. Default is true. + description: >- + Specifies whether to trim missing values from the beginning and end + of the retrieved values. When true and values are returned, the + response begin and end fields reflect the returned data window. Only + supported for:application/json;version=2 and + application/xml;version=2. Default is true. schema: type: boolean - name: format in: query - description: |- - Specifies the encoding format of the response. Valid values for the format field for this URI are: + description: >- + Specifies the encoding format of the response. Valid values for the + format field for this URI are: + * `tab` + * `csv` + * `xml` + * `wml2` (only if name field is specified) + * `json` (default) - - See this page for more information about accept header usage. + + + See this page for more information + about accept header usage. schema: type: string - name: include-entry-date in: query - description: Specifies whether to include the data entry date of each value - in the response. Including the data entry date will increase the size of - the array containing each data value from three to four, changing the format - of the response. Default is false. + description: >- + Specifies whether to include the data entry date of each value in + the response. Including the data entry date will increase the size + of the array containing each data value from three to four, changing + the format of the response. Default is false. schema: type: boolean - name: page in: query - description: This end point can return large amounts of data as a series of - pages. This parameter is used to describes the current location in the response - stream. This is an opaque value, and can be obtained from the 'next-page' - value in the response. + description: >- + This end point can return large amounts of data as a series of + pages. This parameter is used to describes the current location in + the response stream. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size in: query - description: How many entries per page returned. Default 500. + description: >- + How many entries per page returned. Default 500. Use 0 to return an + empty values array, or -1 to return the entire window in one + response without a next-page cursor. Values less than -1 are + invalid. schema: type: integer format: int32 @@ -5885,49 +6601,49 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/json: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' '': schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a timeseries. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -5937,35 +6653,34 @@ paths: tags: - TimeSeries summary: Post timeseries - description: 'Used to create and save time-series data. Data to be stored must - have time stamps in UTC represented as epoch milliseconds. If data entry date - is included in the request, it will be dropped. ' + description: >- + Used to create and save time-series data. Data to be stored must have + time stamps in UTC represented as epoch milliseconds. If data entry date + is included in the request, it will be dropped. operationId: postTimeseries parameters: - - name: timezone - in: query - description: "Specifies the time zone of the version-date field (unless otherwise - specified). If this field is not specified, the default time zone of UTC - shall be used.\r\nIgnored if version-date was specified with offset and - timezone." - schema: - type: string - name: create-as-lrts in: query - description: Flag indicating if timeseries should be created as Local Regular + description: >- + Flag indicating if timeseries should be created as Local Regular Time Series. 'True' or 'False', default is 'False' schema: type: boolean - name: store-rule in: query - description: |- - The business rule to use when merging the incoming with existing data + description: >- + The business rule to use when merging the incoming with existing + data + + + + + +
Store Rules
Delete Insert All existing data in the time window will be deleted and then replaced with the new dataset.
Replace All @@ -5976,6 +6691,7 @@ paths:
Replace With Non Missing @@ -5999,35 +6715,39 @@ paths: Note: an existing date/time-value pair whose missing value quality bit is set will NOT be overwritten.
schema: - "$ref": "#/components/schemas/StoreRule" + $ref: '#/components/schemas/StoreRule' - name: override-protection in: query - description: A flag to ignore the protected data quality when storing data. + description: >- + A flag to ignore the protected data quality when storing data. 'True' or 'False', default is true schema: type: boolean - name: datum in: query - description: If the provided time-series includes an explicit vertical-datum-info - attribute then it is assumed that the data is in the datum specified by - the vertical-datum-info. If the input timeseries does not include vertical-datum-info - and this parameter is not provided it is assumed that the data is in the - as-stored datum and no conversion is necessary. If the input timeseries - does not include vertical-datum-info and this parameter is provided it is - assumed that the data is in the Datum named by the argument and should be + description: >- + If the provided time-series includes an explicit vertical-datum-info + attribute then it is assumed that the data is in the datum specified + by the vertical-datum-info. If the input timeseries does not include + vertical-datum-info and this parameter is not provided it is assumed + that the data is in the as-stored datum and no conversion is + necessary. If the input timeseries does not include + vertical-datum-info and this parameter is provided it is assumed + that the data is in the Datum named by the argument and should be converted to the as-stored datum before being saved. schema: - "$ref": "#/components/schemas/VerticalDatum" + $ref: '#/components/schemas/VerticalDatum' requestBody: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' required: true responses: '400': @@ -6035,35 +6755,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/timeseries/{timeseries}": + '/timeseries/{timeseries}': delete: tags: - TimeSeries @@ -6084,59 +6804,71 @@ paths: type: string - name: begin in: query - description: The start of the time window to delete. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + The start of the time window to delete. The format for this field is ISO 8601 extended, + with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. required: true schema: type: string - name: end in: query - description: The end of the time window to delete. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + The end of the time window to delete. The format for this field is ISO 8601 extended, + with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. required: true schema: type: string - name: timezone in: query - description: This field specifies a default timezone to be used if the format - of the begin, end, or version-date parameters do not include offset or time - zone information. Defaults to UTC. + description: >- + This field specifies a default timezone to be used if the format of + the begin, end, or version-date parameters do not include offset or + time zone information. Defaults to UTC. schema: type: string - name: version-date in: query - description: The version date/time of the time series in the specified or - default time zone. If NULL, the earliest or latest version date will be - used depending on p_max_version. + description: >- + The version date/time of the time series in the specified or default + time zone. If NULL, the earliest or latest version date will be used + depending on p_max_version. schema: type: string - name: start-time-inclusive in: query - description: A flag specifying whether any data at the start time should be - deleted ('True') or only data after the start time ('False'). Default - value is True + description: >- + A flag specifying whether any data at the start time should be + deleted ('True') or only data after the start time + ('False'). Default value is True schema: type: boolean - name: end-time-inclusive in: query - description: A flag ('True'/'False') specifying whether any data at the end - time should be deleted ('True') or only data before the + description: >- + A flag ('True'/'False') specifying whether any data at the end time + should be deleted ('True') or only data before the end time ('False'). Default value is False schema: type: boolean - name: max-version in: query - description: A flag ('True'/'False') specifying whether to use the earliest - ('False') or latest ('True') version date for each time if p_version_date - is NULL. Default is 'True' + description: >- + A flag ('True'/'False') specifying whether to use the earliest + ('False') or latest ('True') version date for each time if + p_version_date is NULL. Default is 'True' schema: type: boolean - name: override-protection in: query - description: A flag ('True'/'False') specifying whether to delete protected - data. Default is False + description: >- + A flag ('True'/'False') specifying whether to delete protected data. + Default is False schema: type: boolean responses: @@ -6145,31 +6877,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -6186,14 +6918,6 @@ paths: required: true schema: type: string - - name: timezone - in: query - description: "Specifies the time zone of the version-date field (unless otherwise - specified). If this field is not specified, the default time zone of UTC - shall be used.\r\nIgnored if version-date was specified with offset and - timezone." - schema: - type: string - name: create-as-lrts in: query description: '' @@ -6201,14 +6925,19 @@ paths: type: boolean - name: store-rule in: query - description: |- - The business rule to use when merging the incoming with existing data + description: >- + The business rule to use when merging the incoming with existing + data + + + + + +
Store Rules
Delete Insert All existing data in the time window will be deleted and then replaced with the new dataset.
Replace All @@ -6219,6 +6948,7 @@ paths:
Replace With Non Missing @@ -6242,35 +6972,39 @@ paths: Note: an existing date/time-value pair whose missing value quality bit is set will NOT be overwritten.
schema: - "$ref": "#/components/schemas/StoreRule" + $ref: '#/components/schemas/StoreRule' - name: override-protection in: query - description: A flag to ignore the protected data quality when storing data. "'true' - or 'false'" + description: >- + A flag to ignore the protected data quality when storing data. + "'true' or 'false'" schema: type: boolean - name: datum in: query - description: If the provided time-series includes an explicit vertical-datum-info - attribute then it is assumed that the data is in the datum specified by - the vertical-datum-info. If the input timeseries does not include vertical-datum-info - and this parameter is not provided it is assumed that the data is in the - as-stored datum and no conversion is necessary. If the input timeseries - does not include vertical-datum-info and this parameter is provided it is - assumed that the data is in the Datum named by the argument and should be + description: >- + If the provided time-series includes an explicit vertical-datum-info + attribute then it is assumed that the data is in the datum specified + by the vertical-datum-info. If the input timeseries does not include + vertical-datum-info and this parameter is not provided it is assumed + that the data is in the as-stored datum and no conversion is + necessary. If the input timeseries does not include + vertical-datum-info and this parameter is provided it is assumed + that the data is in the Datum named by the argument and should be converted to the as-stored datum before being saved. schema: - "$ref": "#/components/schemas/VerticalDatum" + $ref: '#/components/schemas/VerticalDatum' requestBody: content: application/json;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' application/xml;version=2: schema: - "$ref": "#/components/schemas/TimeSeries" + $ref: '#/components/schemas/TimeSeries' required: true responses: '400': @@ -6278,44 +7012,45 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/rate-values/{office}/{rating-id}": + '/ratings/rate-values/{office}/{rating-id}': post: tags: - Ratings summary: Post ratings rateValues with office with ratingId - description: 'Rates input values using CWMS ratings. The input format `RatingInputValues` - includes a two dimensional array with each dimension corresponding to an independent - parameter in the rating curve. The output format `RatedOutputTimeSeries` will - contain a singular double array corresponding to the dependent parameter of - the rating curve. ' + description: >- + Rates input values using CWMS ratings. The input format + `RatingInputValues` includes a two dimensional array with each dimension + corresponding to an independent parameter in the rating curve. The + output format `RatedOutputTimeSeries` will contain a singular double + array corresponding to the dependent parameter of the rating curve. operationId: postRatingsRateValuesWithOfficeWithRatingId parameters: - name: office @@ -6334,10 +7069,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RateInputValues" + $ref: '#/components/schemas/RateInputValues' application/json;version=1: schema: - "$ref": "#/components/schemas/RateInputValues" + $ref: '#/components/schemas/RateInputValues' required: true responses: '200': @@ -6345,55 +7080,56 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RatedOutputValues" + $ref: '#/components/schemas/RatedOutputValues' application/json;version=1: schema: - "$ref": "#/components/schemas/RatedOutputValues" + $ref: '#/components/schemas/RatedOutputValues' '400': description: Invalid input parameters. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Client is not authorized. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The rating curve was not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/rate-ts/{office}/{rating-id}": + '/ratings/rate-ts/{office}/{rating-id}': post: tags: - Ratings summary: Post ratings rateTs with office with ratingId - description: 'Rates input values using CWMS ratings. The input format `RateInputTimeSeries` - DTO supports an array of CWMS time series ids, each corresponding to an independent - parameter in the rating curve.The output format `RatedOutputTimeSeries` will - contain a singular double array corresponding to the dependent parameter of - the rating curve. ' + description: >- + Rates input values using CWMS ratings. The input format + `RateInputTimeSeries` DTO supports an array of CWMS time series ids, + each corresponding to an independent parameter in the rating curve.The + output format `RatedOutputTimeSeries` will contain a singular double + array corresponding to the dependent parameter of the rating curve. operationId: postRatingsRateTsWithOfficeWithRatingId parameters: - name: office @@ -6412,10 +7148,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RateInputTimeSeries" + $ref: '#/components/schemas/RateInputTimeSeries' application/json;version=1: schema: - "$ref": "#/components/schemas/RateInputTimeSeries" + $ref: '#/components/schemas/RateInputTimeSeries' required: true responses: '200': @@ -6423,56 +7159,58 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RatedOutputTimeSeries" + $ref: '#/components/schemas/RatedOutputTimeSeries' application/json;version=1: schema: - "$ref": "#/components/schemas/RatedOutputTimeSeries" + $ref: '#/components/schemas/RatedOutputTimeSeries' '400': description: Invalid input parameters. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Client is not authorized. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The rating curve was not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/reverse-rate-values/{office}/{rating-id}": + '/ratings/reverse-rate-values/{office}/{rating-id}': post: tags: - Ratings summary: Post ratings reverseRateValues with office with ratingId - description: 'Reverse rates input values using CWMS ratings. The input format - `RateInputValues` requires a singular array of doubles corresponding to the - dependent parameter in the rating curve. The output format `RatedOutputValues` - will contain a singular double array corresponding to the independent parameter - of the rating curve. Note: This endpoint only works on monotonically increase/decreasing - table ratings with a single independent parameter.' + description: >- + Reverse rates input values using CWMS ratings. The input format + `RateInputValues` requires a singular array of doubles corresponding to + the dependent parameter in the rating curve. The output format + `RatedOutputValues` will contain a singular double array corresponding + to the independent parameter of the rating curve. Note: This endpoint + only works on monotonically increase/decreasing table ratings with a + single independent parameter. operationId: postRatingsReverseRateValuesWithOfficeWithRatingId parameters: - name: office @@ -6491,10 +7229,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RateInputValues" + $ref: '#/components/schemas/RateInputValues' application/json;version=1: schema: - "$ref": "#/components/schemas/RateInputValues" + $ref: '#/components/schemas/RateInputValues' required: true responses: '200': @@ -6502,56 +7240,58 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RatedOutputValues" + $ref: '#/components/schemas/RatedOutputValues' application/json;version=1: schema: - "$ref": "#/components/schemas/RatedOutputValues" + $ref: '#/components/schemas/RatedOutputValues' '400': description: Invalid input parameters. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Client is not authorized. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The rating or input time series were not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/reverse-rate-ts/{office}/{rating-id}": + '/ratings/reverse-rate-ts/{office}/{rating-id}': post: tags: - Ratings summary: Post ratings reverseRateTs with office with ratingId - description: 'Reverse rates input values using CWMS ratings. The input format - `RateInputTimeSeries` requires a singular time series id corresponding to - the dependent parameter in the rating curve. The output format `RatedOutputTimeSeries` - will contain a singular double array corresponding to the independent parameter - of the rating curve. Note: This endpoint only works on monotonically increase/decreasing - table ratings with a single independent parameter.' + description: >- + Reverse rates input values using CWMS ratings. The input format + `RateInputTimeSeries` requires a singular time series id corresponding + to the dependent parameter in the rating curve. The output format + `RatedOutputTimeSeries` will contain a singular double array + corresponding to the independent parameter of the rating curve. Note: + This endpoint only works on monotonically increase/decreasing table + ratings with a single independent parameter. operationId: postRatingsReverseRateTsWithOfficeWithRatingId parameters: - name: office @@ -6570,10 +7310,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RateInputTimeSeries" + $ref: '#/components/schemas/RateInputTimeSeries' application/json;version=1: schema: - "$ref": "#/components/schemas/RateInputTimeSeries" + $ref: '#/components/schemas/RateInputTimeSeries' required: true responses: '200': @@ -6581,46 +7321,46 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/RatedOutputTimeSeries" + $ref: '#/components/schemas/RatedOutputTimeSeries' application/json;version=1: schema: - "$ref": "#/components/schemas/RatedOutputTimeSeries" + $ref: '#/components/schemas/RatedOutputTimeSeries' '400': description: Invalid input parameters. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Client is not authorized. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The rating or input time series were not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/template/{template-id}": + '/ratings/template/{template-id}': get: tags: - Ratings @@ -6635,10 +7375,10 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the Rating Templates whose data - is to be included in the response. If this field is not specified, matching - rating information from all offices shall be returned. - required: true + description: >- + Specifies the owning office of the Rating Templates whose data is to + be included in the response. If this field is not specified, + matching rating information from all offices shall be returned. schema: type: string responses: @@ -6649,37 +7389,37 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/RatingTemplate" + $ref: '#/components/schemas/RatingTemplate' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -6707,42 +7447,42 @@ paths: description: Specifies the delete method used. required: true schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/template": + /ratings/template: get: tags: - Ratings @@ -6751,23 +7491,26 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the Rating Templates whose data - is to be included in the response. If this field is not specified, matching - rating information from all offices shall be returned. + description: >- + Specifies the owning office of the Rating Templates whose data is to + be included in the response. If this field is not specified, + matching rating information from all offices shall be returned. schema: type: string - name: template-id-mask in: query - description: RegExp that specifies the rating template IDs to be included - in the response. If this field is not specified, all rating templates shall + description: >- + RegExp that specifies the rating template IDs to be included in the + response. If this field is not specified, all rating templates shall be returned. schema: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. schema: type: string - name: page-size @@ -6782,37 +7525,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/RatingTemplates" + $ref: '#/components/schemas/RatingTemplates' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -6832,7 +7575,7 @@ paths: content: application/xml;version=2: schema: - "$ref": "#/components/schemas/RatingTemplate" + $ref: '#/components/schemas/RatingTemplate' required: true responses: '400': @@ -6840,35 +7583,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/spec/{rating-id}": + '/ratings/spec/{rating-id}': get: tags: - Ratings @@ -6877,17 +7620,18 @@ paths: parameters: - name: rating-id in: path - description: Specifies the rating-id of the Rating Spec to be included in - the response + description: >- + Specifies the rating-id of the Rating Spec to be included in the + response required: true schema: type: string - name: office in: query - description: Specifies the owning office of the Rating Specs whose data is - to be included in the response. If this field is not specified, matching + description: >- + Specifies the owning office of the Rating Specs whose data is to be + included in the response. If this field is not specified, matching rating information from all offices shall be returned. - required: true schema: type: string responses: @@ -6896,37 +7640,40 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/RatingSpec" + $ref: '#/components/schemas/RatingSpec' + application/xml;version=2: + schema: + $ref: '#/components/schemas/RatingSpec' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -6954,42 +7701,42 @@ paths: description: Specifies the delete method used. required: true schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/spec": + /ratings/spec: get: tags: - Ratings @@ -6998,23 +7745,26 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the Rating Specs whose data is - to be included in the response. If this field is not specified, matching + description: >- + Specifies the owning office of the Rating Specs whose data is to be + included in the response. If this field is not specified, matching rating information from all offices shall be returned. schema: type: string - name: rating-id-mask in: query - description: Posix regular expression that specifies - the rating IDs to be included in the response. If this field is not specified, - all Rating Specs shall be returned. + description: >- + Posix regular expression that specifies + the rating IDs to be included in the response. If this field is not + specified, all Rating Specs shall be returned. schema: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. schema: type: string - name: page-size @@ -7029,37 +7779,40 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/RatingSpecs" + $ref: '#/components/schemas/RatingSpecs' + application/xml;version=2: + schema: + $ref: '#/components/schemas/RatingSpecs' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -7077,9 +7830,12 @@ paths: type: boolean requestBody: content: + application/json: + schema: + $ref: '#/components/schemas/RatingSpec' application/xml;version=2: schema: - "$ref": "#/components/schemas/RatingSpec" + $ref: '#/components/schemas/RatingSpec' required: true responses: '400': @@ -7087,35 +7843,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/metadata": + /ratings/metadata: get: tags: - Ratings @@ -7124,41 +7880,47 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the Rating Specs whose data is - to be included in the response. If this field is not specified, matching + description: >- + Specifies the owning office of the Rating Specs whose data is to be + included in the response. If this field is not specified, matching rating information from all offices shall be returned. schema: type: string - name: rating-id-mask in: query - description: RegExp that specifies the rating IDs to be included in the response. + description: >- + RegExp that specifies the rating IDs to be included in the response. If this field is not specified, all Rating Specs shall be returned. schema: type: string - name: start in: query - description: Specifies the start of the time window of the effective dates - to be included. If this field is not specified no start time will be used. + description: >- + Specifies the start of the time window of the effective dates to be + included. If this field is not specified no start time will be used. schema: type: string - name: end in: query - description: Specifies the end of the time window for effective dates to be + description: >- + Specifies the end of the time window for effective dates to be included. If this field is not specified no end time will be used. schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. schema: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. schema: type: string - name: page-size @@ -7173,41 +7935,41 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/RatingMetadataList" + $ref: '#/components/schemas/RatingMetadataList' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/{rating-id}/latest": + '/ratings/{rating-id}/latest': get: tags: - Ratings @@ -7223,8 +7985,9 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the ratingset to be included in - the response. + description: >- + Specifies the owning office of the ratingset to be included in the + response. required: true schema: type: string @@ -7234,50 +7997,51 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/xml;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/effective-dates": + /ratings/effective-dates: get: tags: - Ratings summary: Get ratings effectiveDates - description: Returns mapping of office -> spec id -> effective date-times for - all matching offices and spec ids. + description: >- + Returns mapping of office -> spec id -> effective date-times for all + matching offices and spec ids. operationId: getRatingsEffectiveDates parameters: - name: office-mask @@ -7292,9 +8056,10 @@ paths: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified). If this field is not specified, the default - time zone of UTC shall be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified). If this field is not specified, the + default time zone of UTC shall be used. schema: type: string - name: begin @@ -7313,47 +8078,48 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/RatingEffectiveDatesMap" + $ref: '#/components/schemas/RatingEffectiveDatesMap' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings/{rating-id}": + '/ratings/{rating-id}': get: tags: - Ratings summary: Get ratings with ratingId - description: Returns CWMS Rating Data. Supports accept header formatting. For - more information about accept header usage, see this + description: >- + Returns CWMS Rating Data. Supports accept header formatting. For more + information about accept header usage, see this page. operationId: getRatingsWithRatingId parameters: @@ -7365,77 +8131,99 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the ratingset to be included in - the response. + description: >- + Specifies the owning office of the ratingset to be included in the + response. required: true schema: type: string - name: begin in: query - description: Specifies the start of the time window for data to be included - in the response. If this field is not specified no start time will be used. + description: >- + Specifies the start of the time window for data to be included in + the response. If this field is not specified no start time will be + used. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included - in the response. If this field is not specified no end time will be used. + description: >- + Specifies the end of the time window for data to be included in the + response. If this field is not specified no end time will be used. schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified), as well as the time zone of any times in the - response. If this field is not specified, the default time zone of UTC shall - be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified), as well as the time zone of any times + in the response. If this field is not specified, the default time + zone of UTC shall be used. schema: type: string - name: method in: query - description: Specifies the retrieval method used. If no method is provided - EAGER will be used. + description: >- + Specifies the retrieval method used. If no method is provided EAGER + will be used. schema: - "$ref": "#/components/schemas/DatabaseLoadMethod" + $ref: '#/components/schemas/DatabaseLoadMethod' + - name: datum + in: query + description: >- + Specifies the elevation datum of the response. This field affects + only elevation Ratings. Valid values for this field are: + + * `NAVD88` The elevation values will in the specified or default + units above the NAVD-88 datum. + + * `NGVD29` The elevation values will be in the specified or default + units above the NGVD-29 datum. + + * `NATIVE` The elevation values will be in the Location's native + datum. + schema: + $ref: '#/components/schemas/VerticalDatum' responses: '200': description: OK content: application/json;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/xml;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -7459,25 +8247,32 @@ paths: type: string - name: begin in: query - description: The start of the time window to delete. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + The start of the time window to delete. The format for this field is ISO 8601 extended, + with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. required: true schema: type: string - name: end in: query - description: The end of the time window to delete. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. + description: >- + The end of the time window to delete. The format for this field is ISO 8601 extended, + with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. required: true schema: type: string - name: timezone in: query - description: This field specifies a default timezone to be used if the format - of the begin, end, or version-date parameters do not include offset or time - zone information. Defaults to UTC. + description: >- + This field specifies a default timezone to be used if the format of + the begin, end, or version-date parameters do not include offset or + time zone information. Defaults to UTC. schema: type: string responses: @@ -7486,31 +8281,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -7534,18 +8329,31 @@ paths: type: boolean - name: replace-base-curve in: query - description: 'Replace the base curve of USGS stream flow rating. Default: - false' + description: 'Replace the base curve of USGS stream flow rating. Default: false' schema: type: boolean + - name: datum + in: query + description: >- + If the provided rating-set includes an explicit vertical-datum-info + attribute then it is assumed that the data is in the datum specified + by the vertical-datum-info. If the input rating-set does not include + vertical-datum-info and this parameter is not provided it is assumed + that the data is in the as-stored datum and no conversion is + necessary. If the input rating-set does not include + vertical-datum-info and this parameter is provided it is assumed + that the data is in the Datum named by the argument and should be + converted to the as-stored datum before being saved. + schema: + $ref: '#/components/schemas/VerticalDatum' requestBody: content: application/xml;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/json;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' required: true responses: '400': @@ -7553,35 +8361,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/ratings": + /ratings: get: tags: - Ratings @@ -7590,63 +8398,88 @@ paths: parameters: - name: name in: query - description: Specifies the name(s) of the rating whose data is to be included - in the response. A case insensitive comparison is used to match names. + description: >- + Specifies the name(s) of the rating whose data is to be included in + the response. A case insensitive comparison is used to match names. schema: type: string - name: office in: query - description: Specifies the owning office of the Rating(s) whose data is to - be included in the response. If this field is not specified, matching rating - information from all offices shall be returned. + description: >- + Specifies the owning office of the Rating(s) whose data is to be + included in the response. If this field is not specified, matching + rating information from all offices shall be returned. schema: type: string - name: unit in: query - description: |- - Specifies the unit or unit system of the response. Valid values for the unit field are: - * `EN` Specifies English unit system. Rating values will be in the default English units for their parameters. - * `SI` Specifies the SI unit system. Rating values will be in the default SI units for their parameters. - * `NATIVE` Specifies the NATIVE units. Rating values will be in the native units for their parameters. + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` Specifies English unit system. Rating values will be in the + default English units for their parameters. + + * `SI` Specifies the SI unit system. Rating values will be in the + default SI units for their parameters. + + * `NATIVE` Specifies the NATIVE units. Rating values will be in + the native units for their parameters. schema: type: string - name: datum in: query - description: |- - Specifies the elevation datum of the response. This field affects only elevation Ratings. Valid values for this field are: - * `NAVD88` The elevation values will in the specified or default units above the NAVD-88 datum. - * `NGVD29` The elevation values will be in the specified or default units above the NGVD-29 datum. + description: >- + Specifies the elevation datum of the response. This field affects + only elevation Ratings. Valid values for this field are: + + * `NAVD88` The elevation values will in the specified or default + units above the NAVD-88 datum. + + * `NGVD29` The elevation values will be in the specified or default + units above the NGVD-29 datum. + + * `NATIVE` The elevation values will be in the Location's native + datum. schema: type: string - name: at in: query - description: Specifies the start of the time window for data to be included - in the response. If this field is not specified, any required time window - begins 24 hours prior to the specified or default end time. + description: >- + Specifies the start of the time window for data to be included in + the response. If this field is not specified, any required time + window begins 24 hours prior to the specified or default end time. schema: type: string - name: end in: query - description: Specifies the end of the time window for data to be included - in the response. If this field is not specified, any required time window + description: >- + Specifies the end of the time window for data to be included in the + response. If this field is not specified, any required time window ends at the current time schema: type: string - name: timezone in: query - description: Specifies the time zone of the values of the begin and end fields - (unless otherwise specified), as well as the time zone of any times in the - response. If this field is not specified, the default time zone of UTC shall - be used. + description: >- + Specifies the time zone of the values of the begin and end fields + (unless otherwise specified), as well as the time zone of any times + in the response. If this field is not specified, the default time + zone of UTC shall be used. schema: type: string - name: format in: query - description: |- - Specifies the encoding format of the response. Valid values for the format field for this URI are: + description: >- + Specifies the encoding format of the response. Valid values for the + format field for this URI are: + * `tab` + * `csv` + * `xml` + * `json` (default) schema: type: string @@ -7656,10 +8489,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/xml: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' text/tab-separated-values: schema: type: string @@ -7671,32 +8504,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a rating - table. + description: The provided combination of parameters did not find a rating table. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -7714,14 +8546,28 @@ paths: description: 'Also store updates to the rating template. Default: true' schema: type: boolean + - name: datum + in: query + description: >- + If the provided rating-set includes an explicit vertical-datum-info + attribute then it is assumed that the data is in the datum specified + by the vertical-datum-info. If the input rating-set does not include + vertical-datum-info and this parameter is not provided it is assumed + that the data is in the as-stored datum and no conversion is + necessary. If the input rating-set does not include + vertical-datum-info and this parameter is provided it is assumed + that the data is in the Datum named by the argument and should be + converted to the as-stored datum before being saved. + schema: + $ref: '#/components/schemas/VerticalDatum' requestBody: content: application/xml;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' application/json;version=2: schema: - "$ref": "#/components/schemas/Unit" + $ref: '#/components/schemas/Unit' required: true responses: '201': @@ -7731,35 +8577,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/catalog/{dataset}": + '/catalog/{dataset}': get: tags: - Catalog @@ -7768,14 +8614,25 @@ paths: parameters: - name: dataset in: path - description: A list of what data? E.g. Timeseries, Locations, Ratings, etc + description: 'A list of what data? E.g. Timeseries, Locations, Ratings, etc' required: true schema: - "$ref": "#/components/schemas/CatalogableEndpoint" + $ref: '#/components/schemas/CatalogableEndpoint' - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size @@ -7786,105 +8643,133 @@ paths: format: int32 - name: unit-system in: query - description: Unit System desired in response. Can be SI (International Scientific) - or EN (Imperial.) If unspecified, defaults to SI. + description: >- + Unit System desired in response. Can be SI (International + Scientific) or EN (Imperial.) If unspecified, defaults to SI. schema: - "$ref": "#/components/schemas/UnitSystem" + $ref: '#/components/schemas/UnitSystem' - name: office in: query - description: 3-4 letter office name representing the district you want to - isolate data to. + description: >- + 3-4 letter office name representing the district you want to isolate + data to. schema: type: string - name: like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the id schema: type: string - name: timeseries-category-like in: query - description: 'Posix regular expression matching - against the timeseries category id. Note: This parameter is unsupported - when dataset is Locations.' + description: >- + Posix regular expression matching against + the timeseries category id. Note: This parameter is unsupported when + dataset is Locations. schema: type: string - name: timeseries-group-like in: query - description: 'Posix regular expression matching - against the timeseries group id. Note: This parameter is unsupported when - dataset is Locations.' + description: >- + Posix regular expression matching against + the timeseries group id. Note: This parameter is unsupported when + dataset is Locations. schema: type: string - name: location-category-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the location category id schema: type: string - name: location-group-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the location group id schema: type: string - name: bounding-office-like in: query - description: Posix regular expression matching against - the location bounding office. When this field is used items with no bounding - office set will not be present in results. + description: >- + Posix regular expression matching against + the location bounding office. When this field is used items with no + bounding office set will not be present in results. schema: type: string - name: include-extents in: query - description: 'Whether the returned catalog entries should include timeseries - extents. Only valid for TIMESERIES. Note: This parameter is unsupported - when dataset is Locations.Default is true.' + description: >- + Whether the returned catalog entries should include timeseries + extents. Only valid for TIMESERIES. Note: This parameter is + unsupported when dataset is Locations.Default is true. + schema: + type: boolean + - name: include-versions + in: query + description: >- + Whether the returned catalog entries should include timeseries + versions in the extents block. Only used when include-extents is + enabled, otherwise it is ignored. Only valid for TIMESERIES. Note: + This parameter is unsupported when dataset is Locations.Default is + true. schema: type: boolean - name: exclude-empty in: query - description: 'Specifies whether Timeseries that have empty extents should - be excluded from the results. For purposes of this parameter ''empty'' - is defined as VERSION_TIME, EARLIEST_TIME, LATEST_TIME and LAST_UPDATE all - being null. This parameter does not control whether the extents are returned - to the user, only whether matching timeseries are excluded. Only valid for - TIMESERIES. Note: This parameter is unsupported when dataset is Locations.Default - is true.' + description: >- + Specifies whether Timeseries that have empty extents should be + excluded from the results. For purposes of this parameter 'empty' + is defined as VERSION_TIME, EARLIEST_TIME, LATEST_TIME and + LAST_UPDATE all being null. This parameter does not control whether + the extents are returned to the user, only whether matching + timeseries are excluded. Only valid for TIMESERIES. Note: This + parameter is unsupported when dataset is Locations.Default is true. schema: type: boolean - name: location-kind-like in: query - description: 'Posix regular expression matching - against the location kind. The location-kind is typically unset or one - of the following: {"SITE", "EMBANKMENT", "OVERFLOW", "TURBINE", "STREAM", - "PROJECT", "STREAMGAGE", "BASIN", "OUTLET", "LOCK", "GATE"}. Multiple kinds - can be matched by using Regular Expression OR clauses. For example: "(SITE|STREAM)"' + description: >- + Posix regular expression matching against + the location kind. The location-kind is typically unset or one of + the following: {"SITE", "EMBANKMENT", "OVERFLOW", "TURBINE", + "STREAM", "PROJECT", "STREAMGAGE", "BASIN", "OUTLET", "LOCK", + "GATE"}. Multiple kinds can be matched by using Regular Expression + OR clauses. For example: "(SITE|STREAM)" schema: type: string - name: filter-base-locations in: query - description: 'Specifies whether to filter the locations based on the base - location. Default: false. If true, only sublocations locations will be returned. - If false, all locations will be returned. Only supported for JSON format.' + description: >- + Specifies whether to filter the locations based on the base + location. Default: false. If true, only sublocations locations will + be returned. If false, all locations will be returned. Only + supported for JSON format. schema: type: boolean - name: negate-location-kind-like in: query - description: Whether to use the location kind regular expression to exclude + description: >- + Whether to use the location kind regular expression to exclude locations with the specified kinds. Default is false. schema: type: string - name: location-type-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the location type. schema: type: string - name: include-aliases in: query - description: Whether to add aliases to the catalog entries. Default is false. - If true, the aliases will be added to the catalog entries in the response. + description: >- + Whether to add aliases to the catalog entries. Default is false. If + true, the aliases will be added to the catalog entries in the + response. schema: type: boolean responses: @@ -7893,50 +8778,51 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Catalog" + $ref: '#/components/schemas/Catalog' application/xml: schema: - "$ref": "#/components/schemas/Catalog" + $ref: '#/components/schemas/Catalog' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/basins/{name}": + '/basins/{name}': get: tags: - Basins summary: Get basins with name - description: Returns CWMS Basin Data. This endpoint handles multiple accept - header types, including named pg json. For more information about accept header + description: >- + Returns CWMS Basin Data. This endpoint handles multiple accept header + types, including named pg json. For more information about accept header usage, see this page. operationId: getBasinsWithName parameters: @@ -7948,19 +8834,25 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the basin whose data is to be + description: >- + Specifies the owning office of the basin whose data is to be included in the response. required: true schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are: \n* `EN` (default) Specifies English unit system. - \ Basin area values will be in the default English units for their parameters.\n* - `SI` Specifies the SI unit system. \n* `Other` Any unit returned in the - response to the units URI request that is appropriate for the requested - parameters." + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` (default) Specifies English unit system. Basin area values + will be in the default English units for their parameters. + + * `SI` Specifies the SI unit system. + + * `Other` Any unit returned in the response to the units URI + request that is appropriate for the requested parameters. schema: type: string responses: @@ -7969,43 +8861,43 @@ paths: content: application/vnd.named+pg+json: schema: - "$ref": "#/components/schemas/Basin" + $ref: '#/components/schemas/Basin' application/json;version=1: schema: - "$ref": "#/components/schemas/Basin" + $ref: '#/components/schemas/Basin' application/json: schema: - "$ref": "#/components/schemas/Basin" + $ref: '#/components/schemas/Basin' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a basin. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -8035,38 +8927,38 @@ paths: description: Specifies the delete method used. required: true schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -8100,60 +8992,67 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a basin. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/basins": + /basins: get: tags: - Basins summary: Get basins - description: Returns CWMS Basin Data. This endpoint handles multiple accept - header types, including named pg json. For more information about accept header + description: >- + Returns CWMS Basin Data. This endpoint handles multiple accept header + types, including named pg json. For more information about accept header usage, see this page. operationId: getBasins parameters: - name: office in: query - description: Specifies the owning office of the basin whose data is to be - included in the response. If this field is not specified, matching basin - information from all offices shall be returned. + description: >- + Specifies the owning office of the basin whose data is to be + included in the response. If this field is not specified, matching + basin information from all offices shall be returned. schema: type: string - name: unit in: query - description: "Specifies the unit or unit system of the response. Valid values - for the unit field are: \n* `EN` Specifies English unit system. Basin values - will be in the default English units for their parameters. (This is default - if no value is entered)\n* `SI` Specifies the SI unit system. Basin values - will be in the default SI units for their parameters." + description: >- + Specifies the unit or unit system of the response. Valid values for + the unit field are: + + * `EN` Specifies English unit system. Basin values will be in the + default English units for their parameters. (This is default if no + value is entered) + + * `SI` Specifies the SI unit system. Basin values will be in the + default SI units for their parameters. schema: type: string responses: @@ -8162,43 +9061,43 @@ paths: content: application/vnd.named+pg+json: schema: - "$ref": "#/components/schemas/Basin" + $ref: '#/components/schemas/Basin' application/json;version=1: schema: - "$ref": "#/components/schemas/Basin" + $ref: '#/components/schemas/Basin' application/json: schema: - "$ref": "#/components/schemas/Basin" + $ref: '#/components/schemas/Basin' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a basin. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -8218,37 +9117,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/streams/{name}": + '/streams/{name}': get: tags: - Streams @@ -8281,42 +9180,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' application/json: schema: type: array items: - "$ref": "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -8343,7 +9242,7 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '200': description: Stream successfully deleted from CWMS. @@ -8352,32 +9251,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the stream was - not found. + description: >- + Based on the combination of inputs provided the stream was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -8413,35 +9313,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/streams": + /streams: get: tags: - Streams @@ -8451,8 +9351,9 @@ paths: parameters: - name: office-mask in: query - description: Office id for the reservoir project location associated with - the streams. + description: >- + Office id for the reservoir project location associated with the + streams. schema: type: string - name: stream-id-mask @@ -8462,14 +9363,16 @@ paths: type: string - name: diverts-from-stream-id-mask in: query - description: Specifies the stream-id of the stream that the returned streams - flow from. + description: >- + Specifies the stream-id of the stream that the returned streams flow + from. schema: type: string - name: flows-into-stream-id-mask in: query - description: Specifies the stream-id of the stream that the returned streams - flow into. + description: >- + Specifies the stream-id of the stream that the returned streams flow + into. schema: type: string - name: station-unit @@ -8485,42 +9388,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' application/json: schema: type: array items: - "$ref": "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -8540,7 +9443,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Stream" + $ref: '#/components/schemas/Stream' required: true responses: '204': @@ -8550,35 +9453,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/stream-locations/{office}/{name}/downstream-locations": + '/stream-locations/{office}/{name}/downstream-locations': get: tags: - StreamLocations @@ -8588,26 +9491,28 @@ paths: parameters: - name: office in: path - description: Office id for the stream location associated with the downstream + description: >- + Office id for the stream location associated with the downstream locations. required: true schema: type: string - name: name in: path - description: Specifies the name of the stream location whose downstream locations + description: >- + Specifies the name of the stream location whose downstream locations data is to be included in the response. required: true schema: type: string - name: all-downstream in: query - description: If true, retrieve all downstream locations. + description: 'If true, retrieve all downstream locations.' schema: type: boolean - name: same-stream-only in: query - description: If true, retrieve only locations on the same stream. + description: 'If true, retrieve only locations on the same stream.' schema: type: boolean - name: station-unit @@ -8633,41 +9538,41 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/stream-locations/{office}/{name}/upstream-locations": + '/stream-locations/{office}/{name}/upstream-locations': get: tags: - StreamLocations @@ -8677,26 +9582,28 @@ paths: parameters: - name: office in: path - description: Office id for the stream location associated with the upstream + description: >- + Office id for the stream location associated with the upstream locations. required: true schema: type: string - name: name in: path - description: Specifies the name of the stream location whose upstream locations + description: >- + Specifies the name of the stream location whose upstream locations data is to be included in the response. required: true schema: type: string - name: all-upstream in: query - description: If true, retrieve all upstream locations. + description: 'If true, retrieve all upstream locations.' schema: type: boolean - name: same-stream-only in: query - description: If true, retrieve only locations on the same stream. + description: 'If true, retrieve only locations on the same stream.' schema: type: boolean - name: station-unit @@ -8722,41 +9629,41 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/stream-locations/{name}": + '/stream-locations/{name}': get: tags: - StreamLocations @@ -8784,20 +9691,17 @@ paths: type: string - name: station-unit in: query - description: Specifies the unit of measure for the station. Default units - are mi. + description: Specifies the unit of measure for the station. Default units are mi. schema: type: string - name: stage-unit in: query - description: Specifies the unit of measure for the stage. Default units are - ft. + description: Specifies the unit of measure for the stage. Default units are ft. schema: type: string - name: area-unit in: query - description: Specifies the unit of measure for the area. Default units are - mi2. + description: Specifies the unit of measure for the area. Default units are mi2. schema: type: string responses: @@ -8808,42 +9712,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' application/json: schema: type: array items: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -8880,31 +9784,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Stream Location not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -8917,6 +9821,7 @@ paths: parameters: - name: name in: path + description: Specifies the location-id of the stream location to be renamed. required: true schema: type: string @@ -8924,7 +9829,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' required: true responses: '200': @@ -8934,35 +9839,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/stream-locations": + /stream-locations: get: tags: - StreamLocations @@ -8972,13 +9877,15 @@ paths: parameters: - name: office-mask in: query - description: Office id for the reservoir project location associated with - the stream locations. + description: >- + Office id for the reservoir project location associated with the + stream locations. schema: type: string - name: stream-id-mask in: query - description: Specifies the stream-id of the stream that the returned stream + description: >- + Specifies the stream-id of the stream that the returned stream locations belong to. schema: type: string @@ -8989,20 +9896,17 @@ paths: type: string - name: station-unit in: query - description: Specifies the unit of measure for the station. Default units - are mi. + description: Specifies the unit of measure for the station. Default units are mi. schema: type: string - name: stage-unit in: query - description: Specifies the unit of measure for the stage. Default units are - ft. + description: Specifies the unit of measure for the stage. Default units are ft. schema: type: string - name: area-unit in: query - description: Specifies the unit of measure for the area. Default units are - mi2. + description: Specifies the unit of measure for the area. Default units are mi2. schema: type: string responses: @@ -9013,42 +9917,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' application/json: schema: type: array items: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9068,7 +9972,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/StreamLocation" + $ref: '#/components/schemas/StreamLocation' required: true responses: '201': @@ -9078,35 +9982,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/stream-reaches/{name}": + '/stream-reaches/{name}': get: tags: - StreamReaches @@ -9145,42 +10049,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/StreamReach" + $ref: '#/components/schemas/StreamReach' application/json: schema: type: array items: - "$ref": "#/components/schemas/StreamReach" + $ref: '#/components/schemas/StreamReach' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9211,31 +10115,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9271,35 +10175,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/stream-reaches": + /stream-reaches: get: tags: - StreamReaches @@ -9309,8 +10213,9 @@ paths: parameters: - name: office-mask in: query - description: Office id for the reservoir project location associated with - the stream reaches. + description: >- + Office id for the reservoir project location associated with the + stream reaches. schema: type: string - name: stream-id-mask @@ -9341,42 +10246,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/StreamReach" + $ref: '#/components/schemas/StreamReach' application/json: schema: type: array items: - "$ref": "#/components/schemas/StreamReach" + $ref: '#/components/schemas/StreamReach' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9396,7 +10301,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/StreamReach" + $ref: '#/components/schemas/StreamReach' required: true responses: '201': @@ -9406,35 +10311,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/measurements/time-extents": + /measurements/time-extents: get: tags: - Measurements @@ -9455,41 +10360,41 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/CwmsIdTimeExtentsEntry" + $ref: '#/components/schemas/CwmsIdTimeExtentsEntry' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/measurements": + /measurements: get: tags: - Measurements @@ -9499,13 +10404,15 @@ paths: parameters: - name: office-mask in: query - description: Office id mask for filtering measurements. Use null to retrieve + description: >- + Office id mask for filtering measurements. Use null to retrieve measurements for all offices. schema: type: string - name: id-mask in: query - description: Location id mask for filtering measurements. Use null to retrieve + description: >- + Location id mask for filtering measurements. Use null to retrieve measurements for all locations. schema: type: string @@ -9521,25 +10428,31 @@ paths: type: string - name: begin in: query - description: The start of the time window to delete. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. - A null value is treated as an unbounded start. + description: >- + The start of the time window to delete. The format for this field is ISO 8601 extended, + with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. A null value is treated as an unbounded + start. schema: type: string - name: end in: query - description: The end of the time window to delete.The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. - A null value is treated as an unbounded end. + description: >- + The end of the time window to delete.The format + for this field is ISO 8601 extended, with optional offset and + timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. A null value is treated as an unbounded + end. schema: type: string - name: timezone in: query - description: This field specifies a default timezone to be used if the format - of the beginand end parameters do not include offset or time zone information. - Defaults to UTC. + description: >- + This field specifies a default timezone to be used if the format of + the beginand end parameters do not include offset or time zone + information. Defaults to UTC. schema: type: string - name: min-height @@ -9574,11 +10487,16 @@ paths: type: string - name: unit-system in: query - description: "Specifies the unit system of the response. Valid values for - the unit field are: \n* `EN` Specifies English unit system. Location values - will be in the default English units for their parameters.\n* `SI` Specifies - the SI unit system. Location values will be in the default SI units for - their parameters. If not specified, EN is used." + description: >- + Specifies the unit system of the response. Valid values for the unit + field are: + + * `EN` Specifies English unit system. Location values will be in + the default English units for their parameters. + + * `SI` Specifies the SI unit system. Location values will be in + the default SI units for their parameters. If not specified, EN is + used. schema: type: string responses: @@ -9589,42 +10507,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Measurement" + $ref: '#/components/schemas/Measurement' application/json: schema: type: array items: - "$ref": "#/components/schemas/Measurement" + $ref: '#/components/schemas/Measurement' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9637,8 +10555,9 @@ paths: parameters: - name: fail-if-exists in: query - description: 'Create will fail if provided Measurement(s) already exist. Default: - true' + description: >- + Create will fail if provided Measurement(s) already exist. Default: + true schema: type: boolean requestBody: @@ -9647,12 +10566,12 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Measurement" + $ref: '#/components/schemas/Measurement' application/json: schema: type: array items: - "$ref": "#/components/schemas/Measurement" + $ref: '#/components/schemas/Measurement' required: true responses: '201': @@ -9662,35 +10581,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/measurements/{location-id}": + '/measurements/{location-id}': delete: tags: - Measurements @@ -9712,25 +10631,29 @@ paths: type: string - name: begin in: query - description: The start of the time window to delete. The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. - required: true + description: >- + The start of the time window to delete. The format for this field is ISO 8601 extended, + with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: end in: query - description: The end of the time window to delete.The format - for this field is ISO 8601 extended, with optional offset and timezone, - i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., '2021-06-10T13:00:00-07:00'. - required: true + description: >- + The end of the time window to delete.The format + for this field is ISO 8601 extended, with optional offset and + timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. schema: type: string - name: timezone in: query - description: This field specifies a default timezone to be used if the format - of the beginand end parameters do not include offset or time zone information. - Defaults to UTC. + description: >- + This field specifies a default timezone to be used if the format of + the beginand end parameters do not include offset or time zone + information. Defaults to UTC. schema: type: string - name: min-number @@ -9751,41 +10674,116 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Measurement not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + /published: + get: + tags: + - Published + summary: Get published + description: Returns matching time series identifiers for published data. + operationId: getPublished + parameters: + - name: office-mask + in: query + description: Office Id used to filter the results. + schema: + type: string + - name: location-mask + in: query + description: Location Id used to filter the results. + schema: + type: string + - name: page + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: page-size + in: query + description: How many entries per page returned. Default 20. + schema: + type: integer + format: int32 + responses: + '200': + description: OK + content: + application/json;version=1: + schema: + type: array + items: + $ref: '#/components/schemas/LocationToPublishedDataList' + '400': + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' + '404': + description: Not Found + content: + application/json: + schema: + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/blobs/{blob-id}": + '/blobs/{blob-id}': get: tags: - Blob summary: Get blobs with blobId - description: Returns the binary value of the requested blob as a seekable stream - with the appropriate media type. + description: >- + Returns the binary value of the requested blob as a seekable stream with + the appropriate media type. operationId: getBlobsWithBlobId parameters: - name: blob-id @@ -9793,20 +10791,23 @@ paths: required: true schema: type: string - - name: office + - name: blob-id in: query - description: Specifies the owning office. + description: >- + If this _query_ parameter is provided the id _path_ parameter is + ignored and the value of the query parameter is used. Note: this + query parameter is necessary for id's that contain '/' or other + special characters. This is due to limitations in path pattern + matching. We will likely add support for encoding the ID in the path + in the future. For now use the id field for those IDs. Client + libraries should detect slashes and choose the appropriate field. + "ignored" is suggested for the path endpoint. + required: true schema: type: string - - name: blob-id + - name: office in: query - description: 'If this _query_ parameter is provided the id _path_ parameter - is ignored and the value of the query parameter is used. Note: this query - parameter is necessary for id''s that contain ''/'' or other special characters. - This is due to limitations in path pattern matching. We will likely add - support for encoding the ID in the path in the future. For now use the id - field for those IDs. Client libraries should detect slashes and choose the - appropriate field. "ignored" is suggested for the path endpoint.' + description: Specifies the owning office. schema: type: string responses: @@ -9815,37 +10816,38 @@ paths: content: application/octet-stream: schema: - "$ref": "#/components/schemas/Unit" + type: string + format: binary '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9863,13 +10865,15 @@ paths: type: string - name: blob-id in: query - description: 'If this _query_ parameter is provided the id _path_ parameter - is ignored and the value of the query parameter is used. Note: this query - parameter is necessary for id''s that contain ''/'' or other special characters. - This is due to limitations in path pattern matching. We will likely add - support for encoding the ID in the path in the future. For now use the id - field for those IDs. Client libraries should detect slashes and choose the - appropriate field. "ignored" is suggested for the path endpoint.' + description: >- + If this _query_ parameter is provided the id _path_ parameter is + ignored and the value of the query parameter is used. Note: this + query parameter is necessary for id's that contain '/' or other + special characters. This is due to limitations in path pattern + matching. We will likely add support for encoding the ID in the path + in the future. For now use the id field for those IDs. Client + libraries should detect slashes and choose the appropriate field. + "ignored" is suggested for the path endpoint. required: true schema: type: string @@ -9885,31 +10889,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -9927,13 +10931,15 @@ paths: type: string - name: blob-id in: query - description: 'If this _query_ parameter is provided the id _path_ parameter - is ignored and the value of the query parameter is used. Note: this query - parameter is necessary for id''s that contain ''/'' or other special characters. - This is due to limitations in path pattern matching. We will likely add - support for encoding the ID in the path in the future. For now use the id - field for those IDs. Client libraries should detect slashes and choose the - appropriate field. "ignored" is suggested for the path endpoint.' + description: >- + If this _query_ parameter is provided the id _path_ parameter is + ignored and the value of the query parameter is used. Note: this + query parameter is necessary for id's that contain '/' or other + special characters. This is due to limitations in path pattern + matching. We will likely add support for encoding the ID in the path + in the future. For now use the id field for those IDs. Client + libraries should detect slashes and choose the appropriate field. + "ignored" is suggested for the path endpoint. required: true schema: type: string @@ -9941,10 +10947,10 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Blob" + $ref: '#/components/schemas/Blob' application/json: schema: - "$ref": "#/components/schemas/Blob" + $ref: '#/components/schemas/Blob' required: true responses: '400': @@ -9952,35 +10958,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/blobs": + /blobs: get: tags: - Blob @@ -9989,15 +10995,27 @@ paths: parameters: - name: office in: query - description: Specifies the owning office. If this field is not specified, + description: >- + Specifies the owning office. If this field is not specified, matching information from all offices shall be returned. schema: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size @@ -10008,8 +11026,9 @@ paths: format: int32 - name: like in: query - description: Posix regular expression describing - the blob id's you want + description: >- + Posix regular expression describing the + blob id's you want schema: type: string responses: @@ -10018,40 +11037,40 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Blobs" + $ref: '#/components/schemas/Blobs' application/json;version=2: schema: - "$ref": "#/components/schemas/Blobs" + $ref: '#/components/schemas/Blobs' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -10071,7 +11090,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Blob" + $ref: '#/components/schemas/Blob' required: true responses: '400': @@ -10079,45 +11098,47 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/clobs/{clob-id}": + '/clobs/{clob-id}': get: tags: - Clob summary: Get clobs with clobId - description: Get a single clob. If the accept header is set to text/plain, - the raw value is returned as the response body. Responses to text/plain requests - are streamed and support the Range header. When the accept header is set - to application/json;version=2 the clob will be returned as a serialized Clob - object with fields for office-id, id, description and value. For more information - about accept header usage, see this page. + description: >- + Get a single clob. If the accept header is set to text/plain, the raw + value is returned as the response body. Responses to text/plain requests + are streamed and support the Range header. When the accept header is + set to application/json;version=2 the clob will be returned as a + serialized Clob object with fields for office-id, id, description and + value. For more information about accept header usage, see this page. operationId: getClobsWithClobId parameters: - name: clob-id @@ -10125,20 +11146,23 @@ paths: required: true schema: type: string - - name: office + - name: clob-id in: query - description: Specifies the owning office. + description: >- + If this _query_ parameter is provided the id _path_ parameter is + ignored and the value of the query parameter is used. Note: this + query parameter is necessary for id's that contain '/' or other + special characters. This is due to limitations in path pattern + matching. We will likely add support for encoding the ID in the path + in the future. For now use the id field for those IDs. Client + libraries should detect slashes and choose the appropriate field. + "ignored" is suggested for the path endpoint. + required: true schema: type: string - - name: clob-id + - name: office in: query - description: 'If this _query_ parameter is provided the id _path_ parameter - is ignored and the value of the query parameter is used. Note: this query - parameter is necessary for id''s that contain ''/'' or other special characters. - This is due to limitations in path pattern matching. We will likely add - support for encoding the ID in the path in the future. For now use the id - field for those IDs. Client libraries should detect slashes and choose the - appropriate field. "ignored" is suggested for the path endpoint.' + description: Specifies the owning office. schema: type: string responses: @@ -10147,7 +11171,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Clob" + $ref: '#/components/schemas/Clob' text/plain: schema: type: string @@ -10156,31 +11180,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -10198,13 +11222,15 @@ paths: type: string - name: clob-id in: query - description: 'If this _query_ parameter is provided the id _path_ parameter - is ignored and the value of the query parameter is used. Note: this query - parameter is necessary for id''s that contain ''/'' or other special characters. - This is due to limitations in path pattern matching. We will likely add - support for encoding the ID in the path in the future. For now use the id - field for those IDs. Client libraries should detect slashes and choose the - appropriate field. "ignored" is suggested for the path endpoint.' + description: >- + If this _query_ parameter is provided the id _path_ parameter is + ignored and the value of the query parameter is used. Note: this + query parameter is necessary for id's that contain '/' or other + special characters. This is due to limitations in path pattern + matching. We will likely add support for encoding the ID in the path + in the future. For now use the id field for those IDs. Client + libraries should detect slashes and choose the appropriate field. + "ignored" is suggested for the path endpoint. required: true schema: type: string @@ -10220,31 +11246,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -10262,30 +11288,33 @@ paths: type: string - name: clob-id in: query - description: 'If this _query_ parameter is provided the id _path_ parameter - is ignored and the value of the query parameter is used. Note: this query - parameter is necessary for id''s that contain ''/'' or other special characters. - This is due to limitations in path pattern matching. We will likely add - support for encoding the ID in the path in the future. For now use the id - field for those IDs. Client libraries should detect slashes and choose the - appropriate field. "ignored" is suggested for the path endpoint.' + description: >- + If this _query_ parameter is provided the id _path_ parameter is + ignored and the value of the query parameter is used. Note: this + query parameter is necessary for id's that contain '/' or other + special characters. This is due to limitations in path pattern + matching. We will likely add support for encoding the ID in the path + in the future. For now use the id field for those IDs. Client + libraries should detect slashes and choose the appropriate field. + "ignored" is suggested for the path endpoint. required: true schema: type: string - name: ignore-nulls in: query - description: 'If true, null and empty fields in the provided clob will be - ignored and the existing value of those fields left in place. Default: true' + description: >- + If true, null and empty fields in the provided clob will be ignored + and the existing value of those fields left in place. Default: true schema: type: boolean requestBody: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Clob" + $ref: '#/components/schemas/Clob' application/xml;version=2: schema: - "$ref": "#/components/schemas/Clob" + $ref: '#/components/schemas/Clob' required: true responses: '400': @@ -10293,35 +11322,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/clobs": + /clobs: get: tags: - Clob @@ -10330,15 +11359,27 @@ paths: parameters: - name: office in: query - description: Specifies the owning office. If this field is not specified, + description: >- + Specifies the owning office. If this field is not specified, matching information from all offices shall be returned. schema: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size @@ -10349,13 +11390,15 @@ paths: format: int32 - name: include-values in: query - description: 'Do you want the value associated with this particular clob (default: - false)' + description: >- + Do you want the value associated with this particular clob (default: + false) schema: type: boolean - name: like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the id schema: type: string @@ -10365,40 +11408,40 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Clobs" + $ref: '#/components/schemas/Clobs' application/xml;version=2: schema: - "$ref": "#/components/schemas/Clobs" + $ref: '#/components/schemas/Clobs' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -10418,10 +11461,10 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Clob" + $ref: '#/components/schemas/Clob' application/xml;version=2: schema: - "$ref": "#/components/schemas/Clob" + $ref: '#/components/schemas/Clob' required: true responses: '400': @@ -10429,35 +11472,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/pools/{pool-id}": + '/pools/{pool-id}': get: tags: - Pools @@ -10473,37 +11516,41 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the Pool whose data is to be included + description: >- + Specifies the owning office of the Pool whose data is to be included in the response. required: true schema: type: string - name: project-id in: query - description: Specifies the project-id of the Pool whose data is to be included - in the response. + description: >- + Specifies the project-id of the Pool whose data is to be included in + the response. required: true schema: type: string - name: bottom-mask in: query - description: Bottom level mask. Default value:* + description: 'Bottom level mask. Default value:*' schema: type: string - name: top-mask in: query - description: Top level mask. Default value:* + description: 'Top level mask. Default value:*' schema: type: string - name: include-explicit in: query - description: Specifies if the results should include explicit Pools. Default + description: >- + Specifies if the results should include explicit Pools. Default value:false schema: type: string - name: include-implicit in: query - description: Specifies if the results should include implicit Pools. Default + description: >- + Specifies if the results should include implicit Pools. Default value:true schema: type: string @@ -10513,44 +11560,45 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Pool" + $ref: '#/components/schemas/Pool' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the Location Category + description: >- + Based on the combination of inputs provided the Location Category was not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/pools": + /pools: get: tags: - Pools @@ -10560,47 +11608,62 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the data in the response. If this - field is not specified, matching items from all offices shall be returned. + description: >- + Specifies the owning office of the data in the response. If this + field is not specified, matching items from all offices shall be + returned. schema: type: string - name: id-mask in: query - description: Project Id mask. Default value:* + description: 'Project Id mask. Default value:*' schema: type: string - name: name-mask in: query - description: Name mask. Default value:* + description: 'Name mask. Default value:*' schema: type: string - name: bottom-mask in: query - description: Bottom level mask. Default value:* + description: 'Bottom level mask. Default value:*' schema: type: string - name: top-mask in: query - description: Top level mask. Default value:* + description: 'Top level mask. Default value:*' schema: type: string - name: include-explicit in: query - description: Specifies if the results should include explicit Pools. Default + description: >- + Specifies if the results should include explicit Pools. Default value:false schema: type: string - name: include-implicit in: query - description: Specifies if the results should include implicit Pools. Default + description: >- + Specifies if the results should include implicit Pools. Default value:true schema: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size @@ -10615,44 +11678,45 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/Pools" + $ref: '#/components/schemas/Pools' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the pools were - not found. + description: >- + Based on the combination of inputs provided the pools were not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/specified-levels": + /specified-levels: get: tags: - Levels @@ -10661,15 +11725,17 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the Specified Levels whose data - is to be included in the response. If this field is not specified, matching - rating information from all offices shall be returned. + description: >- + Specifies the owning office of the Specified Levels whose data is to + be included in the response. If this field is not specified, + matching rating information from all offices shall be returned. schema: type: string - name: template-id-mask in: query - description: Mask that specifies the IDs to be included in the response. If - this field is not specified, all specified levels shall be returned. + description: >- + Mask that specifies the IDs to be included in the response. If this + field is not specified, all specified levels shall be returned. schema: type: string responses: @@ -10678,37 +11744,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/SpecifiedLevel" + $ref: '#/components/schemas/SpecifiedLevel' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -10728,7 +11794,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/SpecifiedLevel" + $ref: '#/components/schemas/SpecifiedLevel' required: true responses: '400': @@ -10736,35 +11802,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/specified-levels/{specified-level-id}": + '/specified-levels/{specified-level-id}': delete: tags: - Levels @@ -10780,7 +11846,8 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the timeseries identifier to be + description: >- + Specifies the owning office of the timeseries identifier to be deleted required: true schema: @@ -10791,31 +11858,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -10849,35 +11916,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/forecast-instance/{name}": + '/forecast-instance/{name}': get: tags: - Forecast @@ -10887,35 +11954,40 @@ paths: parameters: - name: name in: path - description: Specifies the spec id of the forecast spec whose forecast instance + description: >- + Specifies the spec id of the forecast spec whose forecast instance data is to be included in the response. required: true schema: type: string - name: forecast-date in: query - description: Specifies the forecast date time of the forecast instance to - be retrieved. + description: >- + Specifies the forecast date time of the forecast instance to be + retrieved. required: true schema: type: string - name: issue-date in: query - description: Specifies the issue date time of the forecast instance to be + description: >- + Specifies the issue date time of the forecast instance to be retrieved. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the forecast spec whose forecast + description: >- + Specifies the owning office of the forecast spec whose forecast instance is to be included in the response. required: true schema: type: string - name: designator in: query - description: Specifies the designator of the forecast spec whose forecast + description: >- + Specifies the designator of the forecast spec whose forecast instance data to be included in the response. schema: type: string @@ -10925,38 +11997,39 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastInstance" + $ref: '#/components/schemas/ForecastInstance' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a forecast + description: >- + The provided combination of parameters did not find a forecast instance. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -10971,36 +12044,41 @@ paths: parameters: - name: name in: path - description: Specifies the spec id of the forecast spec associated with the + description: >- + Specifies the spec id of the forecast spec associated with the forecast instanceto be deleted. required: true schema: type: string - name: forecast-date in: query - description: Specifies the forecast date time of the forecast instance to - be deleted. + description: >- + Specifies the forecast date time of the forecast instance to be + deleted. required: true schema: type: string - name: issue-date in: query - description: Specifies the issue date time of the forecast instance to be + description: >- + Specifies the issue date time of the forecast instance to be deleted. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the forecast spec associated with - the forecast instance to be deleted. + description: >- + Specifies the owning office of the forecast spec associated with the + forecast instance to be deleted. required: true schema: type: string - name: designator in: query - description: Specifies the designator of the forecast spec associated with - the forecast instance to be deleted. + description: >- + Specifies the designator of the forecast spec associated with the + forecast instance to be deleted. schema: type: string responses: @@ -11009,32 +12087,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a forecast + description: >- + The provided combination of parameters did not find a forecast instance. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -11042,7 +12121,8 @@ paths: tags: - Forecast summary: Patch forecastInstance with name - description: Update a forecast instance with new max age, notes, forecast fileand + description: >- + Update a forecast instance with new max age, notes, forecast fileand forecast info key/value pairs. operationId: patchForecastInstanceWithName parameters: @@ -11056,7 +12136,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastInstance" + $ref: '#/components/schemas/ForecastInstance' required: true responses: '400': @@ -11064,36 +12144,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the ForecastInstance - was not found. + description: >- + Based on the combination of inputs provided the ForecastInstance was + not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/forecast-instance": + /forecast-instance: get: tags: - Forecast @@ -11103,20 +12184,25 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the forecast spec whose forecast - instance is to be included in the response. Default will be all offices. + description: >- + Specifies the owning office of the forecast spec whose forecast + instance is to be included in the response. Default will be all + offices. schema: type: string - name: name in: query - description: Specifies the spec id of the forecast spec whose forecast instance + description: >- + Specifies the spec id of the forecast spec whose forecast instance data is to be included in the response. Default will be all names. schema: type: string - name: designator in: query - description: 'Specifies the designator of the forecast spec whose forecast - instance data to be included in the response. ' + description: >- + Specifies the designator of the forecast spec to filter the forecast + instance data in the response. This parameter is an exact-match + string; if not provided, no filter is applied. Default is no filter. schema: type: string responses: @@ -11125,37 +12211,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastInstance" + $ref: '#/components/schemas/ForecastInstance' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -11171,7 +12257,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastInstance" + $ref: '#/components/schemas/ForecastInstance' required: true responses: '400': @@ -11179,35 +12265,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/forecast-spec/{name}": + '/forecast-spec/{name}': get: tags: - Forecast @@ -11217,21 +12303,24 @@ paths: parameters: - name: name in: path - description: Specifies the spec id of the forecast spec whose data is to be + description: >- + Specifies the spec id of the forecast spec whose data is to be included in the response. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the forecast spec whose data is - to be included in the response. + description: >- + Specifies the owning office of the forecast spec whose data is to be + included in the response. required: true schema: type: string - name: designator in: query - description: Specifies the designator of the forecast spec whose data to be + description: >- + Specifies the designator of the forecast spec whose data to be included in the response. schema: type: string @@ -11241,38 +12330,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastSpec" + $ref: '#/components/schemas/ForecastSpec' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a forecast - spec. + description: The provided combination of parameters did not find a forecast spec. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -11287,61 +12375,63 @@ paths: parameters: - name: name in: path - description: Specifies the spec id of the forecast spec whose data is to be + description: >- + Specifies the spec id of the forecast spec whose data is to be deleted. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the forecast spec whose data is - to be deleted. + description: >- + Specifies the owning office of the forecast spec whose data is to be + deleted. required: true schema: type: string - name: designator in: query - description: Specifies the designator of the forecast spec whose data is to - be deleted. + description: >- + Specifies the designator of the forecast spec whose data is to be + deleted. schema: type: string - name: method in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a forecast - spec. + description: The provided combination of parameters did not find a forecast spec. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -11362,7 +12452,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastSpec" + $ref: '#/components/schemas/ForecastSpec' required: true responses: '400': @@ -11370,36 +12460,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the forecast spec - was not found. + description: >- + Based on the combination of inputs provided the forecast spec was + not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/forecast-spec": + /forecast-spec: get: tags: - Forecast @@ -11409,28 +12500,40 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the forecast spec whose data is - to be included in the response. + description: >- + Specifies the owning office of the forecast spec whose data is to be + included in the response. schema: type: string - name: id-mask in: query - description: Posix regular expression that specifies + description: >- + Posix regular expression that specifies the spec IDs to be included in the response. schema: type: string - name: designator-mask in: query - description: 'Posix regular expression that specifies - the designator of the forecast spec whose data to be included in the response. - Default behavior when this parameter is not provided is to search for forecast - specifications with a null designator. ' + description: >- + Posix regular expression that specifies + the designator of the forecast spec whose data to be included in the + response. Default behavior when this parameter is not provided is to + search for forecast specifications with a null designator. schema: type: string - name: source-entity in: query - description: Specifies the source identity of the forecast spec whose data - is to be included in the response. + description: >- + Specifies the source identity of the forecast spec whose data is to + be included in the response. Interpreted as a regular expression. + schema: + type: string + - name: source-entity-like + in: query + description: >- + Specifies the source entity using LIKE-style matching. If provided, + this parameter is used instead of the regular expression parameter + 'source-entity'. schema: type: string responses: @@ -11439,37 +12542,37 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastSpec" + $ref: '#/components/schemas/ForecastSpec' '400': description: Invalid parameter combination content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -11485,7 +12588,7 @@ paths: content: application/json;version=2: schema: - "$ref": "#/components/schemas/ForecastSpec" + $ref: '#/components/schemas/ForecastSpec' required: true responses: '400': @@ -11493,35 +12596,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/forecast-instance/{name}/file-data": + '/forecast-instance/{name}/file-data': get: tags: - Forecast @@ -11531,35 +12634,40 @@ paths: parameters: - name: name in: path - description: Specifies the spec id of the forecast spec whose forecast instance + description: >- + Specifies the spec id of the forecast spec whose forecast instance data is to be included in the response. required: true schema: type: string - name: forecast-date in: query - description: Specifies the forecast date time of the forecast instance to - be retrieved. + description: >- + Specifies the forecast date time of the forecast instance to be + retrieved. required: true schema: type: string - name: issue-date in: query - description: Specifies the issue date time of the forecast instance to be + description: >- + Specifies the issue date time of the forecast instance to be retrieved. required: true schema: type: string - name: office in: query - description: Specifies the owning office of the forecast spec whose forecast + description: >- + Specifies the owning office of the forecast spec whose forecast instance is to be included in the response. required: true schema: type: string - name: designator in: query - description: Specifies the designator of the forecast spec whose forecast + description: >- + Specifies the designator of the forecast spec whose forecast instance data to be included in the response. schema: type: string @@ -11576,44 +12684,46 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: The provided combination of parameters did not find a forecast + description: >- + The provided combination of parameters did not find a forecast instance. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/status-update/{name}": + '/projects/status-update/{name}': post: tags: - Projects summary: Post projects statusUpdate with name - description: Publishes a message on the office's STATUS queue that a project - has been updated for a specified application + description: >- + Publishes a message on the office's STATUS queue that a project has been + updated for a specified application operationId: postProjectsStatusUpdateWithName parameters: - name: name @@ -11630,34 +12740,44 @@ paths: type: string - name: application-id in: query - description: A text string identifying the application for which the update + description: >- + A text string identifying the application for which the update applies. required: true schema: type: string - name: source-id in: query - description: An application-defined string of the instance and/or component - that generated the message. If NULL or not specified, the generated message - will not include this item. + description: >- + An application-defined string of the instance and/or component that + generated the message. If NULL or not specified, the generated + message will not include this item. schema: type: string - name: timeseries-id in: query - description: A time series identifier of the time series associated with the - update. If NULL or not specified, the generated message will not include - this item. + description: >- + A time series identifier of the time series associated with the + update. If NULL or not specified, the generated message will not + include this item. + schema: + type: string + - name: timezone + in: query + description: "Specifies the time zone of the values of the begin and end fields (unless otherwise specified). For other formats this parameter affects the time zone of times in the response. If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone." schema: type: string - name: begin in: query - description: The start time of the updates to the time series. If NULL or - not specified, the generated message will not include this item. + description: >- + The start time of the updates to the time series. If NULL or not + specified, the generated message will not include this item. schema: type: string - name: end in: query - description: The end time of the updates to the time series. If NULL or not + description: >- + The end time of the updates to the time series. If NULL or not specified, the generated message will not include this item. schema: type: string @@ -11669,35 +12789,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/water-user/{water-user}": + '/projects/{office}/{project-id}/water-user/{water-user}': get: tags: - Water Contracts @@ -11729,37 +12849,37 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -11792,38 +12912,38 @@ paths: in: query description: Specifies the delete method used. Default is DELETE_KEY. schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -11862,7 +12982,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUser" + $ref: '#/components/schemas/WaterUser' required: true responses: '200': @@ -11872,37 +12992,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/water-user": + '/projects/{office}/{project-id}/water-user': get: tags: - Water Contracts @@ -11928,37 +13048,37 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUser" + $ref: '#/components/schemas/WaterUser' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -11981,15 +13101,16 @@ paths: type: string - name: fail-if-exists in: query - description: 'If true, the operation will fail if the water user already exists. - Default: true' + description: >- + If true, the operation will fail if the water user already exists. + Default: true schema: type: boolean requestBody: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUser" + $ref: '#/components/schemas/WaterUser' required: true responses: '201': @@ -11999,44 +13120,46 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}": + '/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}': get: tags: - Water Contracts - summary: Get projects with office with projectId waterUser with waterUser contracts - with contractName + summary: >- + Get projects with office with projectId waterUser with waterUser + contracts with contractName description: Return a specified water contract - operationId: getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName + operationId: >- + getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName parameters: - name: office in: path @@ -12068,40 +13191,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' application/json: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find any contracts. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented. security: @@ -12110,10 +13233,12 @@ paths: delete: tags: - Water Contracts - summary: Delete projects with office with projectId waterUser with waterUser + summary: >- + Delete projects with office with projectId waterUser with waterUser contracts with contractName description: Delete a specified water contract - operationId: deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName + operationId: >- + deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName parameters: - name: office in: path @@ -12143,48 +13268,50 @@ paths: in: query description: Specifies the delete method used. Defaults to DELETE_KEY. schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] patch: tags: - Water Contracts - summary: Patch projects with office with projectId waterUser with waterUser + summary: >- + Patch projects with office with projectId waterUser with waterUser contracts with contractName description: Renames a water contract - operationId: patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName + operationId: >- + patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName parameters: - name: office in: path @@ -12219,7 +13346,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' required: true responses: '200': @@ -12229,41 +13356,43 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find a contract content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented. security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/water-user/{water-user}/contracts": + '/projects/{office}/{project-id}/water-user/{water-user}/contracts': get: tags: - Water Contracts - summary: Get projects with office with projectId waterUser with waterUser contracts + summary: >- + Get projects with office with projectId waterUser with waterUser + contracts description: Return all water contracts operationId: getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts parameters: @@ -12291,40 +13420,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' application/json: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find any contracts. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented. security: @@ -12333,7 +13462,9 @@ paths: post: tags: - Water Contracts - summary: Post projects with office with projectId waterUser with waterUser contracts + summary: >- + Post projects with office with projectId waterUser with waterUser + contracts description: Create a new water contract operationId: postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts parameters: @@ -12357,19 +13488,19 @@ paths: type: string - name: fail-if-exists in: query - description: If true, the contract will not be stored if it already exists. + description: 'If true, the contract will not be stored if it already exists.' schema: type: boolean - name: ignore-nulls in: query - description: If true, null fields will be ignored when storing the contract. + description: 'If true, null fields will be ignored when storing the contract.' schema: type: boolean requestBody: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterUserContract" + $ref: '#/components/schemas/WaterUserContract' required: true responses: '204': @@ -12379,49 +13510,50 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented. security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}/accounting": + '/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}/accounting': get: tags: - Pump Accounting - summary: Get projects with office with projectId waterUser with waterUser contracts - with contractName accounting + summary: >- + Get projects with office with projectId waterUser with waterUser + contracts with contractName accounting description: Get pump accounting entries associated with a water supply contract. - operationId: getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameAccounting + operationId: >- + getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameAccounting parameters: - name: office in: path - description: The office ID of the project the pump accounting is associated - with. + description: The office ID of the project the pump accounting is associated with. required: true schema: type: string @@ -12443,59 +13575,76 @@ paths: required: true schema: type: string + - name: Accept + in: header + description: >- + The requested response format. Supported values are + application/json;version=1, application/json, and + application/json;version=2. application/json;version=2 should be + used only when providing a URL-safe base64 encoded contract ID. If + not provided, application/json;version=1 will be used as the + default. + schema: + type: string - name: start in: query - description: The start time of the time window for pump accounting entries - to retrieve. The format for this field is ISO 8601 - extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'. + description: >- + The start time of the time window for pump accounting entries to + retrieve. The format for this field is ISO + 8601 extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. required: true schema: type: string - name: end in: query - description: The end time of the time window for pump accounting entries to - retrieve.The format for this field is ISO 8601 - extended, with optional offset and timezone, i.e., 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', - e.g., '2021-06-10T13:00:00-07:00'. + description: >- + The end time of the time window for pump accounting entries to + retrieve.The format for this field is ISO + 8601 extended, with optional offset and timezone, i.e., + 'YYYY-MM-dd'T'hh:mm:ss[Z'['VV']']', e.g., + '2021-06-10T13:00:00-07:00'. required: true schema: type: string - name: timezone in: query - description: This field specifies a default timezone to be used if the format - of the end or begin parameters do not include offset or time zone information. - Defaults to UTC. + description: >- + This field specifies a default timezone to be used if the format of + the end or begin parameters do not include offset or time zone + information. Defaults to UTC. schema: type: string - name: unit in: query - description: The unit of the flow rate of the accounting entries to retrieve. + description: >- + The unit of the flow rate of the accounting entries to retrieve. Defaults to 'cms'. schema: type: string - name: start-time-inclusive in: query - description: Whether or not the start time is inclusive or not. Defaults to - TRUE. + description: Whether or not the start time is inclusive or not. Defaults to TRUE. schema: type: boolean - name: end-time-inclusive in: query - description: Whether or not the end time is inclusive or not. Defaults to - TRUE. + description: Whether or not the end time is inclusive or not. Defaults to TRUE. schema: type: boolean - name: ascending in: query - description: Whether or not the entries should be returned in ascending order. + description: >- + Whether or not the entries should be returned in ascending order. Defaults to TRUE. schema: type: boolean - name: row-limit in: query - description: The maximum number of rows to return. Defaults to 0, which means - no limit. + description: >- + The maximum number of rows to return. Defaults to 0, which means no + limit. schema: type: integer format: int32 @@ -12507,42 +13656,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/WaterSupplyAccounting" + $ref: '#/components/schemas/WaterSupplyAccounting' application/json: schema: type: array items: - "$ref": "#/components/schemas/WaterSupplyAccounting" + $ref: '#/components/schemas/WaterSupplyAccounting' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Pump Accounting not found for provided input parameters. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: @@ -12551,11 +13700,14 @@ paths: post: tags: - Pump Accounting - summary: Post projects with office with projectId waterUser with waterUser contracts - with contractName accounting - description: Create a new pump accounting entry associated with a water supply + summary: >- + Post projects with office with projectId waterUser with waterUser + contracts with contractName accounting + description: >- + Create a new pump accounting entry associated with a water supply contract. - operationId: postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameAccounting + operationId: >- + postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameAccounting parameters: - name: office in: path @@ -12576,15 +13728,27 @@ paths: type: string - name: contract-name in: path - description: The name of the contract associated with the accounting. + description: >- + The name of the contract associated with the accounting. For names + with special characters (such as '/'), use the JSONV2 accept header + with a name encoded using URL-safe BASE64. required: true schema: type: string + - name: Accept + in: header + description: >- + The format of the request body. Accepts JSONV1 and JSONV2. Note: + JSONV2 should be used if the contract name contains special + characters such as '/'. In this case, the contract name should be + encoded using URL-safe BASE64 encoding. + schema: + type: string requestBody: content: application/json;version=1: schema: - "$ref": "#/components/schemas/WaterSupplyAccounting" + $ref: '#/components/schemas/WaterSupplyAccounting' required: true responses: '201': @@ -12594,44 +13758,46 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}/pumps/{name}": + '/projects/{office}/{project-id}/water-user/{water-user}/contracts/{contract-name}/pumps/{name}': delete: tags: - Water Contracts - summary: Delete projects with office with projectId waterUser with waterUser + summary: >- + Delete projects with office with projectId waterUser with waterUser contracts with contractName pumps with name description: Disassociate a pump from a contract - operationId: deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithName + operationId: >- + deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithName parameters: - name: office in: path @@ -12659,21 +13825,23 @@ paths: type: string - name: name in: path - description: The name of the pump to be disassociated from the specified contract. + description: >- + The name of the pump to be disassociated from the specified + contract. required: true schema: type: string - name: pump-type in: query - description: 'The type of pump to be disassociated from the contract. Expected - values: IN, OUT, OUT BELOW' + description: >- + The type of pump to be disassociated from the contract. Expected + values: IN, OUT, OUT BELOW required: true schema: - "$ref": "#/components/schemas/PumpType" + $ref: '#/components/schemas/PumpType' - name: delete-accounting in: query - description: Whether to delete the associated accounting data. Defaults to - FALSE. + description: Whether to delete the associated accounting data. Defaults to FALSE. schema: type: boolean responses: @@ -12682,35 +13850,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/contract-types": + '/projects/{office}/contract-types': get: tags: - Water Contracts @@ -12730,40 +13898,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' application/json: schema: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: The provided combination of parameters did not find any contracts. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented. security: @@ -12783,15 +13951,16 @@ paths: type: string - name: fail-if-exists in: query - description: 'Create will fail if provideddisplay value already exists. Default: - true' + description: >- + Create will fail if provideddisplay value already exists. Default: + true schema: type: boolean requestBody: content: application/json;version=1: schema: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' required: true responses: '201': @@ -12801,37 +13970,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: Requested format is not implemented. security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/contract-types/{display-value}": + '/projects/{office}/contract-types/{display-value}': delete: tags: - Water Contracts @@ -12857,35 +14026,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/embankments/{name}": + '/projects/embankments/{name}': get: tags: - Embankments @@ -12913,42 +14082,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Embankment" + $ref: '#/components/schemas/Embankment' application/json: schema: type: array items: - "$ref": "#/components/schemas/Embankment" + $ref: '#/components/schemas/Embankment' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -12975,7 +14144,7 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '200': description: Embankment successfully deleted from CWMS. @@ -12984,32 +14153,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the embankment - was not found. + description: >- + Based on the combination of inputs provided the embankment was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13045,35 +14215,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/embankments": + /projects/embankments: get: tags: - Embankments @@ -13083,14 +14253,16 @@ paths: parameters: - name: office in: query - description: Office id for the reservoir project location associated with - the embankments. + description: >- + Office id for the reservoir project location associated with the + embankments. schema: type: string - name: project-id in: query - description: Specifies the project-id of the Embankments whose data is to - be included in the response. + description: >- + Specifies the project-id of the Embankments whose data is to be + included in the response. required: true schema: type: string @@ -13102,42 +14274,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Embankment" + $ref: '#/components/schemas/Embankment' application/json: schema: type: array items: - "$ref": "#/components/schemas/Embankment" + $ref: '#/components/schemas/Embankment' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13157,7 +14329,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Embankment" + $ref: '#/components/schemas/Embankment' required: true responses: '204': @@ -13167,35 +14339,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/turbines/{name}": + '/projects/turbines/{name}': get: tags: - Turbines @@ -13221,40 +14393,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Turbine" + $ref: '#/components/schemas/Turbine' application/json: schema: - "$ref": "#/components/schemas/Turbine" + $ref: '#/components/schemas/Turbine' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13281,7 +14453,7 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '200': description: Turbine successfully deleted from CWMS. @@ -13290,32 +14462,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the turbine was - not found. + description: >- + Based on the combination of inputs provided the turbine was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13351,35 +14524,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/turbines": + /projects/turbines: get: tags: - Turbines @@ -13389,14 +14562,16 @@ paths: parameters: - name: office in: query - description: Office id for the reservoir project location associated with - the turbines. + description: >- + Office id for the reservoir project location associated with the + turbines. required: true schema: type: string - name: project-id in: query - description: Specifies the project-id of the Turbines whose data is to be + description: >- + Specifies the project-id of the Turbines whose data is to be included in the response. required: true schema: @@ -13409,40 +14584,40 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Turbine" + $ref: '#/components/schemas/Turbine' application/json: schema: - "$ref": "#/components/schemas/Turbine" + $ref: '#/components/schemas/Turbine' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13462,10 +14637,10 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Turbine" + $ref: '#/components/schemas/Turbine' application/json: schema: - "$ref": "#/components/schemas/Turbine" + $ref: '#/components/schemas/Turbine' required: true responses: '201': @@ -13475,35 +14650,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/locks/{name}": + '/projects/locks/{name}': get: tags: - Locks @@ -13525,9 +14700,15 @@ paths: type: string - name: unit in: query - description: "Specifies the unit system to be used in the response. Valid - values are: \n* `SI` - Metric units. \n* `EN` - Imperial units. \nDefaults - to SI." + description: >- + Specifies the unit system to be used in the response. Valid values + are: + + * `SI` - Metric units. + + * `EN` - Imperial units. + + Defaults to SI. schema: type: string responses: @@ -13538,42 +14719,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Lock" + $ref: '#/components/schemas/Lock' application/json: schema: type: array items: - "$ref": "#/components/schemas/Lock" + $ref: '#/components/schemas/Lock' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13600,7 +14781,7 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '200': description: Lock successfully deleted from CWMS. @@ -13609,32 +14790,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the lock was not - found. + description: Based on the combination of inputs provided the lock was not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13670,35 +14850,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/locks": + /projects/locks: get: tags: - Locks @@ -13708,14 +14888,16 @@ paths: parameters: - name: office in: query - description: Office id for the reservoir project location associated with - the locks. + description: >- + Office id for the reservoir project location associated with the + locks. required: true schema: type: string - name: project-id in: query - description: Specifies the project ID of the Locks whose data is to be included + description: >- + Specifies the project ID of the Locks whose data is to be included in the response. required: true schema: @@ -13728,42 +14910,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Lock" + $ref: '#/components/schemas/Lock' application/json: schema: type: array items: - "$ref": "#/components/schemas/Lock" + $ref: '#/components/schemas/Lock' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13783,7 +14965,7 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Lock" + $ref: '#/components/schemas/Lock' required: true responses: '201': @@ -13793,35 +14975,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{name}/turbine-changes": + '/projects/{office}/{name}/turbine-changes': get: tags: - Turbines @@ -13831,18 +15013,25 @@ paths: parameters: - name: office in: path - description: Office id for the reservoir project location associated with - the turbine changes. + description: >- + Office id for the reservoir project location associated with the + turbine changes. required: true schema: type: string - name: name in: path - description: Specifies the name of project of the Turbine changes whose data - is to be included in the response. + description: >- + Specifies the name of project of the Turbine changes whose data is + to be included in the response. required: true schema: type: string + - name: timezone + in: query + description: "Specifies the time zone of the values of begin, end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone." + schema: + type: string - name: begin in: query description: The start of the time window @@ -13857,33 +15046,38 @@ paths: type: string - name: start-time-inclusive in: query - description: A flag specifying whether any data at the start time should be - retrieved ('True') or only data after the start time ('False'). Default - value is True + description: >- + A flag specifying whether any data at the start time should be + retrieved ('True') or only data after the start time + ('False'). Default value is True schema: type: boolean - name: end-time-inclusive in: query - description: A flag ('True'/'False') specifying whether any data at the end - time should be retrieved ('True') or only data before the + description: >- + A flag ('True'/'False') specifying whether any data at the end time + should be retrieved ('True') or only data before the end time ('False'). Default value is False schema: type: boolean - name: unit-system in: query - description: Unit System desired in response. Can be SI (International Scientific) - or EN (Imperial.) If unspecified, defaults to EN. + description: >- + Unit System desired in response. Can be SI (International + Scientific) or EN (Imperial.) If unspecified, defaults to EN. schema: - "$ref": "#/components/schemas/UnitSystem" + $ref: '#/components/schemas/UnitSystem' - name: page-size in: query - description: the maximum number of turbine changes to retrieve, regardless - of time window. A positive integer is interpreted as the maximum number - of changes from the beginning of the time window. A negative integer is - interpreted as the maximum number from the end of the time window. Default - 500.A page cursor will not be returned by this DTO. Instead, the next page - can be determined by querying the next set of changes using the last returned - change date and using start-time-inclusive=false + description: >- + the maximum number of turbine changes to retrieve, regardless of + time window. A positive integer is interpreted as the maximum number + of changes from the beginning of the time window. A negative integer + is interpreted as the maximum number from the end of the time + window. Default 500.A page cursor will not be returned by this DTO. + Instead, the next page can be determined by querying the next set of + changes using the last returned change date and using + start-time-inclusive=false schema: type: integer format: int32 @@ -13895,37 +15089,37 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/TurbineChange" + $ref: '#/components/schemas/TurbineChange' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -13938,32 +15132,35 @@ paths: parameters: - name: office in: path - description: Office id for the reservoir project location associated with - the turbine changes. + description: >- + Office id for the reservoir project location associated with the + turbine changes. required: true schema: type: string - name: name in: path - description: Specifies the name of project of the Turbine changes whose data - is to stored. + description: >- + Specifies the name of project of the Turbine changes whose data is + to stored. required: true schema: type: string - name: override-protection in: query - description: A flag ('True'/'False') specifying whether to delete protected - data. Default is False + description: >- + A flag ('True'/'False') specifying whether to delete protected data. + Default is False schema: type: boolean requestBody: content: application/json;version=1: schema: - "$ref": "#/components/schemas/TurbineChange" + $ref: '#/components/schemas/TurbineChange' application/json: schema: - "$ref": "#/components/schemas/TurbineChange" + $ref: '#/components/schemas/TurbineChange' required: true responses: '201': @@ -13973,31 +15170,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Project Id or Turbine location Ids not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -14010,7 +15207,8 @@ paths: parameters: - name: office in: path - description: Specifies the owning office of the project for changes to be + description: >- + Specifies the owning office of the project for changes to be deleted. required: true schema: @@ -14021,6 +15219,11 @@ paths: required: true schema: type: string + - name: timezone + in: query + description: "Specifies the time zone of the values of begin, end fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if begin was specified with offset and timezone." + schema: + type: string - name: begin in: query description: The start of the time window @@ -14035,8 +15238,9 @@ paths: type: string - name: override-protection in: query - description: A flag ('True'/'False') specifying whether to delete protected - data. Default is False + description: >- + A flag ('True'/'False') specifying whether to delete protected data. + Default is False schema: type: boolean responses: @@ -14047,36 +15251,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the project was - not found. + description: >- + Based on the combination of inputs provided the project was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/outlets/{name}": + '/projects/outlets/{name}': get: tags: - Outlets @@ -14102,40 +15307,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Outlet" + $ref: '#/components/schemas/Outlet' application/json: schema: - "$ref": "#/components/schemas/Outlet" + $ref: '#/components/schemas/Outlet' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -14162,7 +15367,7 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '200': description: Outlet successfully deleted from CWMS. @@ -14171,32 +15376,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the outlet was - not found. + description: >- + Based on the combination of inputs provided the outlet was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -14232,35 +15438,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/outlets": + /projects/outlets: get: tags: - Outlets @@ -14270,14 +15476,16 @@ paths: parameters: - name: office in: query - description: Office id for the reservoir project location associated with - the outlets. + description: >- + Office id for the reservoir project location associated with the + outlets. required: true schema: type: string - name: project-id in: query - description: Specifies the project-id of the Outlets whose data is to be included + description: >- + Specifies the project-id of the Outlets whose data is to be included in the response. required: true schema: @@ -14290,42 +15498,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Outlet" + $ref: '#/components/schemas/Outlet' application/json: schema: type: array items: - "$ref": "#/components/schemas/Outlet" + $ref: '#/components/schemas/Outlet' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -14345,10 +15553,10 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Outlet" + $ref: '#/components/schemas/Outlet' application/json: schema: - "$ref": "#/components/schemas/Outlet" + $ref: '#/components/schemas/Outlet' required: true responses: '201': @@ -14358,35 +15566,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/gate-changes": + /projects/gate-changes: post: tags: - Outlets @@ -14396,8 +15604,9 @@ paths: parameters: - name: fail-if-exists in: query - description: 'Create will fail if provided Gate Changes already exist. Default: - true' + description: >- + Create will fail if provided Gate Changes already exist. Default: + true schema: type: boolean requestBody: @@ -14406,12 +15615,12 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/GateChange" + $ref: '#/components/schemas/GateChange' application/json: schema: type: array items: - "$ref": "#/components/schemas/GateChange" + $ref: '#/components/schemas/GateChange' required: true responses: '201': @@ -14421,35 +15630,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/gate-changes": + '/projects/{office}/{project-id}/gate-changes': get: tags: - Outlets @@ -14459,18 +15668,28 @@ paths: parameters: - name: office in: path - description: Office id for the reservoir project location associated with - the Gate Changes. + description: >- + Office id for the reservoir project location associated with the + Gate Changes. required: true schema: type: string - name: project-id in: path - description: Specifies the project-id of the Gate Changes whose data is to - be included in the response. + description: >- + Specifies the project-id of the Gate Changes whose data is to be + included in the response. required: true schema: type: string + - name: timezone + in: query + description: >- + This field specifies a default timezone to be used if the format of + the begin and end parameters do not include offset or time zone + information. Defaults to UTC. + schema: + type: string - name: begin in: query description: The start of the time window @@ -14485,33 +15704,38 @@ paths: type: string - name: start-time-inclusive in: query - description: A flag specifying whether any data at the start time should be - retrieved ('True') or only data after the start time ('False'). Default - value is True + description: >- + A flag specifying whether any data at the start time should be + retrieved ('True') or only data after the start time + ('False'). Default value is True schema: type: boolean - name: end-time-inclusive in: query - description: A flag ('True'/'False') specifying whether any data at the end - time should be retrieved ('True') or only data before the + description: >- + A flag ('True'/'False') specifying whether any data at the end time + should be retrieved ('True') or only data before the end time ('False'). Default value is False schema: type: boolean - name: unit-system in: query - description: Unit System desired in response. Can be SI (International Scientific) - or EN (Imperial.) If unspecified, defaults to EN. + description: >- + Unit System desired in response. Can be SI (International + Scientific) or EN (Imperial.) If unspecified, defaults to EN. schema: - "$ref": "#/components/schemas/UnitSystem" + $ref: '#/components/schemas/UnitSystem' - name: page-size in: query - description: the maximum number of gate changes to retrieve, regardless of - time window. A positive integer is interpreted as the maximum number of - changes from the beginning of the time window. A negative integer is interpreted - as the maximum number from the end of the time window. Default 500.A page - cursor will not be returned by this DTO. Instead, the next page can be determined - by querying the next set of changes using the last returned change date - and using start-time-inclusive=false + description: >- + the maximum number of gate changes to retrieve, regardless of time + window. A positive integer is interpreted as the maximum number of + changes from the beginning of the time window. A negative integer is + interpreted as the maximum number from the end of the time window. + Default 500.A page cursor will not be returned by this DTO. Instead, + the next page can be determined by querying the next set of changes + using the last returned change date and using + start-time-inclusive=false schema: type: integer format: int32 @@ -14523,42 +15747,42 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/GateChange" + $ref: '#/components/schemas/GateChange' application/json: schema: type: array items: - "$ref": "#/components/schemas/GateChange" + $ref: '#/components/schemas/GateChange' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -14571,18 +15795,28 @@ paths: parameters: - name: office in: path - description: Office id for the reservoir project location associated with - the Gate Changes. + description: >- + Office id for the reservoir project location associated with the + Gate Changes. required: true schema: type: string - name: project-id in: path - description: Specifies the project-id of the Gate Changes whose data is to - be included in the response. + description: >- + Specifies the project-id of the Gate Changes whose data is to be + included in the response. required: true schema: type: string + - name: timezone + in: query + description: >- + This field specifies a default timezone to be used if the format of + the begin and end parameters do not include offset or time zone + information. Defaults to UTC. + schema: + type: string - name: begin in: query description: The start of the time window @@ -14597,8 +15831,9 @@ paths: type: string - name: override-protection in: query - description: A flag ('True'/'False') specifying whether to delete protected - data. Default is False + description: >- + A flag ('True'/'False') specifying whether to delete protected data. + Default is False schema: type: boolean responses: @@ -14609,36 +15844,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the project was - not found. + description: >- + Based on the combination of inputs provided the project was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/virtual-outlets/{name}": + '/projects/{office}/{project-id}/virtual-outlets/{name}': get: tags: - Outlets @@ -14654,8 +15890,9 @@ paths: type: string - name: project-id in: path - description: Specifies the project-id of the virtual outlets whose data is - to be included in the response. + description: >- + Specifies the project-id of the virtual outlets whose data is to be + included in the response. required: true schema: type: string @@ -14671,40 +15908,40 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/VirtualOutlet" + $ref: '#/components/schemas/VirtualOutlet' application/json: schema: - "$ref": "#/components/schemas/VirtualOutlet" + $ref: '#/components/schemas/VirtualOutlet' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -14737,7 +15974,7 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '200': description: Virtual Outlet successfully deleted from CWMS. @@ -14746,36 +15983,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the virtual outlet - was not found. + description: >- + Based on the combination of inputs provided the virtual outlet was + not found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{office}/{project-id}/virtual-outlets": + '/projects/{office}/{project-id}/virtual-outlets': get: tags: - Outlets @@ -14785,15 +16023,17 @@ paths: parameters: - name: office in: path - description: Office id for the reservoir project location associated with - the virtual outlets. Defaults to the user session id. + description: >- + Office id for the reservoir project location associated with the + virtual outlets. Defaults to the user session id. required: true schema: type: string - name: project-id in: path - description: Specifies the project-id of the virtual outlets whose data is - to be included in the response. + description: >- + Specifies the project-id of the virtual outlets whose data is to be + included in the response. required: true schema: type: string @@ -14805,46 +16045,46 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/VirtualOutlet" + $ref: '#/components/schemas/VirtualOutlet' application/json: schema: type: array items: - "$ref": "#/components/schemas/VirtualOutlet" + $ref: '#/components/schemas/VirtualOutlet' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/virtual-outlets": + /projects/virtual-outlets: post: tags: - Outlets @@ -14861,10 +16101,10 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/VirtualOutlet" + $ref: '#/components/schemas/VirtualOutlet' application/json: schema: - "$ref": "#/components/schemas/VirtualOutlet" + $ref: '#/components/schemas/VirtualOutlet' required: true responses: '204': @@ -14874,35 +16114,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/locations": + /projects/locations: get: tags: - Projects @@ -14917,17 +16157,19 @@ paths: type: string - name: project-like in: query - description: Posix regular expression matching against + description: >- + Posix regular expression matching against the project_id. schema: type: string - name: location-kind-like in: query - description: 'Posix regular expression matching - against the location kind. The pattern will be matched against the valid - location-kinds for Project child locations:{"EMBANKMENT", "TURBINE", "OUTLET", - "LOCK", "GATE"}. Multiple kinds can be matched by using Regular Expression - OR clauses. For example: "(TURBINE|OUTLET)"' + description: >- + Posix regular expression matching against + the location kind. The pattern will be matched against the valid + location-kinds for Project child locations:{"EMBANKMENT", "TURBINE", + "OUTLET", "LOCK", "GATE"}. Multiple kinds can be matched by using + Regular Expression OR clauses. For example: "(TURBINE|OUTLET)" schema: type: string responses: @@ -14938,41 +16180,41 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/ProjectChildLocations" + $ref: '#/components/schemas/ProjectChildLocations' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects/{name}": + '/projects/{name}': get: tags: - Projects @@ -14988,7 +16230,8 @@ paths: type: string - name: office in: query - description: Specifies the owning office of the Project whose data is to be + description: >- + Specifies the owning office of the Project whose data is to be included in the response. required: true schema: @@ -14999,38 +16242,39 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Project" + $ref: '#/components/schemas/Project' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the Project was - not found. + description: >- + Based on the combination of inputs provided the Project was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -15059,38 +16303,38 @@ paths: in: query description: Specifies the delete method used. Defaults to "DELETE_KEY" schema: - "$ref": "#/components/schemas/DeleteMethod" + $ref: '#/components/schemas/DeleteMethod' responses: '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15115,16 +16359,17 @@ paths: - name: office in: query description: The office of the project to be renamed + required: true schema: type: string requestBody: content: application/json: schema: - "$ref": "#/components/schemas/Project" + $ref: '#/components/schemas/Project' application/json;version=1: schema: - "$ref": "#/components/schemas/Project" + $ref: '#/components/schemas/Project' required: true responses: '400': @@ -15132,35 +16377,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/projects": + /projects: get: tags: - Projects @@ -15170,8 +16415,10 @@ paths: parameters: - name: office in: query - description: Specifies the owning office of the data in the response. If this - field is not specified, matching items from all offices shall be returned. + description: >- + Specifies the owning office of the data in the response. If this + field is not specified, matching items from all offices shall be + returned. schema: type: string - name: id-mask @@ -15181,9 +16428,10 @@ paths: type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. schema: type: string - name: page-size @@ -15198,38 +16446,39 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Projects" + $ref: '#/components/schemas/Projects' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the projects were - not found. + description: >- + Based on the combination of inputs provided the projects were not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '501': description: request format is not implemented security: @@ -15251,10 +16500,10 @@ paths: content: application/json;version=1: schema: - "$ref": "#/components/schemas/Project" + $ref: '#/components/schemas/Project' application/json: schema: - "$ref": "#/components/schemas/Project" + $ref: '#/components/schemas/Project' required: true responses: '400': @@ -15262,35 +16511,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/properties/{name}": + '/properties/{name}': get: tags: - Properties @@ -15327,37 +16576,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Property" + $ref: '#/components/schemas/Property' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15394,32 +16643,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the property was - not found. + description: >- + Based on the combination of inputs provided the property was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15432,6 +16682,7 @@ paths: parameters: - name: name in: path + description: Specifies the name of the property to be updated. required: true schema: type: string @@ -15439,7 +16690,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Property" + $ref: '#/components/schemas/Property' required: true responses: '200': @@ -15449,35 +16700,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/properties": + /properties: get: tags: - Properties @@ -15490,7 +16741,7 @@ paths: description: Filters properties to the specified office mask schema: type: string - - name: category-id + - name: category-id-mask in: query description: Filters properties to the specified category mask schema: @@ -15508,37 +16759,37 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/Property" + $ref: '#/components/schemas/Property' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15552,7 +16803,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/Property" + $ref: '#/components/schemas/Property' required: true responses: '204': @@ -15562,35 +16813,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/lookup-types": + /lookup-types: get: tags: - LookupTypes @@ -15624,37 +16875,37 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15681,7 +16932,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' required: true responses: '204': @@ -15691,35 +16942,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/lookup-types/{name}": + '/lookup-types/{name}': delete: tags: - LookupTypes @@ -15729,6 +16980,7 @@ paths: parameters: - name: name in: path + description: Specifies the location type to delete. required: true schema: type: string @@ -15758,32 +17010,33 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': - description: Based on the combination of inputs provided the lookup type - was not found. + description: >- + Based on the combination of inputs provided the lookup type was not + found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15796,6 +17049,7 @@ paths: parameters: - name: name in: path + description: Specifies the location type to update. required: true schema: type: string @@ -15815,7 +17069,7 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' required: true responses: '200': @@ -15825,35 +17079,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-locks/{name}": + '/project-locks/{name}': get: tags: - Project Locks @@ -15885,37 +17139,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ProjectLock" + $ref: '#/components/schemas/ProjectLock' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: No matching Lock was found. content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -15923,7 +17177,7 @@ paths: tags: - Project Locks summary: Delete projectLocks with name - description: Revokes a project lock, if successful the lock is deleted + description: 'Revokes a project lock, if successful the lock is deleted' operationId: deleteProjectLocksWithName parameters: - name: name @@ -15938,10 +17192,15 @@ paths: required: true schema: type: string + - name: application-id + in: query + description: Specifies the application id. + required: true + schema: + type: string - name: revoke-timeout in: query - description: 'time in seconds to wait for existing lock to be revoked. Default: - 10' + description: 'time in seconds to wait for existing lock to be revoked. Default: 10' schema: type: integer format: int32 @@ -15951,35 +17210,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-locks": + /project-locks: get: tags: - Project Locks @@ -15989,20 +17248,23 @@ paths: parameters: - name: office-mask in: query - description: Specifies the office mask to be used to filter the locks. Supports + description: >- + Specifies the office mask to be used to filter the locks. Supports '*' but is typically a single office. required: true schema: type: string - name: project-mask in: query - description: Specifies the project mask to be used to filter the locks. Defaults + description: >- + Specifies the project mask to be used to filter the locks. Defaults to '*' schema: type: string - name: application-mask in: query - description: Specifies the application mask to be used to filter the locks. + description: >- + Specifies the application mask to be used to filter the locks. Defaults to '*' schema: type: string @@ -16012,37 +17274,37 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ProjectLock" + $ref: '#/components/schemas/ProjectLock' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -16055,24 +17317,25 @@ paths: parameters: - name: revoke-existing in: query - description: 'If an existing lock is found should a revoke be attempted? Default: - false' + description: >- + If an existing lock is found should a revoke be attempted? Default: + false schema: type: boolean - name: revoke-timeout in: query - description: 'time in seconds to wait for existing lock to be revoked. Default: - 10' + description: 'time in seconds to wait for existing lock to be revoked. Default: 10' schema: type: integer format: int32 requestBody: - description: Users must provide a Lock object specifying the officeId, projectId + description: >- + Users must provide a Lock object specifying the officeId, projectId and applicationId. Other fields will be ignored. content: application/json: schema: - "$ref": "#/components/schemas/ProjectLock" + $ref: '#/components/schemas/ProjectLock' required: true responses: '200': @@ -16080,41 +17343,41 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/ProjectLockId" + $ref: '#/components/schemas/ProjectLockId' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-locks/deny": + /project-locks/deny: post: tags: - Project Locks @@ -16134,35 +17397,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-locks/release": + /project-locks/release: post: tags: - Project Locks @@ -16188,35 +17451,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-lock-rights": + /project-lock-rights: get: tags: - Project Lock Revoker Rights @@ -16226,21 +17489,24 @@ paths: parameters: - name: office-mask in: query - description: Specifies the office mask to be used to filter the lock revoker + description: >- + Specifies the office mask to be used to filter the lock revoker rights. Supports '*' but is typically a single office. required: true schema: type: string - name: project-mask in: query - description: Specifies the project mask to be used to filter the lock revoker + description: >- + Specifies the project mask to be used to filter the lock revoker rights. Defaults to '*' schema: type: string - name: application-mask in: query - description: Specifies the application mask to be used to filter the lock - revoker rights. Defaults to '*' + description: >- + Specifies the application mask to be used to filter the lock revoker + rights. Defaults to '*' schema: type: string responses: @@ -16251,46 +17517,46 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/LockRevokerRights" + $ref: '#/components/schemas/LockRevokerRights' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-lock-rights/remove-all": + /project-lock-rights/remove-all: post: tags: - Project Lock Revoker Rights summary: Post projectLockRights removeAll - description: Revokes a project lock, if successful the lock is deleted + description: 'Revokes a project lock, if successful the lock is deleted' operationId: postProjectLockRightsRemoveAll parameters: - name: office @@ -16317,35 +17583,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/project-lock-rights/update": + /project-lock-rights/update: post: tags: - Project Lock Revoker Rights @@ -16378,7 +17644,8 @@ paths: type: string - name: allow in: query - description: True to add the user to the allow list, False to add to the deny + description: >- + True to add the user to the allow list, False to add to the deny list required: true schema: @@ -16389,35 +17656,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/users/{user-name}": + '/users/{user-name}': get: tags: - User Management @@ -16437,41 +17704,41 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/users": + /users: get: tags: - User Management @@ -16481,16 +17748,35 @@ paths: parameters: - name: office in: query - description: Show only users with active privileges in a given office.Office + description: >- + Show only users with active privileges in a given office.Office Identifier 3/4 letter as returned by the office endpoint. allowEmptyValue: true schema: type: string + - name: username-like + in: query + description: >- + Posix regular expression matching against + the username + schema: + type: string - name: page in: query - description: This end point can return a lot of data, this identifies where - in the request you are. This is an opaque value, and can be obtained from - the 'next-page' value in the response. + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. + schema: + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: type: string - name: page-size @@ -16499,47 +17785,53 @@ paths: schema: type: integer format: int32 + - name: include-roles + in: query + description: Include roles in the response. Default false. + allowEmptyValue: true + schema: + type: boolean responses: '200': description: OK content: application/json: schema: - "$ref": "#/components/schemas/Users" + $ref: '#/components/schemas/Users' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/roles": + /roles: get: tags: - User Management @@ -16560,35 +17852,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/user/profile": + /user/profile: get: tags: - User Management @@ -16601,41 +17893,41 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/user/{user-name}/roles/{office-id}": + '/user/{user-name}/roles/{office-id}': post: tags: - User Management @@ -16651,8 +17943,9 @@ paths: type: string - name: office-id in: path - description: Office for these roles.Office Identifier 3/4 letter as returned - by the office endpoint. + description: >- + Office for these roles.Office Identifier 3/4 letter as returned by + the office endpoint. required: true schema: type: string @@ -16671,31 +17964,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] @@ -16714,8 +18007,9 @@ paths: type: string - name: office-id in: path - description: Office for these roles.Office Identifier 3/4 letter as returned - by the office endpoint. + description: >- + Office for these roles.Office Identifier 3/4 letter as returned by + the office endpoint. required: true schema: type: string @@ -16734,35 +18028,35 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - "/version": + /version: get: tags: - Version @@ -16775,118 +18069,137 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaVersion" + $ref: '#/components/schemas/CdaVersion' '400': description: Bad Request content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' security: - ApiKey: [] - CwmsAAACacAuth: [] - /rss/{office}/{name}: + '/rss/{office}/{name}': get: tags: - - "RSS" - summary: "Get rss with office with name" - description: "Returns RSS feed items limited to the last week." - operationId: "getRssWithOfficeWithName" + - RSS + summary: Get rss with office with name + description: Returns RSS feed items limited to the last week. + operationId: getRssWithOfficeWithName parameters: - - name: "office" - in: "path" - description: "Office id for feed." + - name: office + in: path + description: Office id for feed. required: true schema: - type: "string" - - name: "name" - in: "path" - description: "Specifies the name of the feed. eg TS_STORED, STATUS, REALTIME_OPS" + type: string + - name: name + in: path + description: 'Specifies the name of the feed. eg TS_STORED, STATUS, REALTIME_OPS' required: true schema: - type: "string" - - name: "since" - in: "query" - description: "The start the feed time window. The endpoint will not retrieve\ - \ more than the last week of messages." + $ref: '#/components/schemas/MessageQueue' + - name: timezone + in: query + description: "Specifies the time zone of the values of since fields (unless otherwise specified). If this field is not specified, the default time zone of UTC shall be used.\r\nIgnored if since was specified with offset and timezone." + schema: + type: string + - name: since + in: query + description: >- + The start the feed time window. The endpoint will not retrieve more + than the last week of messages. + schema: + type: string + - name: page-size + in: query + description: The number of feed items to include. schema: - type: "string" - - name: "page-size" - in: "query" - description: "The number of feed items to include." + type: integer + format: int32 + - name: page + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. schema: - type: "integer" - format: "int32" - - name: "page" - in: "query" - description: "This end point can return a lot of data, this identifies where\ - \ in the request you are. This is an opaque value, and can be obtained from\ - \ the 'next-page' value in the response." + type: string + - name: cursor + in: query + description: >- + This end point can return a lot of data, this identifies where in + the request you are. This is an opaque value, and can be obtained + from the 'next-page' value in the response. Deprecated, use page + instead. + deprecated: true schema: - type: "string" + type: string responses: - "500": - description: "Server Error" + '200': + description: OK content: - application/json: + application/rss+xml: schema: - $ref: "#/components/schemas/CdaError" - "400": - description: "Bad Request" + $ref: '#/components/schemas/RssFeed' + '400': + description: Bad Request content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "401": - description: "Unauthorized" + $ref: '#/components/schemas/CdaError' + '401': + description: Unauthorized content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "403": - description: "Forbidden" + $ref: '#/components/schemas/CdaError' + '403': + description: Forbidden content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "404": - description: "Unknown Feed" + $ref: '#/components/schemas/CdaError' + '404': + description: Unknown Feed content: application/json: schema: - $ref: "#/components/schemas/CdaError" - "200": - description: "OK" + $ref: '#/components/schemas/CdaError' + '500': + description: Server Error content: - application/rss+xml: + application/json: schema: - $ref: "#/components/schemas/RssFeed" - security: [] - "/*": + $ref: '#/components/schemas/CdaError' + security: + - ApiKey: [] + - CwmsAAACacAuth: [] + /*: options: summary: Options with wildcard operationId: optionsWithWildcard @@ -16896,31 +18209,31 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '401': description: Unauthorized content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '403': description: Forbidden content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '404': description: Not Found content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' '500': description: Server Error content: application/json: schema: - "$ref": "#/components/schemas/CdaError" + $ref: '#/components/schemas/CdaError' components: schemas: CdaError: @@ -16930,8 +18243,9 @@ components: type: string incidentIdentifier: type: string - description: A randomly generated UUID to help identify your request in - the logs for analysis.. + description: >- + A randomly generated UUID to help identify your request in the logs + for analysis.. source: type: string details: @@ -16952,13 +18266,15 @@ components: type: string created: type: string - description: The instant this Key was created, in ISO-8601 format with offset - and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') + description: >- + The instant this Key was created, in ISO-8601 format with offset and + timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') format: date-time readOnly: true expires: type: string - description: When this key expires, in ISO-8601 format with offset and timezone + description: >- + When this key expires, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') format: date-time location_category: @@ -17011,7 +18327,7 @@ components: id: type: string location-category: - "$ref": "#/components/schemas/location_category" + $ref: '#/components/schemas/location_category' description: type: string shared-loc-alias-id: @@ -17023,7 +18339,7 @@ components: assigned-locations: type: array items: - "$ref": "#/components/schemas/AssignedLocation" + $ref: '#/components/schemas/AssignedLocation' description: A representation of a location group LocationGroup: required: @@ -17036,7 +18352,7 @@ components: id: type: string location-category: - "$ref": "#/components/schemas/location_category" + $ref: '#/components/schemas/location_category' description: type: string shared-loc-alias-id: @@ -17048,28 +18364,28 @@ components: assigned-locations: type: array items: - "$ref": "#/components/schemas/AssignedLocation" + $ref: '#/components/schemas/AssignedLocation' description: A representation of a location group LocationGroup_CSV: type: object - description: Single LocationGroup or List of LocationGroups in comma separated - format - example: "#LocationGroup Id, OfficeId, Description, CategoryId, CategoryOfficeId, - SharedLocAliasId, SharedRefLocationId, LocGroupAttribute\r\nCERL,Construction - Engineering Research Laboratory,Field Operating Activity\tERD\r\nCHL,Coastal - and Hydraulics Laboratory,Field Operating Activity\tERD\r\nNAB,Baltimore District,District,NAD\r\nNAD,North - Atlantic Division,Division Headquarters,HQ" + description: Single LocationGroup or List of LocationGroups in comma separated format + example: "#LocationGroup Id, OfficeId, Description, CategoryId, CategoryOfficeId, SharedLocAliasId, SharedRefLocationId, LocGroupAttribute\r\nCERL,Construction Engineering Research Laboratory,Field Operating Activity\tERD\r\nCHL,Coastal and Hydraulics Laboratory,Field Operating Activity\tERD\r\nNAB,Baltimore District,District,NAD\r\nNAD,North Atlantic Division,Division Headquarters,HQ" CsvV1LocationGroup: type: object - description: Single LocationGroup or List of LocationGroups in comma separated - format - example: "#LocationGroup Id, OfficeId, Description, CategoryId, CategoryOfficeId, - SharedLocAliasId, SharedRefLocationId, LocGroupAttribute\r\nCERL,Construction - Engineering Research Laboratory,Field Operating Activity\tERD\r\nCHL,Coastal - and Hydraulics Laboratory,Field Operating Activity\tERD\r\nNAB,Baltimore District,District,NAD\r\nNAD,North - Atlantic Division,Division Headquarters,HQ" + description: Single LocationGroup or List of LocationGroups in comma separated format + example: "#LocationGroup Id, OfficeId, Description, CategoryId, CategoryOfficeId, SharedLocAliasId, SharedRefLocationId, LocGroupAttribute\r\nCERL,Construction Engineering Research Laboratory,Field Operating Activity\tERD\r\nCHL,Coastal and Hydraulics Laboratory,Field Operating Activity\tERD\r\nNAB,Baltimore District,District,NAD\r\nNAD,North Atlantic Division,Division Headquarters,HQ" Unit: type: object + CwmsId: + required: + - office-id + type: object + properties: + office-id: + type: string + description: Owning office of object. + name: + type: string CwmsIdLocationKind: type: object properties: @@ -17142,7 +18458,7 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' alias: type: object properties: @@ -17150,23 +18466,63 @@ components: type: string value: type: string - CwmsId: - required: - - office-id + Offset: type: object properties: - office-id: + estimate: + type: boolean + to-datum: type: string - description: Owning office of object. - name: + value: + type: number + format: double + vertical-datum-info: + type: object + properties: + office: + type: string + unit: + type: string + location: + type: string + native-datum: + type: string + elevation: + type: number + format: double + local-datum-name: + type: string + offsets: + type: array + items: + $ref: '#/components/schemas/Offset' + VerticalDatumInfo: + type: object + properties: + office: + type: string + unit: + type: string + location: + type: string + native-datum: + type: string + elevation: + type: number + format: double + local-datum-name: type: string + offsets: + type: array + items: + $ref: '#/components/schemas/Offset' Entity: required: - id type: object properties: id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' parent-entity-id: type: string category-id: @@ -17227,14 +18583,14 @@ components: type: object properties: offices: - "$ref": "#/components/schemas/OfficesFMT" + $ref: '#/components/schemas/OfficesFMT' OfficesFMT: type: object properties: offices: type: array items: - "$ref": "#/components/schemas/office" + $ref: '#/components/schemas/office' office: type: object properties: @@ -17253,7 +18609,8 @@ components: - filed operating activity reports-to: type: string - description: Reference to another office, like a division, that this office + description: >- + Reference to another office, like a division, that this office reports to. description: A representation of a CWMS office Office: @@ -17274,7 +18631,8 @@ components: - filed operating activity reports-to: type: string - description: Reference to another office, like a division, that this office + description: >- + Reference to another office, like a division, that this office reports to. description: A representation of a CWMS office parameter: @@ -17334,14 +18692,14 @@ components: time-zones: type: array items: - "$ref": "#/components/schemas/time-zone" + $ref: '#/components/schemas/time-zone' TimeZoneIds: type: object properties: time-zones: type: array items: - "$ref": "#/components/schemas/time-zone" + $ref: '#/components/schemas/time-zone' ConstantLocationLevel: required: - location-level-id @@ -17356,15 +18714,17 @@ components: description: Name of the location level specified-level-id: type: string - description: Timeseries ID (e.g. from the times series catalog) to use as - the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue + description: >- + Timeseries ID (e.g. from the times series catalog) to use as the + location level. Mutually exclusive with seasonalValues and + siParameterUnitsConstantValue expiration-date: type: string description: The expiration date of the location level. format: date-time parameter-id: type: string - description: Data Type such as Stage, Elevation, or others. + description: 'Data Type such as Stage, Elevation, or others.' parameter-type-id: type: string description: To indicate if single or aggregate value @@ -17385,15 +18745,17 @@ components: description: Units the provided levels are in level-date: type: string - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. format: date-time level-comment: type: string duration-id: type: string - description: 0 if parameterTypeId is Inst. Otherwise duration indicating - the time window of the aggregate value. + description: >- + 0 if parameterTypeId is Inst. Otherwise duration indicating the time + window of the aggregate value. attribute-value: type: number attribute-units-id: @@ -17409,7 +18771,7 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' constant-value: type: number description: Single value for this location level. @@ -17428,15 +18790,17 @@ components: description: Name of the location level specified-level-id: type: string - description: Timeseries ID (e.g. from the times series catalog) to use as - the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue + description: >- + Timeseries ID (e.g. from the times series catalog) to use as the + location level. Mutually exclusive with seasonalValues and + siParameterUnitsConstantValue expiration-date: type: string description: The expiration date of the location level. format: date-time parameter-id: type: string - description: Data Type such as Stage, Elevation, or others. + description: 'Data Type such as Stage, Elevation, or others.' parameter-type-id: type: string description: To indicate if single or aggregate value @@ -17457,15 +18821,17 @@ components: description: Units the provided levels are in level-date: type: string - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. format: date-time level-comment: type: string duration-id: type: string - description: 0 if parameterTypeId is Inst. Otherwise duration indicating - the time window of the aggregate value. + description: >- + 0 if parameterTypeId is Inst. Otherwise duration indicating the time + window of the aggregate value. attribute-value: type: number attribute-units-id: @@ -17481,17 +18847,17 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' readOnly: true oneOf: - - "$ref": "#/components/schemas/ConstantLocationLevel" - - "$ref": "#/components/schemas/TimeSeriesLocationLevel" - - "$ref": "#/components/schemas/SeasonalLocationLevel" - - "$ref": "#/components/schemas/VirtualLocationLevel" + - $ref: '#/components/schemas/ConstantLocationLevel' + - $ref: '#/components/schemas/TimeSeriesLocationLevel' + - $ref: '#/components/schemas/SeasonalLocationLevel' + - $ref: '#/components/schemas/VirtualLocationLevel' LocationLevelConstituent: type: object allOf: - - "$ref": "#/components/schemas/RATING" + - $ref: '#/components/schemas/RATING' - type: object properties: attribute-id: @@ -17530,15 +18896,17 @@ components: description: Name of the location level specified-level-id: type: string - description: Timeseries ID (e.g. from the times series catalog) to use as - the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue + description: >- + Timeseries ID (e.g. from the times series catalog) to use as the + location level. Mutually exclusive with seasonalValues and + siParameterUnitsConstantValue expiration-date: type: string description: The expiration date of the location level. format: date-time parameter-id: type: string - description: Data Type such as Stage, Elevation, or others. + description: 'Data Type such as Stage, Elevation, or others.' parameter-type-id: type: string description: To indicate if single or aggregate value @@ -17559,15 +18927,17 @@ components: description: Units the provided levels are in level-date: type: string - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. format: date-time level-comment: type: string duration-id: type: string - description: 0 if parameterTypeId is Inst. Otherwise duration indicating - the time window of the aggregate value. + description: >- + 0 if parameterTypeId is Inst. Otherwise duration indicating the time + window of the aggregate value. attribute-value: type: number attribute-units-id: @@ -17583,7 +18953,7 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' interval-origin: type: string description: The start point of provided seasonal values @@ -17596,12 +18966,13 @@ components: format: int32 seasonal-values: type: array - description: List of Repeating seasonal values. The values repeat after - the specified interval. A yearly interval seasonable could have 12 different - values, one for each month for example. Mutually exclusive with seasonalTimeSeriesId - and siParameterUnitsConstantValue + description: >- + List of Repeating seasonal values. The values repeat after the + specified interval. A yearly interval seasonable could have 12 + different values, one for each month for example. Mutually exclusive + with seasonalTimeSeriesId and siParameterUnitsConstantValue items: - "$ref": "#/components/schemas/SeasonalValueBean" + $ref: '#/components/schemas/SeasonalValueBean' SeasonalValueBean: type: object properties: @@ -17613,10 +18984,11 @@ components: format: int32 offset-minutes: type: integer - description: List of Repeating seasonal values. The values repeat after the - specified interval. A yearly interval seasonable could have 12 different values, - one for each month for example. Mutually exclusive with seasonalTimeSeriesId - and siParameterUnitsConstantValue + description: >- + List of Repeating seasonal values. The values repeat after the specified + interval. A yearly interval seasonable could have 12 different values, + one for each month for example. Mutually exclusive with + seasonalTimeSeriesId and siParameterUnitsConstantValue TimeSeriesLocationLevel: required: - location-level-id @@ -17632,15 +19004,17 @@ components: description: Name of the location level specified-level-id: type: string - description: Timeseries ID (e.g. from the times series catalog) to use as - the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue + description: >- + Timeseries ID (e.g. from the times series catalog) to use as the + location level. Mutually exclusive with seasonalValues and + siParameterUnitsConstantValue expiration-date: type: string description: The expiration date of the location level. format: date-time parameter-id: type: string - description: Data Type such as Stage, Elevation, or others. + description: 'Data Type such as Stage, Elevation, or others.' parameter-type-id: type: string description: To indicate if single or aggregate value @@ -17661,15 +19035,17 @@ components: description: Units the provided levels are in level-date: type: string - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. format: date-time level-comment: type: string duration-id: type: string - description: 0 if parameterTypeId is Inst. Otherwise duration indicating - the time window of the aggregate value. + description: >- + 0 if parameterTypeId is Inst. Otherwise duration indicating the time + window of the aggregate value. attribute-value: type: number attribute-units-id: @@ -17685,11 +19061,13 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' seasonal-time-series-id: type: string - description: Timeseries ID (e.g. from the times series catalog) to use as - the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue + description: >- + Timeseries ID (e.g. from the times series catalog) to use as the + location level. Mutually exclusive with seasonalValues and + siParameterUnitsConstantValue VirtualLocationLevel: required: - location-level-id @@ -17704,15 +19082,17 @@ components: description: Name of the location level specified-level-id: type: string - description: Timeseries ID (e.g. from the times series catalog) to use as - the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue + description: >- + Timeseries ID (e.g. from the times series catalog) to use as the + location level. Mutually exclusive with seasonalValues and + siParameterUnitsConstantValue expiration-date: type: string description: The expiration date of the location level. format: date-time parameter-id: type: string - description: Data Type such as Stage, Elevation, or others. + description: 'Data Type such as Stage, Elevation, or others.' parameter-type-id: type: string description: To indicate if single or aggregate value @@ -17733,15 +19113,17 @@ components: description: Units the provided levels are in level-date: type: string - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. format: date-time level-comment: type: string duration-id: type: string - description: 0 if parameterTypeId is Inst. Otherwise duration indicating - the time window of the aggregate value. + description: >- + 0 if parameterTypeId is Inst. Otherwise duration indicating the time + window of the aggregate value. attribute-value: type: number attribute-units-id: @@ -17757,11 +19139,11 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' constituents: type: array items: - "$ref": "#/components/schemas/RATING" + $ref: '#/components/schemas/RATING' constituent-connections: type: string location-levels: @@ -17771,11 +19153,10 @@ components: type: array description: List of retrieved location levels items: - "$ref": "#/components/schemas/LocationLevel" + $ref: '#/components/schemas/LocationLevel' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -17783,14 +19164,16 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true LocationLevels: @@ -17800,11 +19183,10 @@ components: type: array description: List of retrieved location levels items: - "$ref": "#/components/schemas/LocationLevel" + $ref: '#/components/schemas/LocationLevel' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -17812,26 +19194,18 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true - Offset: - type: object - properties: - estimate: - type: boolean - to-datum: - type: string - value: - type: number - format: double TimeSeries.Column: type: object properties: @@ -17848,7 +19222,7 @@ components: properties: date-time: type: integer - description: Milliseconds since 1970-01-01 (Unix Epoch), always UTC + description: 'Milliseconds since 1970-01-01 (Unix Epoch), always UTC' format: int64 value: type: number @@ -17865,23 +19239,30 @@ components: properties: begin: type: string - description: The requested start time of the data, in ISO-8601 format with - offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') + description: >- + The start time represented by the values in this response, in + ISO-8601 format with offset and timezone + ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']''). When trim=true and values are + returned, this reflects the first returned value. format: date-time readOnly: true date-version-type: type: string - description: Version type specifies the type of timeseries response to be - received. Can be max aggregate or single version. Max aggregate cannot - be run if version date field is specified. + description: >- + Version type specifies the type of timeseries response to be + received. Can be max aggregate or single version. Max aggregate + cannot be run if version date field is specified. enum: - MAX_AGGREGATE - SINGLE_VERSION - UNVERSIONED end: type: string - description: The requested end time of the data, in ISO-8601 format with - offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') + description: >- + The end time represented by the values in this response, in ISO-8601 + format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']''). + When trim=true and values are returned, this reflects the last + returned value. format: date-time readOnly: true interval: @@ -17921,7 +19302,7 @@ components: type: boolean negative: type: boolean - description: The interval of the time-series, in ISO-8601 duration format + description: 'The interval of the time-series, in ISO-8601 duration format' format: Java Duration readOnly: true interval-offset: @@ -17934,8 +19315,7 @@ components: description: Time-series name next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true office-id: type: string @@ -17946,19 +19326,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true time-zone: type: string - description: Only on 21.1.1 Database. The timezone the Interval Offset is - from. + description: Only on 21.1.1 Database. The timezone the Interval Offset is from. readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true units: @@ -17966,27 +19347,30 @@ components: description: The units of the time series data value-columns: type: array - description: The columns of the time-series data array returned, this property - is used to describe the data structure of the records array. Contains - [name, ordinal, datatype]. Name corresponds to the variable described - by the data, ordinal is the order of the column in the data value array - returned (starts at index 1), and datatype is the class name of the data - type for the variable. Since the records array can be of variable length, - the column index value is used to identify the position of the data in - the array. + description: >- + The columns of the time-series data array returned, this property is + used to describe the data structure of the records array. Contains + [name, ordinal, datatype]. Name corresponds to the variable + described by the data, ordinal is the order of the column in the + data value array returned (starts at index 1), and datatype is the + class name of the data type for the variable. Since the records + array can be of variable length, the column index value is used to + identify the position of the data in the array. readOnly: true items: - "$ref": "#/components/schemas/TimeSeries.Column" + $ref: '#/components/schemas/TimeSeries.Column' values: type: array items: type: array - description: Time is Milliseconds since the UNIX Epoch. Value is Double - (for missing data you can use null, or -Float.MAX_VALUE (-340282346638528859811704183484516925440), - quality is an integer.) If you are using missing data set the quality - to 5.Failure to do this may result in silently ignoring that value on - not storing a placeholder which can be important in irregular and psuedo - regular timeseries. + description: >- + Time is Milliseconds since the UNIX Epoch. Value is Double (for + missing data you can use null, or -Float.MAX_VALUE + (-340282346638528859811704183484516925440), quality is an + integer.) If you are using missing data set the quality to + 5.Failure to do this may result in silently ignoring that value on + not storing a placeholder which can be important in irregular and + psuedo regular timeseries. example: - 1509654000000 - 54.3 @@ -17996,8 +19380,7 @@ components: properties: date-time: type: integer - description: Milliseconds since 1970-01-01 (Unix Epoch), always - UTC + description: 'Milliseconds since 1970-01-01 (Unix Epoch), always UTC' format: int64 value: type: number @@ -18006,35 +19389,16 @@ components: quality-code: type: integer format: int32 - description: List of retrieved time-series values. The values-columns - property describes the structure of the data value array. Refer to - the value-columns property for more information. + description: >- + List of retrieved time-series values. The values-columns + property describes the structure of the data value array. Refer + to the value-columns property for more information. version-date: type: string description: The version date of the time series trace format: date-time vertical-datum-info: - "$ref": "#/components/schemas/vertical-datum-info" - vertical-datum-info: - type: object - properties: - office: - type: string - unit: - type: string - location: - type: string - native-datum: - type: string - elevation: - type: number - format: double - local-datum-name: - type: string - offsets: - type: array - items: - "$ref": "#/components/schemas/Offset" + $ref: '#/components/schemas/vertical-datum-info' TimeSeries: required: - units @@ -18042,23 +19406,30 @@ components: properties: begin: type: string - description: The requested start time of the data, in ISO-8601 format with - offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') + description: >- + The start time represented by the values in this response, in + ISO-8601 format with offset and timezone + ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']''). When trim=true and values are + returned, this reflects the first returned value. format: date-time readOnly: true date-version-type: type: string - description: Version type specifies the type of timeseries response to be - received. Can be max aggregate or single version. Max aggregate cannot - be run if version date field is specified. + description: >- + Version type specifies the type of timeseries response to be + received. Can be max aggregate or single version. Max aggregate + cannot be run if version date field is specified. enum: - MAX_AGGREGATE - SINGLE_VERSION - UNVERSIONED end: type: string - description: The requested end time of the data, in ISO-8601 format with - offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'') + description: >- + The end time represented by the values in this response, in ISO-8601 + format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']''). + When trim=true and values are returned, this reflects the last + returned value. format: date-time readOnly: true interval: @@ -18098,7 +19469,7 @@ components: type: boolean negative: type: boolean - description: The interval of the time-series, in ISO-8601 duration format + description: 'The interval of the time-series, in ISO-8601 duration format' format: Java Duration readOnly: true interval-offset: @@ -18111,8 +19482,7 @@ components: description: Time-series name next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true office-id: type: string @@ -18123,19 +19493,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true time-zone: type: string - description: Only on 21.1.1 Database. The timezone the Interval Offset is - from. + description: Only on 21.1.1 Database. The timezone the Interval Offset is from. readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true units: @@ -18143,27 +19514,30 @@ components: description: The units of the time series data value-columns: type: array - description: The columns of the time-series data array returned, this property - is used to describe the data structure of the records array. Contains - [name, ordinal, datatype]. Name corresponds to the variable described - by the data, ordinal is the order of the column in the data value array - returned (starts at index 1), and datatype is the class name of the data - type for the variable. Since the records array can be of variable length, - the column index value is used to identify the position of the data in - the array. + description: >- + The columns of the time-series data array returned, this property is + used to describe the data structure of the records array. Contains + [name, ordinal, datatype]. Name corresponds to the variable + described by the data, ordinal is the order of the column in the + data value array returned (starts at index 1), and datatype is the + class name of the data type for the variable. Since the records + array can be of variable length, the column index value is used to + identify the position of the data in the array. readOnly: true items: - "$ref": "#/components/schemas/TimeSeries.Column" + $ref: '#/components/schemas/TimeSeries.Column' values: type: array items: type: array - description: Time is Milliseconds since the UNIX Epoch. Value is Double - (for missing data you can use null, or -Float.MAX_VALUE (-340282346638528859811704183484516925440), - quality is an integer.) If you are using missing data set the quality - to 5.Failure to do this may result in silently ignoring that value on - not storing a placeholder which can be important in irregular and psuedo - regular timeseries. + description: >- + Time is Milliseconds since the UNIX Epoch. Value is Double (for + missing data you can use null, or -Float.MAX_VALUE + (-340282346638528859811704183484516925440), quality is an + integer.) If you are using missing data set the quality to + 5.Failure to do this may result in silently ignoring that value on + not storing a placeholder which can be important in irregular and + psuedo regular timeseries. example: - 1509654000000 - 54.3 @@ -18173,8 +19547,7 @@ components: properties: date-time: type: integer - description: Milliseconds since 1970-01-01 (Unix Epoch), always - UTC + description: 'Milliseconds since 1970-01-01 (Unix Epoch), always UTC' format: int64 value: type: number @@ -18183,22 +19556,23 @@ components: quality-code: type: integer format: int32 - description: List of retrieved time-series values. The values-columns - property describes the structure of the data value array. Refer to - the value-columns property for more information. + description: >- + List of retrieved time-series values. The values-columns + property describes the structure of the data value array. Refer + to the value-columns property for more information. version-date: type: string description: The version date of the time series trace format: date-time vertical-datum-info: - "$ref": "#/components/schemas/vertical-datum-info" + $ref: '#/components/schemas/vertical-datum-info' LocationLevelRef: required: - location-level-id type: object properties: location-level-id: - $ref: "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' aliases: uniqueItems: true type: array @@ -18207,11 +19581,13 @@ components: effective-dates: uniqueItems: true type: array - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. items: type: string - description: The date/time at which this location level configuration takes + description: >- + The date/time at which this location level configuration takes effect. format: date-time description: List of retrieved location levels ids and effective dates @@ -18222,7 +19598,7 @@ components: type: array description: List of retrieved location levels ids and effective dates items: - $ref: "#/components/schemas/LocationLevelRef" + $ref: '#/components/schemas/LocationLevelRef' next-page: type: string description: The cursor to the next page of data; null if there is no more data @@ -18233,53 +19609,64 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger than the + description: >- + The number of records fetched per-page; this may be larger than the number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present if not + description: >- + The total number of records retrieved; null or not present if not supported or unknown format: int32 readOnly: true UnitSystem: type: string - description: Unit System desired in response. Can be SI (International Scientific) - or EN (Imperial.) If unspecified, defaults to SI. + description: >- + Unit System desired in response. Can be SI (International Scientific) or + EN (Imperial.) If unspecified, defaults to SI. enum: - SI - EN - Tsv: + RecentValue: type: object properties: id: - "$ref": "#/components/schemas/TsvId" - value: - type: number - format: double - qualityCode: - type: integer - format: int64 - startDate: + type: string + dqu: + $ref: '#/components/schemas/TsvDqu' + TsvDqu: + required: + - office-id + type: object + properties: + office-id: + type: string + description: Owning office of object. + cwms-ts-id: + type: string + unit-id: + type: string + date-time: type: string format: date-time - endDate: + version-date: type: string format: date-time - TsvId: - type: object - properties: - tsCode: - type: integer - format: int64 - dateTime: + data-entry-date: type: string format: date-time - versionDate: + value: + type: number + format: double + quality-code: + type: integer + format: int64 + start-date: type: string format: date-time - dataEntryDate: + end-date: type: string format: date-time StandardTextId: @@ -18296,7 +19683,7 @@ components: type: object properties: id: - "$ref": "#/components/schemas/StandardTextId" + $ref: '#/components/schemas/StandardTextId' standard-text: type: string StandardTextCatalog: @@ -18305,7 +19692,7 @@ components: values: type: array items: - "$ref": "#/components/schemas/StandardTextValue" + $ref: '#/components/schemas/StandardTextValue' DeleteMethod: type: string enum: @@ -18352,9 +19739,10 @@ components: type: string date-version-type: type: string - description: Version type specifies the type of timeseries response to be - received. Can be max aggregate or single version. Max aggregate cannot - be run if version date field is specified. + description: >- + Version type specifies the type of timeseries response to be + received. Can be max aggregate or single version. Max aggregate + cannot be run if version date field is specified. enum: - MAX_AGGREGATE - SINGLE_VERSION @@ -18366,7 +19754,7 @@ components: regular-text-values: type: array items: - "$ref": "#/components/schemas/RegularTextTimeSeriesRow" + $ref: '#/components/schemas/RegularTextTimeSeriesRow' BinaryTimeSeries: required: - office-id @@ -18384,9 +19772,10 @@ components: type: string date-version-type: type: string - description: Version type specifies the type of timeseries response to be - received. Can be max aggregate or single version. Max aggregate cannot - be run if version date field is specified. + description: >- + Version type specifies the type of timeseries response to be + received. Can be max aggregate or single version. Max aggregate + cannot be run if version date field is specified. enum: - MAX_AGGREGATE - SINGLE_VERSION @@ -18398,7 +19787,7 @@ components: binary-values: type: array items: - "$ref": "#/components/schemas/BinaryTimeSeriesRow" + $ref: '#/components/schemas/BinaryTimeSeriesRow' BinaryTimeSeriesRow: type: object properties: @@ -18427,7 +19816,7 @@ components: type: object properties: location-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' description: type: string description: Description @@ -18441,14 +19830,13 @@ components: type: string description: Independent Parameter reference-ts-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' TimeSeriesProfileList: type: object properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -18456,18 +19844,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true profile-list: type: array items: - "$ref": "#/components/schemas/TimeSeriesProfile" + $ref: '#/components/schemas/TimeSeriesProfile' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true ParameterInfo: @@ -18488,7 +19878,7 @@ components: ParameterInfoColumnar: type: object allOf: - - "$ref": "#/components/schemas/ParameterInfo" + - $ref: '#/components/schemas/ParameterInfo' - type: object properties: start-column: @@ -18500,7 +19890,7 @@ components: ParameterInfoIndexed: type: object allOf: - - "$ref": "#/components/schemas/ParameterInfo" + - $ref: '#/components/schemas/ParameterInfo' - type: object properties: index: @@ -18510,7 +19900,7 @@ components: type: object properties: location-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' key-parameter: type: string record-delimiter: @@ -18522,7 +19912,7 @@ components: parameter-info-list: type: array items: - "$ref": "#/components/schemas/ParameterInfo" + $ref: '#/components/schemas/ParameterInfo' time-in-two-fields: type: boolean type: @@ -18532,7 +19922,7 @@ components: TimeSeriesProfileParserColumnar: type: object allOf: - - "$ref": "#/components/schemas/TimeSeriesProfileParser" + - $ref: '#/components/schemas/TimeSeriesProfileParser' - type: object properties: time-start-column: @@ -18547,7 +19937,7 @@ components: - time-field type: object allOf: - - "$ref": "#/components/schemas/TimeSeriesProfileParser" + - $ref: '#/components/schemas/TimeSeriesProfileParser' - type: object properties: field-delimiter: @@ -18590,7 +19980,7 @@ components: data-columns: type: array items: - "$ref": "#/components/schemas/DataColumnInfo" + $ref: '#/components/schemas/DataColumnInfo' first-date: type: string format: date-time @@ -18601,8 +19991,7 @@ components: type: string next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -18616,26 +20005,28 @@ components: format: date-time page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true parameter-columns: type: array items: - "$ref": "#/components/schemas/ParameterColumnInfo" + $ref: '#/components/schemas/ParameterColumnInfo' time-series-list: type: object additionalProperties: type: array items: - "$ref": "#/components/schemas/TimeSeriesData" + $ref: '#/components/schemas/TimeSeriesData' time-series-profile: - "$ref": "#/components/schemas/TimeSeriesProfile" + $ref: '#/components/schemas/TimeSeriesProfile' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true version: @@ -18704,11 +20095,10 @@ components: descriptors: type: array items: - "$ref": "#/components/schemas/TimeSeriesIdentifierDescriptor" + $ref: '#/components/schemas/TimeSeriesIdentifierDescriptor' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -18716,26 +20106,28 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true AssignedTimeSeries: type: object properties: - officeId: + office-id: type: string - timeseriesId: + timeseries-id: type: string - aliasId: + alias-id: type: string - refTsId: + ref-ts-id: type: string attribute: type: integer @@ -18751,7 +20143,7 @@ components: id: type: string time-series-category: - "$ref": "#/components/schemas/timeseries-category" + $ref: '#/components/schemas/timeseries-category' description: type: string shared-alias-id: @@ -18761,7 +20153,7 @@ components: assigned-time-series: type: array items: - "$ref": "#/components/schemas/AssignedTimeSeries" + $ref: '#/components/schemas/AssignedTimeSeries' description: A representation of a timeseries group TimeSeriesGroup: required: @@ -18774,7 +20166,7 @@ components: id: type: string time-series-category: - "$ref": "#/components/schemas/timeseries-category" + $ref: '#/components/schemas/timeseries-category' description: type: string shared-alias-id: @@ -18784,7 +20176,7 @@ components: assigned-time-series: type: array items: - "$ref": "#/components/schemas/AssignedTimeSeries" + $ref: '#/components/schemas/AssignedTimeSeries' description: A representation of a timeseries group VerticalDatum: type: string @@ -18805,25 +20197,30 @@ components: description: The units of the output values rating-time: type: integer - description: A specific date/time to use as the "current time" of the rating. No - ratings with a create date later than this will be used. Useful for performing - historical ratings. If not specified or NULL, the current time is use. + description: >- + A specific date/time to use as the "current time" of the rating. No + ratings with a create date later than this will be used. Useful for + performing historical ratings. If not specified or NULL, the current + time is use. format: int64 round: type: boolean - description: A flag specifying whether to round the rated values according - to the rounding spec contained in the rating specification. Defaults to + description: >- + A flag specifying whether to round the rated values according to the + rounding spec contained in the rating specification. Defaults to false. values: type: array items: type: array - description: The input values. Each value array must be the same length. - Must be length 1 for reverse rate. + description: >- + The input values. Each value array must be the same length. Must + be length 1 for reverse rate. items: type: number - description: The input values. Each value array must be the same length. - Must be length 1 for reverse rate. + description: >- + The input values. Each value array must be the same length. Must + be length 1 for reverse rate. format: double value-times: type: array @@ -18834,8 +20231,10 @@ components: type: array items: type: string - description: The unit of input values and the desired unit of the output. - Length of the array must be equal to the number of input value arrays. + description: >- + The unit of input values and the desired unit of the output. + Length of the array must be equal to the number of input value + arrays. RatedOutputValues: required: - rating-id @@ -18844,7 +20243,7 @@ components: type: object properties: rating-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' unit: type: string description: The unit of the rated output data @@ -18867,57 +20266,69 @@ components: description: The units of the output values rating-time: type: integer - description: A specific date/time to use as the "current time" of the rating. No - ratings with a create date later than this will be used. Useful for performing - historical ratings. If not specified or NULL, the current time is use. + description: >- + A specific date/time to use as the "current time" of the rating. No + ratings with a create date later than this will be used. Useful for + performing historical ratings. If not specified or NULL, the current + time is use. format: int64 round: type: boolean - description: A flag specifying whether to round the rated values according - to the rounding spec contained in the rating specification. Defaults to + description: >- + A flag specifying whether to round the rated values according to the + rounding spec contained in the rating specification. Defaults to false. time-series-ids: type: array items: type: string - description: A collection of time series identifiers of the time series - to rate, in position order of the parameters of the rating.Must be size - 1 for reverse rate. + description: >- + A collection of time series identifiers of the time series to + rate, in position order of the parameters of the rating.Must be + size 1 for reverse rate. start-time: type: integer - description: The start of the time window to rate.Represents milliseconds - since 1970-01-01 (Unix Epoch), always UTC. + description: >- + The start of the time window to rate.Represents milliseconds since + 1970-01-01 (Unix Epoch), always UTC. format: int64 end-time: type: integer - description: The end of the time window to rate.Represents milliseconds - since 1970-01-01 (Unix Epoch), always UTC. + description: >- + The end of the time window to rate.Represents milliseconds since + 1970-01-01 (Unix Epoch), always UTC. format: int64 version-date: type: integer - description: Specifies the version date of the retrieve time series. Represents + description: >- + Specifies the version date of the retrieve time series. Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC. format: int64 trim: type: boolean - description: Specifies whether to trim missing values from the ends of the + description: >- + Specifies whether to trim missing values from the ends of the retrieved time series. Defaults to false. start-inclusive: type: boolean - description: Specifies whether the time window starts on or after the specified + description: >- + Specifies whether the time window starts on or after the specified time. Defaults to true. end-inclusive: type: boolean - description: Specifies whether the time window ends on or before the specified + description: >- + Specifies whether the time window ends on or before the specified time. Defaults to true; previous: type: boolean - description: Specifies whether to retrieve the latest value before the start - of the time window. Defaults to false. + description: >- + Specifies whether to retrieve the latest value before the start of + the time window. Defaults to false. next: type: boolean - description: Specifies whether to retrieve the earliest value after the - end of the time window. Defaults to false. + description: >- + Specifies whether to retrieve the earliest value after the end of + the time window. Defaults to false. RatedOutputTimeSeries: required: - rating-id @@ -18925,7 +20336,7 @@ components: type: object properties: rating-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' unit: type: string description: The unit of the rated output data @@ -18933,12 +20344,14 @@ components: type: array items: type: array - description: Time is Milliseconds since the UNIX Epoch. Value is Double - (for missing data you can use null, or -Float.MAX_VALUE (-340282346638528859811704183484516925440), - quality is an integer.) If you are using missing data set the quality - to 5.Failure to do this may result in silently ignoring that value on - not storing a placeholder which can be important in irregular and psuedo - regular timeseries. + description: >- + Time is Milliseconds since the UNIX Epoch. Value is Double (for + missing data you can use null, or -Float.MAX_VALUE + (-340282346638528859811704183484516925440), quality is an + integer.) If you are using missing data set the quality to + 5.Failure to do this may result in silently ignoring that value on + not storing a placeholder which can be important in irregular and + psuedo regular timeseries. example: - 1509654000000 - 54.3 @@ -18948,8 +20361,7 @@ components: properties: date-time: type: integer - description: Milliseconds since 1970-01-01 (Unix Epoch), always - UTC + description: 'Milliseconds since 1970-01-01 (Unix Epoch), always UTC' format: int64 value: type: number @@ -18963,7 +20375,7 @@ components: type: array readOnly: true items: - "$ref": "#/components/schemas/TimeSeries.Column" + $ref: '#/components/schemas/TimeSeries.Column' ParameterSpec: type: object properties: @@ -18994,7 +20406,7 @@ components: independent-parameter-specs: type: array items: - "$ref": "#/components/schemas/ParameterSpec" + $ref: '#/components/schemas/ParameterSpec' rating-ids: type: array items: @@ -19004,8 +20416,7 @@ components: properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19013,18 +20424,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true templates: type: array items: - "$ref": "#/components/schemas/RatingTemplate" + $ref: '#/components/schemas/RatingTemplate' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true IndependentRoundingSpec: @@ -19035,6 +20448,51 @@ components: format: int32 value: type: string + rating-spec: + required: + - office-id + type: object + properties: + office-id: + type: string + description: Owning office of object. + rating-id: + type: string + template-id: + type: string + location-id: + type: string + version: + type: string + source-agency: + type: string + in-range-method: + type: string + out-range-low-method: + type: string + out-range-high-method: + type: string + active: + type: boolean + auto-update: + type: boolean + auto-activate: + type: boolean + auto-migrate-extension: + type: boolean + independent-rounding-specs: + type: array + items: + $ref: '#/components/schemas/IndependentRoundingSpec' + dependent-rounding-spec: + type: string + description: + type: string + effective-dates: + type: array + items: + type: string + format: date-time RatingSpec: required: - office-id @@ -19070,7 +20528,7 @@ components: independent-rounding-specs: type: array items: - "$ref": "#/components/schemas/IndependentRoundingSpec" + $ref: '#/components/schemas/IndependentRoundingSpec' dependent-rounding-spec: type: string description: @@ -19080,13 +20538,41 @@ components: items: type: string format: date-time + rating-specs: + type: object + properties: + next-page: + type: string + description: The cursor to the next page of data; null if there is no more data + readOnly: true + page: + type: string + description: The cursor to the current page of data + readOnly: true + page-size: + type: integer + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved + format: int32 + readOnly: true + specs: + type: array + items: + $ref: '#/components/schemas/rating-spec' + total: + type: integer + description: >- + The total number of records retrieved; null or not present if not + supported or unknown + format: int32 + readOnly: true RatingSpecs: type: object properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19094,18 +20580,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true specs: type: array items: - "$ref": "#/components/schemas/RatingSpec" + $ref: '#/components/schemas/rating-spec' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true AbstractRatingMetadata: @@ -19131,28 +20619,28 @@ components: description: type: string vertical-datum-info: - "$ref": "#/components/schemas/vertical-datum-info" + $ref: '#/components/schemas/vertical-datum-info' rating-type: type: string description: Rating Metadata discriminator: propertyName: rating-type mapping: - table: "#/components/schemas/TableRating" - transitional: "#/components/schemas/TransitionalRating" - virtual: "#/components/schemas/VirtualRating" - expression-rating: "#/components/schemas/ExpressionRating" - usgs: "#/components/schemas/UsgsStreamRating" + table: '#/components/schemas/TableRating' + transitional: '#/components/schemas/TransitionalRating' + virtual: '#/components/schemas/VirtualRating' + expression-rating: '#/components/schemas/ExpressionRating' + usgs: '#/components/schemas/UsgsStreamRating' oneOf: - - "$ref": "#/components/schemas/TableRating" - - "$ref": "#/components/schemas/TransitionalRating" - - "$ref": "#/components/schemas/VirtualRating" - - "$ref": "#/components/schemas/ExpressionRating" - - "$ref": "#/components/schemas/UsgsStreamRating" + - $ref: '#/components/schemas/TableRating' + - $ref: '#/components/schemas/TransitionalRating' + - $ref: '#/components/schemas/VirtualRating' + - $ref: '#/components/schemas/ExpressionRating' + - $ref: '#/components/schemas/UsgsStreamRating' ExpressionRating: type: object allOf: - - "$ref": "#/components/schemas/AbstractRatingMetadata" + - $ref: '#/components/schemas/AbstractRatingMetadata' - type: object properties: expression: @@ -19161,18 +20649,17 @@ components: type: object properties: rating-spec: - "$ref": "#/components/schemas/RatingSpec" + $ref: '#/components/schemas/rating-spec' ratings: type: array items: - "$ref": "#/components/schemas/AbstractRatingMetadata" + $ref: '#/components/schemas/AbstractRatingMetadata' RatingMetadataList: type: object properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19180,18 +20667,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true rating-metadata: type: array items: - "$ref": "#/components/schemas/RatingMetadata" + $ref: '#/components/schemas/RatingMetadata' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true SourceRating: @@ -19199,7 +20688,7 @@ components: TableRating: type: object allOf: - - "$ref": "#/components/schemas/AbstractRatingMetadata" + - $ref: '#/components/schemas/AbstractRatingMetadata' - type: object properties: in-range-method: @@ -19211,7 +20700,7 @@ components: TransitionalRating: type: object allOf: - - "$ref": "#/components/schemas/AbstractRatingMetadata" + - $ref: '#/components/schemas/AbstractRatingMetadata' - type: object properties: source-ratings: @@ -19229,17 +20718,17 @@ components: UsgsStreamRating: type: object allOf: - - "$ref": "#/components/schemas/TableRating" + - $ref: '#/components/schemas/TableRating' VirtualRating: type: object allOf: - - "$ref": "#/components/schemas/AbstractRatingMetadata" + - $ref: '#/components/schemas/AbstractRatingMetadata' - type: object properties: source-ratings: type: array items: - "$ref": "#/components/schemas/SourceRating" + $ref: '#/components/schemas/SourceRating' connections: type: string RatingEffectiveDatesMap: @@ -19250,7 +20739,7 @@ components: additionalProperties: type: array items: - "$ref": "#/components/schemas/RatingSpecEffectiveDates" + $ref: '#/components/schemas/RatingSpecEffectiveDates' RatingSpecEffectiveDates: required: - rating-spec-id @@ -19282,8 +20771,8 @@ components: office: type: string oneOf: - - "$ref": "#/components/schemas/LocationCatalogEntry" - - "$ref": "#/components/schemas/TimeseriesCatalogEntry" + - $ref: '#/components/schemas/LocationCatalogEntry' + - $ref: '#/components/schemas/TimeseriesCatalogEntry' LocationCatalogEntry: type: object properties: @@ -19341,7 +20830,7 @@ components: aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' TimeSeriesExtents: type: object properties: @@ -19379,27 +20868,27 @@ components: format: int64 time-zone: type: string - description: Only on 21.1.1 Database. The timezone the Interval Offset is - from. + description: Only on 21.1.1 Database. The timezone the Interval Offset is from. extents: type: array items: - "$ref": "#/components/schemas/TimeSeriesExtents" + $ref: '#/components/schemas/TimeSeriesExtents' aliases: type: array items: - "$ref": "#/components/schemas/alias" + $ref: '#/components/schemas/alias' + versioned: + type: boolean catalog: type: object properties: entries: type: array items: - "$ref": "#/components/schemas/CatalogEntry" + $ref: '#/components/schemas/CatalogEntry' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19407,14 +20896,16 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true Catalog: @@ -19423,11 +20914,10 @@ components: entries: type: array items: - "$ref": "#/components/schemas/CatalogEntry" + $ref: '#/components/schemas/CatalogEntry' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19435,14 +20925,16 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true Basin: @@ -19451,7 +20943,7 @@ components: type: object properties: basin-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' sort-order: type: number format: double @@ -19462,11 +20954,11 @@ components: type: number format: double parent-basin-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' area-unit: type: string primary-stream-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' Stream: required: - id @@ -19475,9 +20967,9 @@ components: starts-downstream: type: boolean flows-into-stream-node: - "$ref": "#/components/schemas/StreamNode" + $ref: '#/components/schemas/StreamNode' diverts-from-stream-node: - "$ref": "#/components/schemas/StreamNode" + $ref: '#/components/schemas/StreamNode' length: type: number format: double @@ -19491,14 +20983,14 @@ components: comment: type: string id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' StreamLocation: required: - stream-location-node type: object properties: stream-location-node: - "$ref": "#/components/schemas/StreamLocationNode" + $ref: '#/components/schemas/StreamLocationNode' published-station: type: number format: double @@ -19529,22 +21021,22 @@ components: comment: type: string downstream-node: - "$ref": "#/components/schemas/StreamLocationNode" + $ref: '#/components/schemas/StreamLocationNode' upstream-node: - "$ref": "#/components/schemas/StreamLocationNode" + $ref: '#/components/schemas/StreamLocationNode' configuration-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' stream-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' StreamNode: required: - stream-id type: object properties: stream-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' bank: type: string enum: @@ -19562,16 +21054,16 @@ components: type: object properties: id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' stream-node: - "$ref": "#/components/schemas/StreamNode" + $ref: '#/components/schemas/StreamNode' CwmsIdTimeExtentsEntry: type: object properties: id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' time-extents: - "$ref": "#/components/schemas/TimeExtents" + $ref: '#/components/schemas/TimeExtents' TimeExtents: type: object properties: @@ -19613,15 +21105,15 @@ components: type: string format: date-time id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' number: type: string streamflow-measurement: - "$ref": "#/components/schemas/StreamflowMeasurement" + $ref: '#/components/schemas/StreamflowMeasurement' supplemental-streamflow-measurement: - "$ref": "#/components/schemas/SupplementalStreamflowMeasurement" + $ref: '#/components/schemas/SupplementalStreamflowMeasurement' usgs-measurement: - "$ref": "#/components/schemas/UsgsMeasurement" + $ref: '#/components/schemas/UsgsMeasurement' StreamflowMeasurement: type: object properties: @@ -19704,6 +21196,67 @@ components: water-temp: type: number format: double + LocationToPublishedData: + required: + - location-id + type: object + properties: + location-id: + $ref: '#/components/schemas/CwmsId' + kind: + type: string + bounding-office-id: + type: string + published-times-series: + type: object + additionalProperties: + $ref: '#/components/schemas/PublishedTimeSeriesData' + LocationToPublishedDataList: + type: object + properties: + location-to-published-data: + type: array + items: + $ref: '#/components/schemas/LocationToPublishedData' + next-page: + type: string + description: The cursor to the next page of data; null if there is no more data + readOnly: true + page: + type: string + description: The cursor to the current page of data + readOnly: true + page-size: + type: integer + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved + format: int32 + readOnly: true + total: + type: integer + description: >- + The total number of records retrieved; null or not present if not + supported or unknown + format: int32 + readOnly: true + PublishedTimeSeriesData: + type: object + properties: + time-series-id: + $ref: '#/components/schemas/CwmsId' + timezone-name: + type: string + interval-offset-minutes: + type: integer + format: int32 + active: + type: boolean + date-refreshed: + type: string + format: date-time + notes: + type: string Blob: required: - id @@ -19730,11 +21283,10 @@ components: type: array description: List of retrieved blobs items: - "$ref": "#/components/schemas/Blob" + $ref: '#/components/schemas/Blob' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19742,14 +21294,16 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true Blobs: @@ -19759,11 +21313,10 @@ components: type: array description: List of retrieved blobs items: - "$ref": "#/components/schemas/Blob" + $ref: '#/components/schemas/Blob' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19771,14 +21324,16 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true clob: @@ -19818,11 +21373,10 @@ components: type: array description: List of retrieved clobs items: - "$ref": "#/components/schemas/clob" + $ref: '#/components/schemas/clob' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19830,14 +21384,16 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true Clobs: @@ -19847,11 +21403,10 @@ components: type: array description: List of retrieved clobs items: - "$ref": "#/components/schemas/clob" + $ref: '#/components/schemas/clob' next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19859,21 +21414,23 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true Pool: type: object properties: poolName: - "$ref": "#/components/schemas/PoolNameType" + $ref: '#/components/schemas/PoolNameType' projectId: type: string bottomLevelId: @@ -19901,8 +21458,7 @@ components: properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19910,19 +21466,21 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true pools: type: array description: List of retrieved pools items: - "$ref": "#/components/schemas/Pool" + $ref: '#/components/schemas/Pool' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true Pools: @@ -19930,8 +21488,7 @@ components: properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -19939,19 +21496,21 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true pools: type: array description: List of retrieved pools items: - "$ref": "#/components/schemas/Pool" + $ref: '#/components/schemas/Pool' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true SpecifiedLevel: @@ -19970,7 +21529,7 @@ components: type: object properties: spec: - "$ref": "#/components/schemas/forecast-spec" + $ref: '#/components/schemas/forecast-spec' date-time: type: string format: date-time @@ -20042,7 +21601,7 @@ components: type: object properties: spec: - "$ref": "#/components/schemas/forecast-spec" + $ref: '#/components/schemas/forecast-spec' date-time: type: string format: date-time @@ -20135,7 +21694,7 @@ components: entity-name: type: string project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' water-right: type: string WaterUserContract: @@ -20158,11 +21717,11 @@ components: type: string description: Owning office of object. water-user: - "$ref": "#/components/schemas/WaterUser" + $ref: '#/components/schemas/WaterUser' contract-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' contract-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' contract-effective-date: type: string format: date-time @@ -20187,11 +21746,11 @@ components: type: number format: double pump-out-location: - "$ref": "#/components/schemas/water_supply_pump" + $ref: '#/components/schemas/water_supply_pump' pump-out-below-location: - "$ref": "#/components/schemas/water_supply_pump" + $ref: '#/components/schemas/water_supply_pump' pump-in-location: - "$ref": "#/components/schemas/water_supply_pump" + $ref: '#/components/schemas/water_supply_pump' water_supply_pump: required: - pumpLocation @@ -20199,7 +21758,7 @@ components: type: object properties: pumpLocation: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' pumpType: type: string enum: @@ -20210,15 +21769,16 @@ components: type: object properties: pump-in: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' pump-out: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' pump-below: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' PumpTransfer: required: - comment - flow + - flow-unit - pump-type - transfer-type-display type: object @@ -20234,6 +21794,8 @@ components: flow: type: number format: double + flow-unit: + type: string comment: type: string WaterSupplyAccounting: @@ -20246,15 +21808,15 @@ components: contract-name: type: string water-user: - "$ref": "#/components/schemas/WaterUser" + $ref: '#/components/schemas/WaterUser' pump-locations: - "$ref": "#/components/schemas/PumpLocation" + $ref: '#/components/schemas/PumpLocation' pump-accounting: type: object additionalProperties: type: array items: - "$ref": "#/components/schemas/PumpTransfer" + $ref: '#/components/schemas/PumpTransfer' PumpType: type: string enum: @@ -20268,11 +21830,11 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' structure-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' upstream-side-slope: type: number format: double @@ -20291,9 +21853,9 @@ components: length-units: type: string downstream-protection-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' upstream-protection-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' Turbine: required: - location @@ -20301,9 +21863,9 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' Lock: required: - location @@ -20311,11 +21873,11 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' chamber-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' lock-width: type: number format: double @@ -20339,13 +21901,13 @@ components: type: number format: double high-water-upper-pool-location-level: - "$ref": "#/components/schemas/LockLocationLevelRef" + $ref: '#/components/schemas/LockLocationLevelRef' low-water-lower-pool-location-level: - "$ref": "#/components/schemas/LockLocationLevelRef" + $ref: '#/components/schemas/LockLocationLevelRef' high-water-lower-pool-location-level: - "$ref": "#/components/schemas/LockLocationLevelRef" + $ref: '#/components/schemas/LockLocationLevelRef' low-water-upper-pool-location-level: - "$ref": "#/components/schemas/LockLocationLevelRef" + $ref: '#/components/schemas/LockLocationLevelRef' high-water-upper-pool-warning-level: type: number format: double @@ -20371,16 +21933,16 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' change-date: type: string format: date-time protected: type: boolean discharge-computation-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' reason-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' notes: type: string new-total-discharge-override: @@ -20400,7 +21962,7 @@ components: uniqueItems: true type: array items: - "$ref": "#/components/schemas/TurbineSetting" + $ref: '#/components/schemas/TurbineSetting' pool-elevation: type: number format: double @@ -20414,7 +21976,7 @@ components: type: object properties: location-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' discharge-units: type: string old-discharge: @@ -20438,15 +22000,15 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' rating-group-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' rating-spec-id: type: string rating-category-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' GateChange: required: - change-date @@ -20456,7 +22018,7 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' change-date: type: string format: date-time @@ -20469,9 +22031,9 @@ components: protected: type: boolean discharge-computation-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' reason-type: - "$ref": "#/components/schemas/LookupType" + $ref: '#/components/schemas/LookupType' notes: type: string type: @@ -20493,7 +22055,7 @@ components: uniqueItems: true type: array items: - "$ref": "#/components/schemas/GateSetting" + $ref: '#/components/schemas/GateSetting' discriminator: propertyName: type GateSetting: @@ -20506,7 +22068,7 @@ components: type: object properties: location-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' opening: type: number format: double @@ -20528,24 +22090,24 @@ components: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' virtual-outlet-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' virtual-records: type: array items: - "$ref": "#/components/schemas/VirtualOutletRecord" + $ref: '#/components/schemas/VirtualOutletRecord' VirtualOutletRecord: required: - outlet-id type: object properties: outlet-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' downstream-outlet-ids: type: array items: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' LocationsWithProjectKind: type: object properties: @@ -20560,21 +22122,21 @@ components: location-ids: type: array items: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' ProjectChildLocations: type: object properties: project-id: - "$ref": "#/components/schemas/CwmsId" + $ref: '#/components/schemas/CwmsId' locations-by-kind: type: array items: - "$ref": "#/components/schemas/LocationsWithProjectKind" + $ref: '#/components/schemas/LocationsWithProjectKind' Project: type: object properties: location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' federal-cost: type: number non-federal-cost: @@ -20601,9 +22163,9 @@ components: bank-full-capacity-desc: type: string pump-back-location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' near-gage-location: - "$ref": "#/components/schemas/Location" + $ref: '#/components/schemas/Location' yield-time-frame-start: type: string format: date-time @@ -20617,8 +22179,7 @@ components: properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -20626,18 +22187,20 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true projects: type: array items: - "$ref": "#/components/schemas/Project" + $ref: '#/components/schemas/Project' total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true property: @@ -20751,8 +22314,7 @@ components: properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -20760,28 +22322,29 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true users: type: array description: List of retrieved users items: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' Users: type: object properties: next-page: type: string - description: The cursor to the next page of data; null if there is no more - data + description: The cursor to the next page of data; null if there is no more data readOnly: true page: type: string @@ -20789,21 +22352,23 @@ components: readOnly: true page-size: type: integer - description: The number of records fetched per-page; this may be larger - than the number of records actually retrieved + description: >- + The number of records fetched per-page; this may be larger than the + number of records actually retrieved format: int32 readOnly: true total: type: integer - description: The total number of records retrieved; null or not present - if not supported or unknown + description: >- + The total number of records retrieved; null or not present if not + supported or unknown format: int32 readOnly: true users: type: array description: List of retrieved users items: - "$ref": "#/components/schemas/User" + $ref: '#/components/schemas/User' CdaVersion: required: - version @@ -20815,67 +22380,77 @@ components: type: object additionalProperties: type: object + MessageQueue: + type: string + description: >- + Desired set of status messages. Must be one of the named options. Letter + casing is ignored. + enum: + - TS_STORED + - STATUS + - REALTIME_OPS AtomLink: - type: "object" + type: object properties: rel: - type: "string" + type: string href: - type: "string" + type: string type: - type: "string" - description: "Atom link for pagination to the next page of RSS items" + type: string + description: Atom link for pagination to the next page of RSS items Guid: - type: "object" + type: object properties: guid: - type: "string" - description: "Globally unique identifier for the RSS item" + type: string + description: Globally unique identifier for the RSS item RssChannel: required: - - "description" - - "title" - type: "object" + - description + - title + type: object properties: title: - type: "string" - description: "Title of the RSS channel" + type: string + description: Title of the RSS channel nextLink: - $ref: "#/components/schemas/AtomLink" + $ref: '#/components/schemas/AtomLink' description: - type: "string" - description: "Description of the RSS channel" + type: string + description: Description of the RSS channel items: - type: "array" - description: "List of RSS items in the channel" + type: array + description: List of RSS items in the channel items: - $ref: "#/components/schemas/RssItem" - description: "The RSS channel containing feed metadata and items" + $ref: '#/components/schemas/RssItem' + description: The RSS channel containing feed metadata and items RssFeed: - type: "object" + type: object properties: version: - type: "string" + type: string channel: - $ref: "#/components/schemas/RssChannel" + $ref: '#/components/schemas/RssChannel' RssItem: - type: "object" + type: object properties: description: - type: "string" - description: "Description of the RSS item content" + type: string + description: Description of the RSS item content pubDate: - type: "string" - description: "Publication date and time of the RSS item" - format: "date-time" + type: string + description: Publication date and time of the RSS item + format: date-time guid: - $ref: "#/components/schemas/Guid" - description: "List of RSS items in the channel" + $ref: '#/components/schemas/Guid' + description: List of RSS items in the channel securitySchemes: ApiKey: type: apiKey - description: 'Key value as generated from the /auth/keys endpoint. NOTE: you - MUST manually prefix your key with ''apikey '' (without the single quotes).' + description: >- + Key value as generated from the /auth/keys endpoint. NOTE: you MUST + manually prefix your key with 'apikey ' (without the single quotes). name: Authorization in: header scheme: apikey diff --git a/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/LocationToPublishedData.java b/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/LocationToPublishedData.java new file mode 100644 index 00000000..a65b74f8 --- /dev/null +++ b/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/LocationToPublishedData.java @@ -0,0 +1,136 @@ +package mil.army.usace.hec.cwms.data.api.client.model; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.HashMap; +import java.util.Map; +import jakarta.validation.Valid; +import jakarta.validation.constraints.*; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; + +/** + * LocationToPublishedData + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@jakarta.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2026-06-05T16:57:21.059473900-07:00[America/Los_Angeles]") +public class LocationToPublishedData { + + @JsonProperty("location-id") + private CwmsId locationId = null; + + @JsonProperty("kind") + private String kind = null; + + @JsonProperty("bounding-office-id") + private String boundingOfficeId = null; + + @JsonProperty("published-times-series") + @Valid + private Map publishedTimesSeries = null; + + public LocationToPublishedData locationId(CwmsId locationId) { + this.locationId = locationId; + return this; + } + + public CwmsId getLocationId() { + return locationId; + } + + public void setLocationId(CwmsId locationId) { + this.locationId = locationId; + } + + public LocationToPublishedData kind(String kind) { + this.kind = kind; + return this; + } + + public String getKind() { + return kind; + } + + public void setKind(String kind) { + this.kind = kind; + } + + public LocationToPublishedData boundingOfficeId(String boundingOfficeId) { + this.boundingOfficeId = boundingOfficeId; + return this; + } + + public String getBoundingOfficeId() { + return boundingOfficeId; + } + + public void setBoundingOfficeId(String boundingOfficeId) { + this.boundingOfficeId = boundingOfficeId; + } + + public LocationToPublishedData publishedTimesSeries(Map publishedTimesSeries) { + this.publishedTimesSeries = publishedTimesSeries; + return this; + } + + public LocationToPublishedData putPublishedTimesSeriesItem(String key, PublishedTimeSeriesData publishedTimesSeriesItem) { + if (this.publishedTimesSeries == null) { + this.publishedTimesSeries = new HashMap<>(); + } + this.publishedTimesSeries.put(key, publishedTimesSeriesItem); + return this; + } + + public Map getPublishedTimesSeries() { + return publishedTimesSeries; + } + + public void setPublishedTimesSeries(Map publishedTimesSeries) { + this.publishedTimesSeries = publishedTimesSeries; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LocationToPublishedData locationToPublishedData = (LocationToPublishedData) o; + return Objects.equals(this.locationId, locationToPublishedData.locationId) + && this.kind == null || locationToPublishedData.kind == null?Objects.equals(this.kind, locationToPublishedData.kind):this.kind.equalsIgnoreCase(locationToPublishedData.kind) + && this.boundingOfficeId == null || locationToPublishedData.boundingOfficeId == null?Objects.equals(this.boundingOfficeId, locationToPublishedData.boundingOfficeId):this.boundingOfficeId.equalsIgnoreCase(locationToPublishedData.boundingOfficeId) + && Objects.equals(this.publishedTimesSeries, locationToPublishedData.publishedTimesSeries) + ; + } + + @Override + public int hashCode() { + return Objects.hash(locationId, kind==null?0:kind.toLowerCase(), boundingOfficeId==null?0:boundingOfficeId.toLowerCase(), publishedTimesSeries); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LocationToPublishedData {\n"); + + sb.append(" locationId: ").append(toIndentedString(locationId)).append("\n"); + sb.append(" kind: ").append(toIndentedString(kind)).append("\n"); + sb.append(" boundingOfficeId: ").append(toIndentedString(boundingOfficeId)).append("\n"); + sb.append(" publishedTimesSeries: ").append(toIndentedString(publishedTimesSeries)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/LocationToPublishedDataList.java b/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/LocationToPublishedDataList.java new file mode 100644 index 00000000..45f77b85 --- /dev/null +++ b/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/LocationToPublishedDataList.java @@ -0,0 +1,154 @@ +package mil.army.usace.hec.cwms.data.api.client.model; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.util.ArrayList; +import java.util.List; +import jakarta.validation.Valid; +import jakarta.validation.constraints.*; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; + +/** + * LocationToPublishedDataList + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@jakarta.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2026-06-05T16:57:21.059473900-07:00[America/Los_Angeles]") +public class LocationToPublishedDataList { + + @JsonProperty("location-to-published-data") + @Valid + private List locationToPublishedData = new ArrayList<>(); + + @JsonProperty("next-page") + private String nextPage = null; + + @JsonProperty("page") + private String page = null; + + @JsonProperty("page-size") + private Integer pageSize = null; + + @JsonProperty("total") + private Integer total = null; + + public LocationToPublishedDataList locationToPublishedData(List locationToPublishedData) { + this.locationToPublishedData = locationToPublishedData; + return this; + } + + public LocationToPublishedDataList addLocationToPublishedDataItem(LocationToPublishedData locationToPublishedDataItem) { + if (this.locationToPublishedData == null) { + this.locationToPublishedData = new ArrayList<>(); + } + this.locationToPublishedData.add(locationToPublishedDataItem); + return this; + } + + public List getLocationToPublishedData() { + return locationToPublishedData; + } + + public void setLocationToPublishedData(List locationToPublishedData) { + this.locationToPublishedData = locationToPublishedData; + } + + public LocationToPublishedDataList nextPage(String nextPage) { + this.nextPage = nextPage; + return this; + } + + public String getNextPage() { + return nextPage; + } + + public void setNextPage(String nextPage) { + this.nextPage = nextPage; + } + + public LocationToPublishedDataList page(String page) { + this.page = page; + return this; + } + + public String getPage() { + return page; + } + + public void setPage(String page) { + this.page = page; + } + + public LocationToPublishedDataList pageSize(Integer pageSize) { + this.pageSize = pageSize; + return this; + } + + public Integer getPageSize() { + return pageSize; + } + + public void setPageSize(Integer pageSize) { + this.pageSize = pageSize; + } + + public LocationToPublishedDataList total(Integer total) { + this.total = total; + return this; + } + + public Integer getTotal() { + return total; + } + + public void setTotal(Integer total) { + this.total = total; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + LocationToPublishedDataList locationToPublishedDataList = (LocationToPublishedDataList) o; + return Objects.equals(this.locationToPublishedData, locationToPublishedDataList.locationToPublishedData) + && this.nextPage == null || locationToPublishedDataList.nextPage == null?Objects.equals(this.nextPage, locationToPublishedDataList.nextPage):this.nextPage.equalsIgnoreCase(locationToPublishedDataList.nextPage) + && this.page == null || locationToPublishedDataList.page == null?Objects.equals(this.page, locationToPublishedDataList.page):this.page.equalsIgnoreCase(locationToPublishedDataList.page) + && Objects.equals(this.pageSize, locationToPublishedDataList.pageSize) + && Objects.equals(this.total, locationToPublishedDataList.total) + ; + } + + @Override + public int hashCode() { + return Objects.hash(locationToPublishedData, nextPage==null?0:nextPage.toLowerCase(), page==null?0:page.toLowerCase(), pageSize, total); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class LocationToPublishedDataList {\n"); + + sb.append(" locationToPublishedData: ").append(toIndentedString(locationToPublishedData)).append("\n"); + sb.append(" nextPage: ").append(toIndentedString(nextPage)).append("\n"); + sb.append(" page: ").append(toIndentedString(page)).append("\n"); + sb.append(" pageSize: ").append(toIndentedString(pageSize)).append("\n"); + sb.append(" total: ").append(toIndentedString(total)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +} diff --git a/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/PublishedTimeSeriesData.java b/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/PublishedTimeSeriesData.java new file mode 100644 index 00000000..53da971c --- /dev/null +++ b/cwms-data-api-model/src/main/java/mil/army/usace/hec/cwms/data/api/client/model/PublishedTimeSeriesData.java @@ -0,0 +1,161 @@ +package mil.army.usace.hec.cwms.data.api.client.model; + +import java.util.Objects; +import com.fasterxml.jackson.annotation.JsonProperty; +import java.time.OffsetDateTime; +import jakarta.validation.constraints.*; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; + +/** + * PublishedTimeSeriesData + */ +@JsonIgnoreProperties(ignoreUnknown = true) +@jakarta.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2026-06-05T16:57:21.059473900-07:00[America/Los_Angeles]") +public class PublishedTimeSeriesData { + + @JsonProperty("time-series-id") + private CwmsId timeSeriesId = null; + + @JsonProperty("timezone-name") + private String timezoneName = null; + + @JsonProperty("interval-offset-minutes") + private Integer intervalOffsetMinutes = null; + + @JsonProperty("active") + private Boolean active = null; + + @JsonProperty("date-refreshed") + private OffsetDateTime dateRefreshed = null; + + @JsonProperty("notes") + private String notes = null; + + public PublishedTimeSeriesData timeSeriesId(CwmsId timeSeriesId) { + this.timeSeriesId = timeSeriesId; + return this; + } + + public CwmsId getTimeSeriesId() { + return timeSeriesId; + } + + public void setTimeSeriesId(CwmsId timeSeriesId) { + this.timeSeriesId = timeSeriesId; + } + + public PublishedTimeSeriesData timezoneName(String timezoneName) { + this.timezoneName = timezoneName; + return this; + } + + public String getTimezoneName() { + return timezoneName; + } + + public void setTimezoneName(String timezoneName) { + this.timezoneName = timezoneName; + } + + public PublishedTimeSeriesData intervalOffsetMinutes(Integer intervalOffsetMinutes) { + this.intervalOffsetMinutes = intervalOffsetMinutes; + return this; + } + + public Integer getIntervalOffsetMinutes() { + return intervalOffsetMinutes; + } + + public void setIntervalOffsetMinutes(Integer intervalOffsetMinutes) { + this.intervalOffsetMinutes = intervalOffsetMinutes; + } + + public PublishedTimeSeriesData active(Boolean active) { + this.active = active; + return this; + } + + public Boolean isActive() { + return active; + } + + public void setActive(Boolean active) { + this.active = active; + } + + public PublishedTimeSeriesData dateRefreshed(OffsetDateTime dateRefreshed) { + this.dateRefreshed = dateRefreshed; + return this; + } + + public OffsetDateTime getDateRefreshed() { + return dateRefreshed; + } + + public void setDateRefreshed(OffsetDateTime dateRefreshed) { + this.dateRefreshed = dateRefreshed; + } + + public PublishedTimeSeriesData notes(String notes) { + this.notes = notes; + return this; + } + + public String getNotes() { + return notes; + } + + public void setNotes(String notes) { + this.notes = notes; + } + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PublishedTimeSeriesData publishedTimeSeriesData = (PublishedTimeSeriesData) o; + return Objects.equals(this.timeSeriesId, publishedTimeSeriesData.timeSeriesId) + && this.timezoneName == null || publishedTimeSeriesData.timezoneName == null?Objects.equals(this.timezoneName, publishedTimeSeriesData.timezoneName):this.timezoneName.equalsIgnoreCase(publishedTimeSeriesData.timezoneName) + && Objects.equals(this.intervalOffsetMinutes, publishedTimeSeriesData.intervalOffsetMinutes) + && Objects.equals(this.active, publishedTimeSeriesData.active) + && Objects.equals(this.dateRefreshed, publishedTimeSeriesData.dateRefreshed) + && this.notes == null || publishedTimeSeriesData.notes == null?Objects.equals(this.notes, publishedTimeSeriesData.notes):this.notes.equalsIgnoreCase(publishedTimeSeriesData.notes) + ; + } + + @Override + public int hashCode() { + return Objects.hash(timeSeriesId, timezoneName==null?0:timezoneName.toLowerCase(), intervalOffsetMinutes, active, dateRefreshed, notes==null?0:notes.toLowerCase()); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PublishedTimeSeriesData {\n"); + + sb.append(" timeSeriesId: ").append(toIndentedString(timeSeriesId)).append("\n"); + sb.append(" timezoneName: ").append(toIndentedString(timezoneName)).append("\n"); + sb.append(" intervalOffsetMinutes: ").append(toIndentedString(intervalOffsetMinutes)).append("\n"); + sb.append(" active: ").append(toIndentedString(active)).append("\n"); + sb.append(" dateRefreshed: ").append(toIndentedString(dateRefreshed)).append("\n"); + sb.append(" notes: ").append(toIndentedString(notes)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +}