From d3979f0d9cd1ac1f03473b1a640dd6b72e27ab92 Mon Sep 17 00:00:00 2001 From: Rachel Brown Date: Wed, 11 Dec 2024 12:24:23 -0600 Subject: [PATCH] Release 2024.12.0 --- CHANGELOG.md | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- openapi.json | 61 +++++++++++++++++++++++++------------- 3 files changed, 124 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b5446ce..9932673 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,86 @@ +## v2024.12.0 + +#### What's Changed + +##### `GET` /api/v2/steps/{id} + + +###### Return Type: + +Changed response : **200 OK** +> OK + +* Changed content type : `application/json` + + * Added property `description` (string) + > The description of the step + +##### `PATCH` /api/v2/steps/{id} + + +###### Request: + +Changed content type : `application/json` + +* Added property `description` (string) + > The description of the step + +###### Return Type: + +Changed response : **200 OK** +> OK + +* Changed content type : `application/json` + + * Added property `description` (string) + > The description of the step + +##### `POST` /api/v2/steps + + +###### Request: + +Changed content type : `application/json` + +* Added property `description` (string) + > The description of the step + +###### Return Type: + +Changed response : **200 OK** +> OK + +* Changed content type : `application/json` + + * Added property `description` (string) + > The description of the step + +##### `GET` /api/v2/steps + + +###### Return Type: + +Changed response : **200 OK** +> OK + +* Changed content type : `application/json` + + * Changed property `content` (array) + > A array of returned items + + Changed items (object): + + * Added property `description` (string) + > The description of the step + +##### `GET` /api/v2/fields + + +###### Parameters: + +Changed: `field-type` in `query` +> A field type where, if provided, the response will only contain fields of the identified field type + ## v2024.11.1 No API updates. diff --git a/README.md b/README.md index b17c80a..f9eb653 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Risk Cloud API: OpenAPI Specification

- +

diff --git a/openapi.json b/openapi.json index 537fcd7..befa93f 100644 --- a/openapi.json +++ b/openapi.json @@ -7,7 +7,7 @@ "name": "developer-relations@logicgate.com", "email": "developer-relations@logicgate.com" }, - "version": "v2024.11.1" + "version": "v2024.12.0" }, "externalDocs": { "description": "Developer Portal", @@ -1371,25 +1371,29 @@ "description": "A field type where, if provided, the response will only contain fields of the identified field type", "required": false, "schema": { - "title": "Field Type (Filter)", - "type": "string", - "enum": [ - "DATE", - "USER", - "EXTERNAL_USER", - "TEXT", - "TEXT_AREA", - "NUMBER", - "E_SIGNATURE", - "CHECKBOX", - "MULTI_SELECT", - "RADIO", - "SELECT", - "ATTACHMENT", - "CALCULATION", - "TEXT_CONCATENATION", - "DATE_CALCULATION" - ] + "type": "array", + "items": { + "title": "Field Type (Filter)", + "type": "string", + "enum": [ + "DATE", + "USER", + "EXTERNAL_USER", + "TEXT", + "TEXT_AREA", + "NUMBER", + "E_SIGNATURE", + "CHECKBOX", + "MULTI_SELECT", + "RADIO", + "SELECT", + "ATTACHMENT", + "CALCULATION", + "TEXT_CONCATENATION", + "DATE_CALCULATION" + ] + }, + "default": [] }, "example": "SELECT" }, @@ -1670,6 +1674,11 @@ "format": "int32", "example": 20 }, + "description": { + "type": "string", + "description": "The description of the step", + "example": "This is a description of the step" + }, "enableComments": { "type": "boolean", "description": "Whether comments are displayed on a step (defaults to false)", @@ -1707,6 +1716,11 @@ "description": "The name of the step", "example": "Identify Risk" }, + "description": { + "type": "string", + "description": "The description of the step", + "example": "This is a description of the step" + }, "xpos": { "type": "integer", "description": "The x-coordinate of the step in the application builder", @@ -2090,6 +2104,11 @@ "description": "The name of the step", "example": "Identify Risk" }, + "description": { + "type": "string", + "description": "The description of the step", + "example": "This is a description of the step" + }, "xpos": { "type": "integer", "description": "The x-coordinate of the step in the application builder (must not be less than 0)", @@ -2905,4 +2924,4 @@ } } } -} +} \ No newline at end of file