From 23b1f93368386d49f99df9d72d0206632c8cad62 Mon Sep 17 00:00:00 2001 From: tangoyankee Date: Mon, 20 May 2024 12:33:15 -0400 Subject: [PATCH] Document a capital project Add the /capital-projects/{managingCode}/{capitalProjectid} endpoint. closes #238 --- openapi/openapi.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/openapi/openapi.yaml b/openapi/openapi.yaml index 1dc3083e..444d1445 100644 --- a/openapi/openapi.yaml +++ b/openapi/openapi.yaml @@ -140,6 +140,28 @@ paths: $ref: "#/components/responses/NotFound" '500': $ref: "#/components/responses/InternalServerError" + /capital-projects/{managingCode}/{capitalProjectId}: + get: + summary: 🚧 Find details about a specific capital project + operationId: findCapitalProjectByManagingCodeCapitalProjectId + tags: + - Capital Projects + parameters: + - $ref: "#/components/parameters/managingCodeParam" + - $ref: "#/components/parameters/capitalProjectIdParam" + responses: + '200': + description: An object of capital project details + content: + application/json: + schema: + $ref: '#/components/schemas/CapitalProjectBudgeted' + '400': + $ref: "#/components/responses/BadRequest" + '404': + $ref: "#/components/responses/NotFound" + '500': + $ref: "#/components/responses/InternalServerError" /capital-projects/{z}/{x}/{y}.pbf: get: summary: Mapbox Vector Tiles for capital projects