@3sixty/data-processing-service 0.0.0-stage → 0.20.0-next.1

package/docs/open-api/spec.json

@@ -0,0 +1,894 @@
+{
+	"openapi": "3.1.1",
+	"info": {
+		"title": "3Sixty - Test Endpoints",
+		"description": "REST API for 3Sixty - Test Endpoints.",
+		"version": "1.0.0",
+		"license": {
+			"name": "Apache 2.0 License",
+			"url": "https://opensource.org/licenses/Apache-2.0"
+		}
+	},
+	"servers": [
+		{
+			"url": "https://localhost"
+		}
+	],
+	"tags": [
+		{
+			"name": "Data Processing",
+			"description": "Endpoints which are modelled to access a data processing contract."
+		}
+	],
+	"paths": {
+		"/data-processing/rule-group/{id}": {
+			"put": {
+				"operationId": "dataProcessingSetRuleGroup",
+				"summary": "Store a rule group for extraction.",
+				"tags": [
+					"Data Processing"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the rule group to set.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "my-rule-group"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Set a rule group.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/DataProcessingRuleGroupSetRequest"
+							},
+							"examples": {
+								"dataProcessingRuleGroupSetRequestExample": {
+									"value": {
+										"label": "My Rule Group",
+										"rules": [
+											{
+												"source": "$.foo",
+												"target": "goo",
+												"coerce": "bigint"
+											}
+										]
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"get": {
+				"operationId": "dataProcessingGetRuleGroup",
+				"summary": "Get a rule group for extraction.",
+				"tags": [
+					"Data Processing"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the rule group to retrieve.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "my-rule-group"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Get a rule group response.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/RuleGroup"
+								},
+								"examples": {
+									"dataProcessingRuleGroupSetResponseExample": {
+										"value": {
+											"id": "my-rule-group",
+											"label": "My Rule Group",
+											"rules": [
+												{
+													"source": "$.foo",
+													"target": "goo",
+													"coerce": "bigint"
+												}
+											]
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			},
+			"delete": {
+				"operationId": "dataProcessingRemoveRuleGroup",
+				"summary": "Remove an extraction rule group.",
+				"tags": [
+					"Data Processing"
+				],
+				"parameters": [
+					{
+						"name": "id",
+						"description": "The id of the rule group to remove.",
+						"in": "path",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "my-rule-group"
+					}
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"204": {
+						"description": "The rest request ended in success with no data."
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/data-processing/extract": {
+			"post": {
+				"operationId": "dataProcessingExtract",
+				"summary": "Extract data from a binary source using the specified rule group.",
+				"tags": [
+					"Data Processing"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Perform an extraction on the data with the specified ruleset.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/DataProcessingExtractRequest"
+							},
+							"examples": {
+								"dataProcessingExtractRequestExample": {
+									"value": {
+										"ruleGroupId": "my-rule-group",
+										"data": "eyJmb28iOiAiYmFyIn0="
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "Response to extracting data.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/DataProcessingExtractResponse"
+								},
+								"examples": {
+									"dataProcessingExtractResponseExample": {
+										"value": {
+											"foo": "bar"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/data-processing/convert": {
+			"post": {
+				"operationId": "dataProcessingConvert",
+				"summary": "Convert data from a binary source and return structured object.",
+				"tags": [
+					"Data Processing"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"requestBody": {
+					"description": "Perform a conversion on the data.",
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/DataProcessingConvertRequest"
+							},
+							"examples": {
+								"dataProcessingConvertRequestExample": {
+									"value": {
+										"data": "eyJmb28iOiAiYmFyIn0="
+									}
+								}
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "Response to converting data.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/DataProcessingConvertResponse"
+								},
+								"examples": {
+									"dataProcessingConvertResponseExample": {
+										"value": {
+											"foo": "bar"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/data-processing/rule-group": {
+			"get": {
+				"operationId": "dataProcessingListRuleGroup",
+				"summary": "Get a list with rule groups for extraction.",
+				"tags": [
+					"Data Processing"
+				],
+				"security": [
+					{
+						"jwtBearerAuthScheme": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Response for rule group entry list request.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/DataProcessingRuleGroupListResponse"
+								},
+								"examples": {
+									"ruleGroupListResponseExample": {
+										"value": {
+											"entities": [
+												{
+													"id": "my-rule-group",
+													"label": "My Rule Group",
+													"rules": [
+														{
+															"source": "$.foo",
+															"target": "goo",
+															"coerce": "bigint"
+														}
+													]
+												}
+											],
+											"cursor": "1"
+										}
+									}
+								}
+							}
+						}
+					},
+					"400": {
+						"description": "The server cannot process the request, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "GeneralError",
+											"message": "errorMessage",
+											"properties": {
+												"foo": "bar"
+											}
+										}
+									}
+								}
+							}
+						}
+					},
+					"401": {
+						"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "UnauthorizedError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					},
+					"500": {
+						"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/Error"
+								},
+								"examples": {
+									"exampleResponse": {
+										"value": {
+											"name": "InternalServerError",
+											"message": "errorMessage"
+										}
+									}
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"CoerceType": {
+				"description": "The types the extracted data can be coerced to.",
+				"anyOf": [
+					{
+						"const": "string",
+						"description": "String."
+					},
+					{
+						"const": "number",
+						"description": "Number."
+					},
+					{
+						"const": "integer",
+						"description": "Integer."
+					},
+					{
+						"const": "boolean",
+						"description": "Boolean."
+					},
+					{
+						"const": "bigint",
+						"description": "Big Integer."
+					},
+					{
+						"const": "date",
+						"description": "Date."
+					},
+					{
+						"const": "datetime",
+						"description": "Date Time."
+					},
+					{
+						"const": "time",
+						"description": "Time."
+					},
+					{
+						"const": "object",
+						"description": "Object."
+					},
+					{
+						"const": "uint8array",
+						"description": "Uint8Array."
+					},
+					{
+						"const": "duration",
+						"description": "Duration in seconds."
+					},
+					{
+						"const": "array",
+						"description": "Array."
+					}
+				]
+			},
+			"DataProcessingConvertRequest": {
+				"type": "object",
+				"properties": {
+					"data": {
+						"type": "string",
+						"description": "The binary data to convert in base64."
+					},
+					"overrideMimeType": {
+						"type": "string",
+						"description": "Use the specified mime type for conversion, will auto detect if undefined."
+					}
+				},
+				"required": [
+					"data"
+				],
+				"description": "The request body containing the data to convert."
+			},
+			"DataProcessingConvertResponse": {
+				"description": "The converted data as an object."
+			},
+			"DataProcessingExtractRequest": {
+				"type": "object",
+				"properties": {
+					"ruleGroupId": {
+						"type": "string",
+						"description": "The rule group id to use for the extraction."
+					},
+					"data": {
+						"type": "string",
+						"description": "The binary data to extract from in base64."
+					},
+					"overrideExtractorType": {
+						"type": "string",
+						"description": "The default extractor connector will be used if not specified."
+					},
+					"overrideMimeType": {
+						"type": "string",
+						"description": "An optional override for the mime type for conversion, will auto detect if not provided."
+					}
+				},
+				"required": [
+					"ruleGroupId",
+					"data"
+				],
+				"description": "The request body containing the data and rule group to use for extraction."
+			},
+			"DataProcessingExtractResponse": {
+				"description": "The extracted data in extended JSON format, preserving types such as bigint, dates, and Uint8Array."
+			},
+			"DataProcessingRuleGroupListResponse": {
+				"type": "object",
+				"properties": {
+					"entities": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/RuleGroup"
+						},
+						"description": "The entities, which can be partial if a limited keys list was provided."
+					},
+					"cursor": {
+						"type": "string",
+						"description": "An optional cursor, when defined can be used to call find to get more entities."
+					}
+				},
+				"required": [
+					"entities"
+				],
+				"description": "The response body containing the list of rule groups and optional pagination cursor."
+			},
+			"DataProcessingRuleGroupSetRequest": {
+				"type": "object",
+				"properties": {
+					"label": {
+						"type": "string",
+						"description": "The label for the rule group."
+					},
+					"rules": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/Rule"
+						},
+						"description": "The rules."
+					}
+				},
+				"required": [
+					"label",
+					"rules"
+				],
+				"description": "The rule group data to store."
+			},
+			"Error": {
+				"description": "Model to describe serialized error.",
+				"type": "object",
+				"properties": {
+					"name": {
+						"type": "string",
+						"description": "The name for the error."
+					},
+					"message": {
+						"type": "string",
+						"description": "The message for the error as an i18n key."
+					},
+					"source": {
+						"type": "string",
+						"description": "The source of the error."
+					},
+					"properties": {
+						"type": "object",
+						"additionalProperties": {},
+						"description": "Any additional information for the error."
+					},
+					"stack": {
+						"type": "string",
+						"description": "The stack trace for the error."
+					},
+					"cause": {
+						"$ref": "#/components/schemas/Error"
+					}
+				},
+				"required": [
+					"name",
+					"message"
+				]
+			},
+			"Rule": {
+				"description": "Rule defining how to extract data from an object.",
+				"type": "object",
+				"properties": {
+					"source": {
+						"type": "string",
+						"description": "The JSONPath expression identifying the data to extract from the document."
+					},
+					"target": {
+						"type": "string",
+						"description": "The target path of where to store the extracted data, using dotted or numeric index notation."
+					},
+					"retainPathDepth": {
+						"type": "number",
+						"description": "When extracting objects, how much of the original path should be maintained in the target object."
+					},
+					"coerce": {
+						"$ref": "#/components/schemas/CoerceType"
+					}
+				},
+				"required": [
+					"source",
+					"target"
+				]
+			},
+			"RuleGroup": {
+				"description": "Group of rules for extraction.",
+				"type": "object",
+				"properties": {
+					"id": {
+						"type": "string",
+						"description": "The id for the rule group."
+					},
+					"label": {
+						"type": "string",
+						"description": "The label for the rule group."
+					},
+					"rules": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/Rule"
+						},
+						"description": "The rules."
+					}
+				},
+				"required": [
+					"id",
+					"label",
+					"rules"
+				]
+			}
+		},
+		"securitySchemes": {
+			"jwtBearerAuthScheme": {
+				"type": "http",
+				"scheme": "bearer",
+				"bearerFormat": "JWT"
+			}
+		}
+	}
+}