diff --git a/specs/SHIELD.json b/specs/SHIELD.json index 3887966..4eecf23 100644 --- a/specs/SHIELD.json +++ b/specs/SHIELD.json @@ -394,6 +394,33 @@ } ] }, + "Core.OperationMode": { + "title": "Core - Operation Mode", + "description": "Indicates the operation mode that the SHIELD application is currently running in.", + "type": "object", + "properties": { + "operationMode": { + "description": "Current operation mode value returned by the application.", + "type": "string", + "minLength": 1, + "examples": [ + "normal", + "discover" + ] + } + }, + "required": [ + "operationMode" + ], + "examples": [ + { + "operationMode": "normal" + }, + { + "operationMode": "discover" + } + ] + }, "Core.ProgressBar": { "title": "Core - Progress Bar", "description": "Used to indicate the progress of a long running operation.", @@ -4392,6 +4419,38 @@ "summary": "Health of the Service for Probing" } }, + "/Api/Core/OperationMode": { + "get": { + "description": "Retrieves the current operation mode used by the SHIELD application.", + "operationId": "/Api/Core/OperationMode/Get", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Core.OperationMode" + }, + "examples": { + "Current operation mode": { + "summary": "Example Current Operation Mode", + "description": "An example payload that returns the application's current operation mode.", + "value": { + "operationMode": "normal" + } + } + } + } + }, + "description": "OK" + } + }, + "tags": [ + "Core" + ], + "security": [], + "summary": "Retrieves the Current Operation Mode" + } + }, "/Api/Auth/Id": { "get": { "description": "Provides the Tenant ID and the Application ID of the service principal that access tokens need to be issued against. This is also useful for configuring public clients to be able to authenticate to for auth code flows.",