From 9aa8b8bbefa7ba5e8368c0bc5dcd09b98fa25d17 Mon Sep 17 00:00:00 2001 From: Courtney Myers <courtney.myers@erg.com> Date: Mon, 15 Apr 2024 15:28:23 -0400 Subject: [PATCH] Update OpenAPI docs with 2023 change request routes --- docs/csb-openapi.json | 82 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 78 insertions(+), 4 deletions(-) diff --git a/docs/csb-openapi.json b/docs/csb-openapi.json index 3405ae50..5d891713 100644 --- a/docs/csb-openapi.json +++ b/docs/csb-openapi.json @@ -673,10 +673,7 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object" - } + "type": "object" } } } @@ -818,6 +815,83 @@ } } }, + "/api/formio/2023/changes": { + "get": { + "summary": "Get user's 2023 Change Request form submissions from Formio.", + "parameters": [], + "responses": { + "200": { + "description": "An array of 2023 Change Request form submissions.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + } + }, + "/api/formio/2023/change": { + "get": { + "summary": "Get the 2023 Change Request form's schema from Formio.", + "parameters": [], + "responses": { + "200": { + "description": "The 2023 Change Request form's schema.", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } + }, + "post": { + "summary": "Post a new 2023 Change Request form submission to Formio.", + "parameters": [], + "responses": { + "200": { + "description": "The newly created 2023 Change Request form submission.", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } + } + }, + "/api/formio/2023/change/{mongoId}": { + "get": { + "summary": "Get an existing 2023 Change Request form's schema and submission data from Formio.", + "parameters": [ + { + "$ref": "#/components/parameters/mongoId" + } + ], + "responses": { + "200": { + "description": "The 2023 Change Request form's schema, form submission, and user access status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FormioSchemaAndSubmission" + } + } + } + } + } + } + }, "/api/help/formio/submission/{rebateYear}/{formType}/{id}": { "get": { "summary": "Get an existing form's submission data from Formio.",