{ "openapi": "3.1.0", "info": { "title": "Data product portal", "summary": "Backend API implementation for Data product portal", "version": "0.8.0" }, "paths": { "/api/v2/authz/access/{action}": { "get": { "tags": [ "Authorization" ], "summary": "Check Access", "description": "Allows the requesting user to check whether an access check will fail or succeed.\nUseful to conditionally disable parts of the UI that are known to be inaccessible.", "operationId": "check_access", "parameters": [ { "name": "action", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AuthorizationAction" } }, { "name": "resource", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Resource" } }, { "name": "domain", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Domain" } } ], "responses": { "200": { "description": "Access check result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessResponse", "type": "object", "properties": { "access": { "type": "boolean" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/admin": { "get": { "tags": [ "Authorization" ], "summary": "Is Admin", "operationId": "is_admin", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IsAdminResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/search/output_ports": { "get": { "tags": [ "Search Output ports" ], "summary": "Search Output Ports", "operationId": "search_output_ports", "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "string", "minLength": 3, "title": "Query" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "assignment_filter", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AssignmentFilter", "default": "all" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchOutputPortsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/query_stats": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Output Port Query Stats", "operationId": "get_output_port_query_stats", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "granularity", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/QueryStatsGranularity", "default": "week" } }, { "name": "day_range", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 3650, "minimum": 1, "default": 90, "title": "Day Range" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortQueryStatsResponses" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Data Products - Output ports" ], "summary": "Update Output Port Query Stats", "description": "Upsert daily query counts for this output port, one entry per day and consuming data product. Existing counts for the same day and consuming data product are overwritten, so sending the same data twice is safe. If a request contains the same day and consuming data product more than once, the last entry is used.", "operationId": "update_output_port_query_stats", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutputPortQueryStatus" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Data Products - Output ports" ], "summary": "Delete Output Port Query Stat", "description": "Delete the query count of one consuming data product for one day.", "operationId": "delete_output_port_query_stat", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortQueryStatsDelete" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/curated_queries": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Output Port Curated Queries", "operationId": "get_output_port_curated_queries", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortCuratedQueries" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Data Products - Output ports" ], "summary": "Replace Output Port Curated Queries", "operationId": "replace_output_port_curated_queries", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortCuratedQueriesUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortCuratedQueries" } } } }, "404": { "description": "Dataset not found", "content": { "application/json": { "example": { "detail": "Dataset id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/data_quality_summary": { "get": { "tags": [ "Data Products - Output ports", "Data Products - Output Ports - Data Quality" ], "summary": "Get Latest Data Quality Summary For Output Port", "operationId": "get_latest_data_quality_summary_for_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortDataQualitySummaryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Data Products - Output ports", "Data Products - Output Ports - Data Quality" ], "summary": "Add Output Port Data Quality Run", "operationId": "add_output_port_data_quality_run", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortDataQualitySummary" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortDataQualitySummaryResponse" } } } }, "404": { "description": "Output Port not found", "content": { "application/json": { "example": { "detail": "Output Port ID not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/data_quality_summary/{summary_id}": { "put": { "tags": [ "Data Products - Output ports", "Data Products - Output Ports - Data Quality" ], "summary": "Overwrite Output Port Data Quality Summary", "operationId": "overwrite_output_port_data_quality_summary", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "summary_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Summary Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortDataQualitySummary" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortDataQualitySummaryResponse" } } } }, "404": { "description": "Output Port or Summary not found", "content": { "application/json": { "example": { "detail": "Not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/data_contract": { "get": { "tags": [ "Data Products - Output ports", "Data Products - Output Ports - Contract" ], "summary": "Get Output Port Schema", "operationId": "get_output_port_schema", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortSchemaResponse" } } } }, "404": { "description": "Output Port not found", "content": { "application/json": { "example": { "detail": "Output Port ID not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Data Products - Output ports", "Data Products - Output Ports - Contract" ], "summary": "Ingest Output Port Contract", "operationId": "ingest_output_port_contract", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BitolContractRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortSchemaResponse" } } } }, "404": { "description": "Output Port not found", "content": { "application/json": { "example": { "detail": "Output Port ID not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/data_contract/upload": { "post": { "tags": [ "Data Products - Output ports", "Data Products - Output Ports - Contract" ], "summary": "Ingest Output Port Contract Yaml", "operationId": "ingest_output_port_contract_yaml", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "title": "File" } } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortSchemaResponse" } } } }, "404": { "description": "Output Port not found", "content": { "application/json": { "example": { "detail": "Output Port ID not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Data Product Output Ports", "operationId": "get_data_product_output_ports", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataProductOutputPortsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Data Products - Output ports" ], "summary": "Create Output Port", "operationId": "create_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutputPortResponse" } } } }, "404": { "description": "Owner not found", "content": { "application/json": { "example": { "detail": "User email for owner not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Output Port", "operationId": "get_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOutputPortResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Data Products - Output ports" ], "summary": "Remove Output Port", "operationId": "remove_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Dataset not found", "content": { "application/json": { "example": { "detail": "Dataset id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Data Products - Output ports" ], "summary": "Update Output Port", "operationId": "update_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutputPortResponse" } } } }, "404": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/history": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Output Ports Event History", "operationId": "get_output_ports_event_history", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/about": { "put": { "tags": [ "Data Products - Output ports" ], "summary": "Update Output Port About", "operationId": "update_output_port_about", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortAboutUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/status": { "put": { "tags": [ "Data Products - Output ports" ], "summary": "Update Output Port Status", "operationId": "update_output_port_status", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/graph": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Output Port Graph Data", "operationId": "get_output_port_graph_data", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "integer", "default": 3, "title": "Level" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Graph" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/settings/{setting_id}": { "post": { "tags": [ "Data Products - Output ports" ], "summary": "Set Value For Output Port", "operationId": "set_value_for_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "setting_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Setting Id" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string", "title": "Value" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{id}/access_durations": { "get": { "tags": [ "Data Products - Output ports" ], "summary": "Get Output Port Access Durations", "operationId": "get_output_port_access_durations", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOutputPortAccessDurationsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products": { "post": { "tags": [ "Data Products" ], "summary": "Create Data Product", "operationId": "create_data_product", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataProductResponse" } } } }, "404": { "description": "Owner not found", "content": { "application/json": { "example": { "detail": "User id for owner not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Data Products" ], "summary": "Get Data Products", "operationId": "get_data_products", "parameters": [ { "name": "assignment_filter", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/AssignmentFilter", "default": "all" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataProductsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}": { "delete": { "tags": [ "Data Products" ], "summary": "Remove Data Product", "operationId": "remove_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Data Product deleted", "content": { "application/json": { "schema": {} } } }, "202": { "description": "Data Product marked for deletion, waiting for finalizers" }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Data Products" ], "summary": "Update Data Product", "operationId": "update_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataProductResponse" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Data Products" ], "summary": "Get Data Product", "operationId": "get_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataProductResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/finalizers": { "post": { "tags": [ "Data Products" ], "summary": "Add Data Product Finalizer", "operationId": "add_data_product_finalizer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalizerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/finalizers/{finalizer}": { "delete": { "tags": [ "Data Products" ], "summary": "Remove Data Product Finalizer", "operationId": "remove_data_product_finalizer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "finalizer", "in": "path", "required": true, "schema": { "type": "string", "title": "Finalizer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/about": { "put": { "tags": [ "Data Products" ], "summary": "Update Data Product About", "operationId": "update_data_product_about", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductAboutUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/status": { "put": { "tags": [ "Data Products" ], "summary": "Update Data Product Status", "operationId": "update_data_product_status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/usage": { "put": { "tags": [ "Data Products" ], "summary": "Update Data Product Usage", "operationId": "update_data_product_usage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductUsageUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/graph": { "get": { "tags": [ "Data Products" ], "summary": "Get Data Product Graph Data", "operationId": "get_data_product_graph_data", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "integer", "default": 3, "title": "Level" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Graph" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/settings/{setting_id}": { "post": { "tags": [ "Data Products" ], "summary": "Set Value For Data Product", "operationId": "set_value_for_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "setting_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Setting Id" } }, { "name": "value", "in": "query", "required": true, "schema": { "type": "string", "title": "Value" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/input_ports": { "post": { "tags": [ "Data Products" ], "summary": "Request Input Ports For Data Product", "operationId": "request_input_ports_for_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestInputPortsForDataProductRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestInputPortsForDataProductResponse" } } } }, "400": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port not found" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Data Products" ], "summary": "Get Data Product Input Ports", "operationId": "get_data_product_input_ports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataProductInputPortsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/input_ports/{output_port_id}/renew": { "post": { "tags": [ "Data Products" ], "summary": "Renew Input Port For Data Product", "operationId": "renew_input_port_for_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewInputPortForDataProductResponse" } } } }, "400": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port not found" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/input_ports/{output_port_id}/revoke": { "post": { "tags": [ "Data Products" ], "summary": "Revoke Input Port For Data Product", "operationId": "revoke_input_port_for_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeInputPortForDataProductResponse" } } } }, "400": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port not found" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/history": { "get": { "tags": [ "Data Products" ], "summary": "Get Data Product Event History", "operationId": "get_data_product_event_history", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/rolled_up_tags": { "get": { "tags": [ "Data Products" ], "summary": "Get Data Product Rolled Up Tags", "operationId": "get_data_product_rolled_up_tags", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataProductRolledUpTagsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/input_ports/{output_port_id}/cancel": { "post": { "tags": [ "Data Products" ], "summary": "Cancel Input Port For Data Product", "operationId": "cancel_input_port_for_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelInputPortForDataProductResponse" } } } }, "400": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port not found" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/input_ports/{output_port_id}": { "delete": { "tags": [ "Data Products" ], "summary": "Remove Input Port For Data Product", "operationId": "remove_input_port_for_data_product", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Output port not found", "content": { "application/json": { "example": { "detail": "Output port not found" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{id}/settings": { "get": { "tags": [ "Data Products" ], "summary": "Get Data Product Settings", "operationId": "get_data_product_settings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDataProductSettingsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_types/{id}": { "get": { "tags": [ "Configuration - Data Product types" ], "summary": "Get Data Product Type", "operationId": "get_data_product_type", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductTypeGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Configuration - Data Product types" ], "summary": "Update Data Product Type", "operationId": "update_data_product_type", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductTypeUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataProductTypeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Data Product types" ], "summary": "Remove Data Product Type", "operationId": "remove_data_product_type", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_types": { "get": { "tags": [ "Configuration - Data Product types" ], "summary": "Get Data Products Types", "operationId": "get_data_products_types", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductTypesGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Data Product types" ], "summary": "Create Data Product Type", "operationId": "create_data_product_type", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductTypeCreate" } } }, "required": true }, "responses": { "200": { "description": "Data Product successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataProductTypeResponse" }, "example": { "id": "random id of the new data product" } } } }, "404": { "description": "Owner not found", "content": { "application/json": { "example": { "detail": "User id for owner not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_types/migrate/{from_id}/{to_id}": { "put": { "tags": [ "Configuration - Data Product types" ], "summary": "Migrate Data Product Type", "operationId": "migrate_data_product_type", "parameters": [ { "name": "from_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "From Id" } }, { "name": "to_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "To Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_lifecycles": { "get": { "tags": [ "Configuration - Data Product lifecycles" ], "summary": "Get Data Products Lifecycles", "operationId": "get_data_products_lifecycles", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductLifeCyclesGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Data Product lifecycles" ], "summary": "Create Data Product Lifecycle", "operationId": "create_data_product_lifecycle", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductLifeCycleCreate" } } }, "required": true }, "responses": { "200": { "description": "Data Product successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataProductLifeCycleResponse" }, "example": { "id": "random id of the new data product" } } } }, "404": { "description": "Owner not found", "content": { "application/json": { "example": { "detail": "User id for owner not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_lifecycles/{id}": { "put": { "tags": [ "Configuration - Data Product lifecycles" ], "summary": "Update Data Product Lifecycle", "operationId": "update_data_product_lifecycle", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductLifeCycleUpdate" } } } }, "responses": { "200": { "description": "Data Product lifecycle updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataProductLifeCycleResponse" }, "example": { "id": "random id of the updated data product lifecycle" } } } }, "404": { "description": "Owner not found", "content": { "application/json": { "example": { "detail": "User id for owner not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Data Product lifecycles" ], "summary": "Remove Data Product Lifecycle", "operationId": "remove_data_product_lifecycle", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/output_port_access_types": { "get": { "tags": [ "Configuration - Output Port access types" ], "summary": "Get Output Port Access Types", "operationId": "get_output_port_access_types", "parameters": [ { "name": "include_output_port_count", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Output Port Count" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortAccessTypesGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Output Port access types" ], "summary": "Create Output Port Access Type", "operationId": "create_output_port_access_type", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortAccessTypeCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutputPortAccessTypeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/output_port_access_types/{id}": { "put": { "tags": [ "Configuration - Output Port access types" ], "summary": "Update Output Port Access Type", "operationId": "update_output_port_access_type", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortAccessTypeUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOutputPortAccessTypeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Output Port access types" ], "summary": "Remove Output Port Access Type", "operationId": "remove_output_port_access_type", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_settings": { "get": { "tags": [ "Configuration - Data Product settings" ], "summary": "Get Data Products Settings", "operationId": "get_data_products_settings", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductSettingsGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Data Product settings" ], "summary": "Create Data Product Setting", "operationId": "create_data_product_setting", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductSettingCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataProductSettingResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/data_product_settings/{id}": { "put": { "tags": [ "Configuration - Data Product settings" ], "summary": "Update Data Product Setting", "operationId": "update_data_product_setting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductSettingUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataProductSettingResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Data Product settings" ], "summary": "Remove Data Product Setting", "operationId": "remove_data_product_setting", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/access_modes": { "get": { "tags": [ "Configuration - Access Modes" ], "summary": "Get Access Modes", "operationId": "get_access_modes", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccessModes" } } } }, "400": { "description": "Cannot remove the specified technical asset types because they are in use by technical assets or input port requests.", "content": { "application/json": { "example": { "detail": "Cannot remove the specified technical asset types because they are in use by technical assets or input port requests." } } } }, "404": { "description": "Access mode not found", "content": { "application/json": { "example": { "detail": "Access mode not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Access Modes" ], "summary": "Create Access Mode", "operationId": "create_access_mode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessModeCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessMode" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/access_modes/{id}": { "put": { "tags": [ "Configuration - Access Modes" ], "summary": "Update Access Mode", "operationId": "update_access_mode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessModeUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessMode" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Access Modes" ], "summary": "Delete Access Mode", "operationId": "delete_access_mode", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Cannot remove the specified access mode because it is in use by technical assets or input port requests.", "content": { "application/json": { "example": { "detail": "Cannot remove the specified access mode because it is in use by technical assets or input port requests." } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/grant": { "post": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Grant Output Port Access", "operationId": "grant_output_port_access", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GrantOutputPortAccessRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/": { "get": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Get Input Ports For Output Port", "operationId": "get_input_ports_for_output_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInputPortsForOutputPortResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/approve": { "post": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Approve Output Port As Input Port", "operationId": "approve_output_port_as_input_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveOutputPortAsInputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/deny": { "post": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Deny Output Port As Input Port", "operationId": "deny_output_port_as_input_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DenyOutputPortAsInputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/renew": { "post": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Renew Output Port As Input Port", "operationId": "renew_output_port_as_input_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewOutputPortAsInputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/revoke": { "post": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Revoke Output Port As Input Port", "operationId": "revoke_output_port_as_input_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeOutputPortAsInputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/input_ports/remove": { "post": { "tags": [ "Data Products - Output ports - Input ports" ], "summary": "Remove Output Port As Input Port", "operationId": "remove_output_port_as_input_port", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveOutputPortAsInputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/technical_assets/approve_link_request": { "post": { "tags": [ "Data Products - Technical assets" ], "summary": "Approve Output Port Technical Asset Link", "operationId": "approve_output_port_technical_asset_link", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveLinkBetweenTechnicalAssetAndOutputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Possible errors", "content": { "application/json": { "examples": { "cannot_link_technical_asset_that_is_not_active": { "value": { "detail": "Cannot link technical asset that is not active" } }, "technical_asset_already_exists_in_output_port": { "value": { "detail": "Technical Asset already exists in output port" } } } } } }, "409": { "description": "Possible errors", "content": { "application/json": { "examples": { "access_modes_of_technical_asset_are_incompatible_with_access_modes_of_output_port": { "value": { "detail": "Access modes of technical asset are incompatible with access modes of output port" } }, "technical_assets_of_this_type_are_not_shareable_and_cannot_be_linked_to_an_output_port": { "value": { "detail": "Technical assets of this type are not shareable and cannot be linked to an Output Port" } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/technical_assets/deny_link_request": { "post": { "tags": [ "Data Products - Technical assets" ], "summary": "Deny Output Port Technical Asset Link", "operationId": "deny_output_port_technical_asset_link", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DenyLinkBetweenTechnicalAssetAndOutputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/technical_assets/add": { "post": { "tags": [ "Data Products - Technical assets" ], "summary": "Link Output Port To Technical Asset", "operationId": "link_output_port_to_technical_asset", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkTechnicalAssetToOutputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkTechnicalAssetsToOutputPortResponse" } } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "409": { "description": "Technical assets of this type are not shareable and cannot be linked to an Output Port", "content": { "application/json": { "example": { "detail": "Technical assets of this type are not shareable and cannot be linked to an Output Port" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/output_ports/{output_port_id}/technical_assets/remove": { "delete": { "tags": [ "Data Products - Technical assets" ], "summary": "Unlink Output Port From Technical Asset", "operationId": "unlink_output_port_from_technical_asset", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnLinkTechnicalAssetToOutputPortRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Data Product not found", "content": { "application/json": { "example": { "detail": "Data Product id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/technical_assets/": { "get": { "tags": [ "Data Products - Technical assets" ], "summary": "Get Data Product Technical Assets", "operationId": "get_data_product_technical_assets", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTechnicalAssetsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Data Products - Technical assets" ], "summary": "Create Technical Asset", "operationId": "create_technical_asset", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTechnicalAssetRequest" } } } }, "responses": { "200": { "description": "Technical asset successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTechnicalAssetResponse" }, "example": { "id": "random id of the new technical asset" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/technical_assets/{id}": { "get": { "tags": [ "Data Products - Technical assets" ], "summary": "Get Technical Asset", "operationId": "get_technical_asset", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTechnicalAssetsResponseItem" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Data Products - Technical assets" ], "summary": "Remove Technical Asset", "operationId": "remove_technical_asset", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Technical asset not found", "content": { "application/json": { "example": { "detail": "Technical asset id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Data Products - Technical assets" ], "summary": "Update Technical Asset", "operationId": "update_technical_asset", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalAssetUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTechnicalAssetResponse" } } } }, "404": { "description": "Technical asset not found", "content": { "application/json": { "example": { "detail": "Technical asset id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/technical_assets/{id}/history": { "get": { "tags": [ "Data Products - Technical assets" ], "summary": "Get Technical Asset Event History", "operationId": "get_technical_asset_event_history", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetEventHistoryResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/technical_assets/{id}/status": { "put": { "tags": [ "Data Products - Technical assets" ], "summary": "Update Technical Asset Status", "operationId": "update_technical_asset_status", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalAssetStatusUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Data Output not found", "content": { "application/json": { "example": { "detail": "Data Output id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/data_products/{data_product_id}/technical_assets/{id}/graph": { "get": { "tags": [ "Data Products - Technical assets" ], "summary": "Get Technical Asset Graph Data", "operationId": "get_technical_asset_graph_data", "parameters": [ { "name": "data_product_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "integer", "default": 3, "title": "Level" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Graph" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/domains": { "get": { "tags": [ "Configuration - Domains" ], "summary": "Get Domains", "operationId": "get_domains", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDomainsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Domains" ], "summary": "Create Domain", "operationId": "create_domain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCreate" } } }, "required": true }, "responses": { "200": { "description": "Domain successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDomainResponse" }, "example": { "id": "random id of the new domain" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/domains/{id}": { "put": { "tags": [ "Configuration - Domains" ], "summary": "Update Domain", "operationId": "update_domain", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDomainResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Domains" ], "summary": "Remove Domain", "operationId": "remove_domain", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Domain deleted", "content": { "application/json": { "schema": {} } } }, "202": { "description": "Domain marked for deletion, waiting for finalizers" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Configuration - Domains" ], "summary": "Get Domain", "operationId": "get_domain", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDomainResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/domains/{id}/finalizers": { "post": { "tags": [ "Configuration - Domains" ], "summary": "Add Domain Finalizer", "operationId": "add_domain_finalizer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalizerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/domains/{id}/finalizers/{finalizer}": { "delete": { "tags": [ "Configuration - Domains" ], "summary": "Remove Domain Finalizer", "operationId": "remove_domain_finalizer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "finalizer", "in": "path", "required": true, "schema": { "type": "string", "title": "Finalizer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/domains/migrate/{from_id}/{to_id}": { "put": { "tags": [ "Configuration - Domains" ], "summary": "Migrate Domain", "operationId": "migrate_domain", "parameters": [ { "name": "from_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "From Id" } }, { "name": "to_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "To Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments/{id}": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environment", "operationId": "get_environment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Environment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Configuration - Environments" ], "summary": "Update Environment Is Global", "operationId": "update_environment_is_global", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentUpdateGlobal" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Environment" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments/configs/{config_id}": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environment Configs By Id", "operationId": "get_environment_configs_by_id", "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentConfigsGetItem" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments/{id}/platforms/{platform_id}/services/{service_id}/config": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environment Platform Service Config", "operationId": "get_environment_platform_service_config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "platform_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Platform Id" } }, { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Service Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentConfigsGetItem" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments/{id}/platforms/{platform_id}/config": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environment Platform Config", "operationId": "get_environment_platform_config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "platform_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Platform Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentPlatformConfigGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environments", "operationId": "get_environments", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments/{id}/configs": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environment Configs", "operationId": "get_environment_configs", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentConfigsGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/environments/platforms/{platform_id}/services/{service_id}/config": { "get": { "tags": [ "Configuration - Environments" ], "summary": "Get Environment Platform Service Config For All Envs", "operationId": "get_environment_platform_service_config_for_all_envs", "parameters": [ { "name": "platform_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Platform Id" } }, { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Service Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentConfigsGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/platforms/{id}/services/{service_id}": { "get": { "tags": [ "Configuration - Platforms" ], "summary": "Get Platform Service Config", "description": "Get Platform Service config", "operationId": "get_platform_service_config", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "service_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Service Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformServiceConfiguration" } } } }, "404": { "description": "Platform service configuration not found", "content": { "application/json": { "example": { "detail": "Platform service configuration not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/platforms/configs/{config_id}": { "get": { "tags": [ "Configuration - Platforms" ], "summary": "Get Single Platform Service Configuration", "operationId": "get_single_platform_service_configuration", "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Config Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformServiceConfiguration" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/platforms/configs": { "get": { "tags": [ "Configuration - Platforms" ], "summary": "Get All Platform Service Configurations", "operationId": "get_all_platform_service_configurations", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllPlatformServiceConfigurationsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/platforms": { "get": { "tags": [ "Configuration - Platforms" ], "summary": "Get All Platforms", "operationId": "get_all_platforms", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllPlatformsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/platforms/{id}/services": { "get": { "tags": [ "Configuration - Platforms" ], "summary": "Get Platform Services", "operationId": "get_platform_services", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPlatformServicesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/tags": { "get": { "tags": [ "Configuration - Tags" ], "summary": "Get Tags", "operationId": "get_tags", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagsGet" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Configuration - Tags" ], "summary": "Create Tag", "operationId": "create_tag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/tags/{id}": { "put": { "tags": [ "Configuration - Tags" ], "summary": "Update Tag", "operationId": "update_tag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Configuration - Tags" ], "summary": "Remove Tag", "operationId": "remove_tag", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users": { "get": { "tags": [ "Users" ], "summary": "Get Users", "operationId": "get_users", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUsersResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Users" ], "summary": "Create User", "operationId": "create_user", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } }, "required": true }, "responses": { "200": { "description": "User successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreateResponse" }, "example": { "id": "random id of the new user" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/batch": { "post": { "tags": [ "Users" ], "summary": "Create Users Batch", "operationId": "create_users_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchCreateRequest_UserCreate_" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Users" ], "summary": "Remove Users Batch", "operationId": "remove_users_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchDeleteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/set_can_become_admin": { "put": { "tags": [ "Users" ], "summary": "Set Can Become Admin", "operationId": "set_can_become_admin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanBecomeAdminUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current": { "get": { "tags": [ "Users" ], "summary": "Get Current User", "operationId": "get_current_user", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/groups": { "get": { "tags": [ "Users" ], "summary": "Get Current User Groups", "operationId": "get_current_user_groups", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsGetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/my_requests": { "get": { "tags": [ "Users" ], "summary": "Get User Requests", "operationId": "get_user_requests", "parameters": [ { "name": "hide_old_inactive", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Filter out inactive requests older than 30 days", "default": true, "title": "Hide Old Inactive" }, "description": "Filter out inactive requests older than 30 days" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyRequestsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/pending_actions": { "get": { "tags": [ "Users" ], "summary": "Get User Pending Actions", "operationId": "get_user_pending_actions", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingActionResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/seen_tour": { "post": { "tags": [ "Users" ], "summary": "Mark Tour As Seen", "operationId": "mark_tour_as_seen", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/{id}/groups": { "get": { "tags": [ "Users" ], "summary": "Get User Groups", "operationId": "get_user_groups", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsGetResponse" } } } }, "404": { "description": "User not found", "content": { "application/json": { "example": { "detail": "User not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/{id}": { "delete": { "tags": [ "Users" ], "summary": "Remove User", "operationId": "remove_user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "User not found", "content": { "application/json": { "example": { "detail": "User not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/roles": { "post": { "tags": [ "Authorization - Roles" ], "summary": "Create Role", "operationId": "create_role", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRole" } } }, "required": true }, "responses": { "200": { "description": "Role successfully created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" }, "example": { "id": "random id of the new role" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/roles/{id}": { "delete": { "tags": [ "Authorization - Roles" ], "summary": "Remove Role", "operationId": "remove_role", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "404": { "description": "Role not found", "content": { "application/json": { "example": { "detail": "Role not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Authorization - Roles" ], "summary": "Update Role", "operationId": "update_role", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRole" } } } }, "responses": { "200": { "description": "Role successfully updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" }, "example": { "id": "id of the updated role" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/roles/{scope}": { "get": { "tags": [ "Authorization - Roles" ], "summary": "Get Roles", "operationId": "get_roles", "parameters": [ { "name": "scope", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Scope" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRolesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/global/become_admin": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Become Admin", "operationId": "become_admin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BecomeAdmin" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/global/revoke_admin": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Revoke Admin", "operationId": "revoke_admin", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/global": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Create Global Role Assignment", "operationId": "create_global_role_assignment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGlobalRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Authorization - Role assignments" ], "summary": "List Global Role Assignments", "operationId": "list_global_role_assignments", "parameters": [ { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "User Id" } }, { "name": "role_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Role Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListGlobalRoleAssignmentsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/global/{id}": { "delete": { "tags": [ "Authorization - Role assignments" ], "summary": "Delete Global Role Assignment", "operationId": "delete_global_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteGlobalRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/global/{id}/decide": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Decide Global Role Assignment", "operationId": "decide_global_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideGlobalRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/global/{id}/role": { "put": { "tags": [ "Authorization - Role assignments" ], "summary": "Modify Global Role Assignment", "operationId": "modify_global_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyGlobalRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/data_product/{id}": { "delete": { "tags": [ "Authorization - Role assignments" ], "summary": "Delete Data Product Role Assignment", "operationId": "delete_data_product_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDataProductRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Authorization - Role assignments" ], "summary": "Modify Data Product Role Assignment", "operationId": "modify_data_product_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyDataProductRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/data_product": { "get": { "tags": [ "Authorization - Role assignments" ], "summary": "List Data Product Role Assignments", "operationId": "list_data_product_role_assignments", "parameters": [ { "name": "data_product_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "User Id" } }, { "name": "role_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Role Id" } }, { "name": "decision", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/DecisionStatus" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDataProductRoleAssignmentsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Create Data Product Role Assignment", "operationId": "create_data_product_role_assignment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataProductRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/data_product/request": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Request Data Product Role Assignment", "operationId": "request_data_product_role_assignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestDataProductRoleAssignment" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/data_product/{id}/decide": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Decide Data Product Role Assignment", "operationId": "decide_data_product_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideDataProductRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataProductRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/output_port/{id}": { "delete": { "tags": [ "Authorization - Role assignments" ], "summary": "Delete Output Port Role Assignment", "operationId": "delete_output_port_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOutputPortRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Authorization - Role assignments" ], "summary": "Modify Output Port Role Assignment", "operationId": "modify_output_port_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyOutputPortRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/output_port": { "get": { "tags": [ "Authorization - Role assignments" ], "summary": "List Output Port Role Assignments", "operationId": "list_output_port_role_assignments", "parameters": [ { "name": "output_port_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } }, { "name": "user_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "User Id" } }, { "name": "role_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Role Id" } }, { "name": "decision", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/DecisionStatus" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOutputPortRoleAssignmentsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Create Output Port Role Assignment", "operationId": "create_output_port_role_assignment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutputPortRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/output_port/request": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Request Output Port Role Assignment", "operationId": "request_output_port_role_assignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestOutputPortRoleAssignment" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authz/role_assignments/output_port/{id}/decide": { "post": { "tags": [ "Authorization - Role assignments" ], "summary": "Decide Output Port Role Assignment", "operationId": "decide_output_port_role_assignment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecideOutputPortRoleAssignment" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutputPortRoleAssignmentResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/theme_settings": { "get": { "tags": [ "Configuration - Theme settings" ], "summary": "Get Theme Settings", "operationId": "get_theme_settings", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettings" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Configuration - Theme settings" ], "summary": "Update Theme Settings", "operationId": "update_theme_settings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeSettings" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/graph": { "get": { "tags": [ "Graph" ], "summary": "Get Graph Data", "operationId": "get_graph_data", "parameters": [ { "name": "output_port_nodes_enabled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Output Port Nodes Enabled" } }, { "name": "exploration_nodes_enabled", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Exploration Nodes Enabled" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Graph" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/notifications/all": { "delete": { "tags": [ "Users - Notifications" ], "summary": "Remove All User Notifications", "operationId": "remove_all_user_notifications", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/notifications/{id}": { "delete": { "tags": [ "Users - Notifications" ], "summary": "Remove User Notification", "operationId": "remove_user_notification", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/users/current/notifications": { "get": { "tags": [ "Users - Notifications" ], "summary": "Get User Notifications", "operationId": "get_user_notifications", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetUserNotificationsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/resource_names/sanitize": { "get": { "tags": [ "Resource names" ], "summary": "Sanitize Resource Name", "operationId": "sanitize_resource_name", "parameters": [ { "name": "name", "in": "query", "required": true, "schema": { "type": "string", "title": "Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNameSuggestion" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/resource_names/validate": { "get": { "tags": [ "Resource names" ], "summary": "Validate Resource Name", "operationId": "validate_resource_name", "parameters": [ { "name": "resource_name", "in": "query", "required": true, "schema": { "type": "string", "title": "Resource Name" } }, { "name": "model", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ResourceNameModel" } }, { "name": "data_product_id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Data Product Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNameValidation" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/resource_names/constraints": { "get": { "tags": [ "Resource names" ], "summary": "Resource Name Constraints", "operationId": "resource_name_constraints", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNameLengthLimits" } } } } } } }, "/api/v2/plugins/platform-tiles": { "get": { "tags": [ "Plugins" ], "summary": "Get Platform Tiles", "operationId": "get_platform_tiles", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformTileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/plugins/": { "get": { "tags": [ "Plugins" ], "summary": "Get Plugins", "description": "List all available plugins with their metadata (ADR-compliant endpoint)", "operationId": "get_plugins", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/plugins/{plugin_name}/form": { "get": { "tags": [ "Plugins" ], "summary": "Get Plugin Form", "description": "Get form metadata for a specific plugin (ADR-compliant endpoint)", "operationId": "get_plugin_form", "parameters": [ { "name": "plugin_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Plugin Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UIElementMetadataResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/plugins/{plugin_name}/url": { "get": { "tags": [ "Plugins" ], "summary": "Get Plugin Url", "description": "Get the URL for the access tile of a specific plugin", "operationId": "get_plugin_url", "parameters": [ { "name": "plugin_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Plugin Name" } }, { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "environment", "in": "query", "required": false, "schema": { "type": "string", "title": "Environment" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/plugins/render_technical_asset_access_path": { "post": { "tags": [ "Plugins" ], "summary": "Render Technical Asset Access Path", "operationId": "render_technical_asset_access_path", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderTechnicalAssetAccessPathRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderTechnicalAssetAccessPathResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations": { "get": { "tags": [ "Explorations" ], "summary": "Get Explorations", "operationId": "get_explorations", "parameters": [ { "name": "filter_to_user_with_assigment", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "title": "Filter To User With Assigment" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExplorationsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Explorations" ], "summary": "Create Exploration", "operationId": "create_exploration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExplorationRequestWithInputPorts" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExplorationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}": { "get": { "tags": [ "Explorations" ], "summary": "Get Exploration", "operationId": "get_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExplorationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Explorations" ], "summary": "Remove Exploration", "operationId": "remove_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Exploration deleted", "content": { "application/json": { "schema": {} } } }, "202": { "description": "Exploration marked for deletion, waiting for finalizers" }, "404": { "description": "Exploration not found", "content": { "application/json": { "example": { "detail": "Exploration id not found" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/input_ports": { "get": { "tags": [ "Explorations" ], "summary": "Get Exploration Input Ports", "operationId": "get_exploration_input_ports", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExplorationInputPortsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Explorations" ], "summary": "Request Input Ports For Exploration", "operationId": "request_input_ports_for_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestInputPortsForExplorationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestInputPortsForExplorationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/input_ports/{output_port_id}/renew": { "post": { "tags": [ "Explorations" ], "summary": "Renew Input Port For Exploration", "operationId": "renew_input_port_for_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenewInputPortForExplorationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/input_ports/{output_port_id}/revoke": { "post": { "tags": [ "Explorations" ], "summary": "Revoke Input Port For Exploration", "operationId": "revoke_input_port_for_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeInputPortForExplorationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/input_ports/{output_port_id}/cancel": { "post": { "tags": [ "Explorations" ], "summary": "Cancel Input Port For Exploration", "operationId": "cancel_input_port_for_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelInputPortForExplorationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/input_ports/{output_port_id}": { "delete": { "tags": [ "Explorations" ], "summary": "Remove Input Port For Exploration", "operationId": "remove_input_port_for_exploration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "output_port_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Output Port Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/finalizers": { "post": { "tags": [ "Explorations" ], "summary": "Add Exploration Finalizer", "operationId": "add_exploration_finalizer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalizerRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/explorations/{id}/finalizers/{finalizer}": { "delete": { "tags": [ "Explorations" ], "summary": "Remove Exploration Finalizer", "operationId": "remove_exploration_finalizer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } }, { "name": "finalizer", "in": "path", "required": true, "schema": { "type": "string", "title": "Finalizer" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/access_durations/enabled": { "get": { "tags": [ "Configuration - Access Durations" ], "summary": "Is Time Bound Access Enabled", "operationId": "is_time_bound_access_enabled", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeBoundAccessEnabledResponse" } } } } } } }, "/api/v2/configuration/access_durations/expiring_soon_threshold": { "get": { "tags": [ "Configuration - Access Durations" ], "summary": "Get Expiring Soon Threshold", "operationId": "get_expiring_soon_threshold", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpiringSoonThresholdResponse" } } } } } } }, "/api/v2/configuration/access_durations/{abstract_data_product_type}/default": { "get": { "tags": [ "Configuration - Access Durations" ], "summary": "Get Default Access Duration", "operationId": "get_default_access_duration", "parameters": [ { "name": "abstract_data_product_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AbstractDataProductType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessDuration" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/access_durations": { "get": { "tags": [ "Configuration - Access Durations" ], "summary": "Get All Access Durations", "operationId": "get_all_access_durations", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAccessDurationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/configuration/access_durations/{abstract_data_product_type}": { "put": { "tags": [ "Configuration - Access Durations" ], "summary": "Update Access Duration", "operationId": "update_access_duration", "parameters": [ { "name": "abstract_data_product_type", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/AbstractDataProductType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessDurationUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessDurationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/groups": { "get": { "tags": [ "Groups" ], "summary": "Get Groups", "operationId": "get_groups", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupsGetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Groups" ], "summary": "Create Group", "operationId": "create_group", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreateResponse" } } } }, "400": { "description": "Group external ID already exists", "content": { "application/json": { "example": { "detail": "A group with this external ID already exists." } } } }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/groups/{id}": { "get": { "tags": [ "Groups" ], "summary": "Get Group", "operationId": "get_group", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupGet" } } } }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Groups" ], "summary": "Update Group", "operationId": "update_group", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUpdateResponse" } } } }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete Group", "operationId": "delete_group", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/groups/batch": { "post": { "tags": [ "Groups" ], "summary": "Create Groups Batch", "operationId": "create_groups_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchCreateRequest_GroupCreate_" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete Groups Batch", "operationId": "delete_groups_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchDeleteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/groups/{id}/members": { "get": { "tags": [ "Groups" ], "summary": "Get Group Members", "operationId": "get_group_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembershipsGetResponse" } } } }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Groups" ], "summary": "Add Group Members", "operationId": "add_group_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembersAdd" } } } }, "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Invalid group member identities", "content": { "application/json": { "example": { "detail": "All member identities must exist and be users or machine users." } } } }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Groups" ], "summary": "Replace Group Members", "operationId": "replace_group_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembersReplace" } } } }, "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Invalid group member identities", "content": { "application/json": { "example": { "detail": "All member identities must exist and be users or machine users." } } } }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Groups" ], "summary": "Remove Group Members", "operationId": "remove_group_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupMembersRemove" } } } }, "responses": { "204": { "description": "Successful Response" }, "404": { "description": "Group not found", "content": { "application/json": { "example": { "detail": "Required group does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/machine-users": { "get": { "tags": [ "Machine Users" ], "summary": "Get Machine Users", "operationId": "get_machine_users", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineUsersGetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Machine Users" ], "summary": "Create Machine User", "operationId": "create_machine_user", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineUserCreate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineUserCreateResponse" } } } }, "400": { "description": "Machine user external ID already exists", "content": { "application/json": { "example": { "detail": "A machine user with this external ID already exists." } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/machine-users/{id}": { "get": { "tags": [ "Machine Users" ], "summary": "Get Machine User", "operationId": "get_machine_user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineUserGet" } } } }, "404": { "description": "Machine user not found", "content": { "application/json": { "example": { "detail": "Required machine user does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Machine Users" ], "summary": "Update Machine User", "operationId": "update_machine_user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineUserUpdate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MachineUserUpdateResponse" } } } }, "404": { "description": "Machine user not found", "content": { "application/json": { "example": { "detail": "Required machine user does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Machine Users" ], "summary": "Delete Machine User", "operationId": "delete_machine_user", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "204": { "description": "Successful Response" }, "404": { "description": "Machine user not found", "content": { "application/json": { "example": { "detail": "Required machine user does not exist" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/machine-users/batch": { "post": { "tags": [ "Machine Users" ], "summary": "Create Machine Users Batch", "operationId": "create_machine_users_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchCreateRequest_MachineUserCreate_" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchCreateResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Machine Users" ], "summary": "Delete Machine Users Batch", "operationId": "delete_machine_users_batch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityBatchDeleteRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authn/device/device_token": { "post": { "tags": [ "Authentication" ], "summary": "Get Device Token", "operationId": "get_device_token", "security": [ { "HTTPBasic": [] } ], "parameters": [ { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string", "deprecated": true, "default": "", "title": "Client Id" }, "deprecated": true }, { "name": "scope", "in": "query", "required": false, "schema": { "type": "string", "default": "openid", "title": "Scope" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceFlow" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authn/device/jwt_token": { "post": { "tags": [ "Authentication" ], "summary": "Get Jwt Token", "operationId": "get_jwt_token", "security": [ { "HTTPBasic": [] } ], "parameters": [ { "name": "device_code", "in": "query", "required": true, "schema": { "type": "string", "title": "Device Code" } }, { "name": "grant_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Grant Type" } }, { "name": "client_id", "in": "query", "required": false, "schema": { "type": "string", "deprecated": true, "default": "", "title": "Client Id" }, "deprecated": true } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OIDCTokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/authn/aws_credentials": { "get": { "tags": [ "Authentication" ], "summary": "Get Aws Credentials", "operationId": "get_aws_credentials", "parameters": [ { "name": "data_product_name", "in": "query", "required": true, "schema": { "type": "string", "title": "Data Product Name" } }, { "name": "environment", "in": "query", "required": true, "schema": { "type": "string", "title": "Environment" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AWSCredentials" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/api/v2/version": { "get": { "tags": [ "Version" ], "summary": "Get Version", "operationId": "get_version", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } } } } }, "webhooks": { "v2_event_stream": { "post": { "summary": "Event Stream Webhook", "description": "The primary webhook subscription target.Receives a real-time event stream wrapped in a CloudEvents 1.0 envelope.Inspect the `type` field to distinguish between payload formats.", "operationId": "event_stream", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CloudEvent_ExplorationEvent" }, { "$ref": "#/components/schemas/CloudEvent_DataProductEvent" }, { "$ref": "#/components/schemas/CloudEvent_DataProductEnvironmentAddedEvent" }, { "$ref": "#/components/schemas/CloudEvent_InputPortEvent" }, { "$ref": "#/components/schemas/CloudEvent_DataProductRoleAssignmentEvent" }, { "$ref": "#/components/schemas/CloudEvent_OutputPortRoleAssignmentEvent" }, { "$ref": "#/components/schemas/CloudEvent_TechnicalAssetEvent" }, { "$ref": "#/components/schemas/CloudEvent_OutputPortEvent" }, { "$ref": "#/components/schemas/CloudEvent_OutputPortTechnicalAssetLinkEvent" }, { "$ref": "#/components/schemas/CloudEvent_DataProductSettingValueEvent" }, { "$ref": "#/components/schemas/CloudEvent_DomainEvent" } ], "title": "Body", "discriminator": { "propertyName": "type", "mapping": { "exploration.event": "#/components/schemas/CloudEvent_ExplorationEvent", "data_product.event": "#/components/schemas/CloudEvent_DataProductEvent", "data_product.environment_added": "#/components/schemas/CloudEvent_DataProductEnvironmentAddedEvent", "input_port.event": "#/components/schemas/CloudEvent_InputPortEvent", "data_product_role_assignment.event": "#/components/schemas/CloudEvent_DataProductRoleAssignmentEvent", "output_port_role_assignment.event": "#/components/schemas/CloudEvent_OutputPortRoleAssignmentEvent", "technical_asset.event": "#/components/schemas/CloudEvent_TechnicalAssetEvent", "output_port.event": "#/components/schemas/CloudEvent_OutputPortEvent", "output_port_technical_asset_link.event": "#/components/schemas/CloudEvent_OutputPortTechnicalAssetLinkEvent", "data_product_setting_value.event": "#/components/schemas/CloudEvent_DataProductSettingValueEvent", "domain.event": "#/components/schemas/CloudEvent_DomainEvent" } } } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AWSCredentials": { "properties": { "AccessKeyId": { "type": "string", "title": "Accesskeyid" }, "SecretAccessKey": { "type": "string", "title": "Secretaccesskey" }, "SessionToken": { "type": "string", "title": "Sessiontoken" }, "Expiration": { "type": "string", "format": "date-time", "title": "Expiration" } }, "type": "object", "required": [ "AccessKeyId", "SecretAccessKey", "SessionToken", "Expiration" ], "title": "AWSCredentials" }, "AWSEnvironmentPlatformConfiguration": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "region": { "type": "string", "title": "Region" }, "can_read_from": { "items": { "type": "string" }, "type": "array", "title": "Can Read From" } }, "type": "object", "required": [ "account_id", "region", "can_read_from" ], "title": "AWSEnvironmentPlatformConfiguration" }, "AWSGlueConfig": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "database_name": { "type": "string", "title": "Database Name" }, "bucket_identifier": { "type": "string", "title": "Bucket Identifier" }, "s3_path": { "type": "string", "title": "S3 Path" }, "athena_workgroup_template": { "type": "string", "title": "Athena Workgroup Template", "default": "" } }, "type": "object", "required": [ "identifier", "database_name", "bucket_identifier", "s3_path" ], "title": "AWSGlueConfig" }, "AWSS3Config": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "bucket_arn": { "type": "string", "title": "Bucket Arn" }, "kms_key_arn": { "type": "string", "title": "Kms Key Arn" }, "is_default": { "type": "boolean", "title": "Is Default" } }, "type": "object", "required": [ "identifier", "bucket_name", "bucket_arn", "kms_key_arn", "is_default" ], "title": "AWSS3Config" }, "AbstractDataProductInfo": { "properties": { "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "abstract_data_product_type": { "$ref": "#/components/schemas/AbstractDataProductType" }, "is_redacted": { "type": "boolean", "title": "Is Redacted" } }, "type": "object", "required": [ "name", "namespace", "abstract_data_product_type", "is_redacted" ], "title": "AbstractDataProductInfo" }, "AbstractDataProductInputPort": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "status": { "$ref": "#/components/schemas/InputPortStatus" }, "current_request": { "$ref": "#/components/schemas/InputPortRequestBase" }, "renewal_status": { "anyOf": [ { "$ref": "#/components/schemas/RenewalStatus" }, { "type": "null" } ] }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "output_port": { "$ref": "#/components/schemas/OutputPort" } }, "type": "object", "required": [ "id", "status", "current_request", "output_port_id", "output_port" ], "title": "AbstractDataProductInputPort" }, "AbstractDataProductStatus": { "type": "string", "enum": [ "pending", "active", "archived", "deleting" ], "title": "AbstractDataProductStatus" }, "AbstractDataProductType": { "type": "string", "enum": [ "unknown", "data_products", "explorations" ], "title": "AbstractDataProductType" }, "AccessDuration": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "abstract_data_product_type": { "$ref": "#/components/schemas/AbstractDataProductType" }, "access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Days" }, "is_default": { "type": "boolean", "title": "Is Default" } }, "type": "object", "required": [ "id", "abstract_data_product_type", "access_duration_type", "days", "is_default" ], "title": "AccessDuration" }, "AccessDurationType": { "type": "string", "enum": [ "permanent", "time_bound" ], "title": "AccessDurationType" }, "AccessDurationUpdate": { "properties": { "access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Days" }, "alternative_allowed": { "type": "boolean", "title": "Alternative Allowed" }, "alternative_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Alternative Days" } }, "type": "object", "required": [ "access_duration_type", "alternative_allowed" ], "title": "AccessDurationUpdate" }, "AccessMode": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "id", "name", "description" ], "title": "AccessMode" }, "AccessModeCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "technical_asset_types": { "items": { "type": "string" }, "type": "array", "title": "Technical Asset Types" } }, "type": "object", "required": [ "name", "description", "technical_asset_types" ], "title": "AccessModeCreate" }, "AccessModeUpdate": { "properties": { "description": { "type": "string", "title": "Description" }, "technical_asset_types": { "items": { "type": "string" }, "type": "array", "title": "Technical Asset Types" } }, "type": "object", "required": [ "description", "technical_asset_types" ], "title": "AccessModeUpdate" }, "AccessModeWithType": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "technical_asset_types": { "items": { "type": "string" }, "type": "array", "title": "Technical Asset Types" } }, "type": "object", "required": [ "id", "name", "description", "technical_asset_types" ], "title": "AccessModeWithType" }, "AccessResponse": { "properties": { "allowed": { "type": "boolean", "title": "Allowed" } }, "type": "object", "required": [ "allowed" ], "title": "AccessResponse" }, "ApproveLinkBetweenTechnicalAssetAndOutputPortRequest": { "properties": { "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" } }, "type": "object", "required": [ "technical_asset_id" ], "title": "ApproveLinkBetweenTechnicalAssetAndOutputPortRequest" }, "ApproveOutputPortAsInputPortRequest": { "properties": { "consuming_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Data Product Id" }, "decision_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Note" } }, "type": "object", "required": [ "consuming_data_product_id" ], "title": "ApproveOutputPortAsInputPortRequest" }, "AssignmentFilter": { "type": "string", "enum": [ "all", "only_assigned" ], "title": "AssignmentFilter" }, "AuthorizationAction": { "type": "integer", "enum": [ 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 901, 902 ], "title": "AuthorizationAction", "description": "The integer values for the authorization actions are stored directly in the DB.\nThis means you can change the name of the actions, but not their integer values.\nThe values for the actions are spaced on purpose, to make it easier to extend.\nThis has no technical benefit, but it makes it easier to read for developers." }, "AzureBlobConfig": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "storage_account_names": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Storage Account Names" } }, "type": "object", "required": [ "identifier", "storage_account_names" ], "title": "AzureBlobConfig" }, "AzureEnvironmentPlatformConfiguration": { "properties": { "tenant_id": { "type": "string", "title": "Tenant Id" }, "subscription_id": { "type": "string", "title": "Subscription Id" }, "region": { "type": "string", "title": "Region" } }, "type": "object", "required": [ "tenant_id", "subscription_id", "region" ], "title": "AzureEnvironmentPlatformConfiguration" }, "BecomeAdmin": { "properties": { "expiry": { "type": "string", "title": "Expiry" } }, "type": "object", "required": [ "expiry" ], "title": "BecomeAdmin" }, "BitolContractRequest": { "properties": { "schema": { "items": { "$ref": "#/components/schemas/SchemaObjectRequest" }, "type": "array", "title": "Schema", "default": [] } }, "type": "object", "title": "BitolContractRequest", "description": "Accepts a BitOL data contract (https://bitol-io.github.io/open-data-contract-standard/).\nOnly the `schema` section is extracted; all other fields are ignored." }, "CanBecomeAdminUpdate": { "properties": { "user_id": { "type": "string", "title": "User Id" }, "can_become_admin": { "type": "boolean", "title": "Can Become Admin" } }, "type": "object", "required": [ "user_id", "can_become_admin" ], "title": "CanBecomeAdminUpdate" }, "CancelInputPortForDataProductResponse": { "properties": { "input_port_link": { "type": "string", "format": "uuid", "title": "Input Port Link" } }, "type": "object", "required": [ "input_port_link" ], "title": "CancelInputPortForDataProductResponse" }, "CancelInputPortForExplorationResponse": { "properties": { "input_port_id": { "type": "string", "format": "uuid", "title": "Input Port Id" } }, "type": "object", "required": [ "input_port_id" ], "title": "CancelInputPortForExplorationResponse" }, "CloudEvent_DataProductEnvironmentAddedEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "data_product.environment_added", "title": "Type", "description": "The unique type string belonging to this event.", "default": "data_product.environment_added" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/DataProductEnvironmentAddedEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_DataProductEnvironmentAddedEvent" }, "CloudEvent_DataProductEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "data_product.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "data_product.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/DataProductEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_DataProductEvent" }, "CloudEvent_DataProductRoleAssignmentEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "data_product_role_assignment.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "data_product_role_assignment.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/DataProductRoleAssignmentEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_DataProductRoleAssignmentEvent" }, "CloudEvent_DataProductSettingValueEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "data_product_setting_value.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "data_product_setting_value.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/DataProductSettingValueEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_DataProductSettingValueEvent" }, "CloudEvent_DomainEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "domain.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "domain.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/DomainEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_DomainEvent" }, "CloudEvent_ExplorationEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "exploration.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "exploration.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/ExplorationEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_ExplorationEvent" }, "CloudEvent_InputPortEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "input_port.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "input_port.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/InputPortEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_InputPortEvent" }, "CloudEvent_OutputPortEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "output_port.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "output_port.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/OutputPortEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_OutputPortEvent" }, "CloudEvent_OutputPortRoleAssignmentEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "output_port_role_assignment.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "output_port_role_assignment.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/OutputPortRoleAssignmentEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_OutputPortRoleAssignmentEvent" }, "CloudEvent_OutputPortTechnicalAssetLinkEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "output_port_technical_asset_link.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "output_port_technical_asset_link.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/OutputPortTechnicalAssetLinkEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_OutputPortTechnicalAssetLinkEvent" }, "CloudEvent_TechnicalAssetEvent": { "properties": { "specversion": { "type": "string", "title": "Specversion", "description": "The CloudEvents specification version.", "default": "1.0" }, "id": { "type": "string", "title": "Id", "description": "A unique UUID identifier for this specific event instance." }, "source": { "type": "string", "title": "Source", "description": "Identifies the context in which an event happened.", "default": "data-product-portal" }, "type": { "type": "string", "const": "technical_asset.event", "title": "Type", "description": "The unique type string belonging to this event.", "default": "technical_asset.event" }, "time": { "type": "string", "title": "Time", "description": "Timestamp of when the event occurred in ISO 8601 UTC format." }, "data": { "$ref": "#/components/schemas/TechnicalAssetEvent", "description": "The specific data payload corresponding to this event type." } }, "type": "object", "required": [ "id", "time", "data" ], "title": "CloudEvent_TechnicalAssetEvent" }, "CreateDataProductLifeCycleResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateDataProductLifeCycleResponse" }, "CreateDataProductResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateDataProductResponse" }, "CreateDataProductRoleAssignment": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role_id": { "type": "string", "format": "uuid", "title": "Role Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "user_id", "role_id", "data_product_id" ], "title": "CreateDataProductRoleAssignment" }, "CreateDataProductSettingResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateDataProductSettingResponse" }, "CreateDataProductTypeResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateDataProductTypeResponse" }, "CreateDomainResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateDomainResponse" }, "CreateExplorationRequestWithInputPorts": { "properties": { "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "domain_id": { "type": "string", "format": "uuid", "title": "Domain Id" }, "input_ports": { "anyOf": [ { "$ref": "#/components/schemas/RequestInputPortsForExplorationRequest" }, { "type": "null" } ] } }, "type": "object", "required": [ "name", "namespace", "description", "domain_id" ], "title": "CreateExplorationRequestWithInputPorts" }, "CreateExplorationResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "domain": { "$ref": "#/components/schemas/Domain" }, "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "domain", "status", "finalizers" ], "title": "CreateExplorationResponse" }, "CreateGlobalRoleAssignment": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string", "const": "admin" } ], "title": "Role Id" } }, "type": "object", "required": [ "user_id", "role_id" ], "title": "CreateGlobalRoleAssignment" }, "CreateOutputPortAccessTypeResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateOutputPortAccessTypeResponse" }, "CreateOutputPortRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "access_type_id": { "type": "string", "format": "uuid", "title": "Access Type Id" }, "data_product_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "exploration_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About" }, "lifecycle_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Lifecycle Id" }, "tag_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tag Ids" }, "owners": { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1, "title": "Owners" } }, "type": "object", "required": [ "name", "namespace", "description", "access_type_id", "data_product_access_duration_type", "exploration_access_duration_type", "tag_ids", "owners" ], "title": "CreateOutputPortRequest" }, "CreateOutputPortResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateOutputPortResponse" }, "CreateOutputPortRoleAssignment": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role_id": { "type": "string", "format": "uuid", "title": "Role Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" } }, "type": "object", "required": [ "user_id", "role_id", "output_port_id" ], "title": "CreateOutputPortRoleAssignment" }, "CreateRole": { "properties": { "name": { "type": "string", "title": "Name" }, "scope": { "$ref": "#/components/schemas/Scope" }, "description": { "type": "string", "title": "Description" }, "permissions": { "items": { "$ref": "#/components/schemas/AuthorizationAction" }, "type": "array", "title": "Permissions" } }, "type": "object", "required": [ "name", "scope", "description", "permissions" ], "title": "CreateRole" }, "CreateTagResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateTagResponse" }, "CreateTechnicalAssetRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "namespace": { "type": "string", "title": "Namespace" }, "platform_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Platform Id" }, "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Service Id" }, "configuration": { "properties": { "name": { "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "Configuration", "description": "Configuration of the technical asset. The available fields depend on `name`; retrieve them from /v2/plugins/{name}/form." }, "sourceAligned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Sourcealigned", "description": "DEPRECATED: Use 'technical_mapping' instead. This field will be removed in a future version.", "deprecated": true }, "technical_mapping": { "anyOf": [ { "$ref": "#/components/schemas/TechnicalMapping" }, { "type": "null" } ] }, "access_mode_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Access Mode Ids", "default": [] }, "tag_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tag Ids" } }, "type": "object", "required": [ "name", "description", "namespace", "configuration", "tag_ids" ], "title": "CreateTechnicalAssetRequest" }, "CreateTechnicalAssetResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "CreateTechnicalAssetResponse" }, "DataProduct": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" }, "type": { "$ref": "#/components/schemas/DataProductType" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "status", "type" ], "title": "DataProduct" }, "DataProductAboutUpdate": { "properties": { "about": { "type": "string", "title": "About" } }, "type": "object", "required": [ "about" ], "title": "DataProductAboutUpdate" }, "DataProductCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "type_id": { "type": "string", "format": "uuid", "title": "Type Id" }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About" }, "domain_id": { "type": "string", "format": "uuid", "title": "Domain Id" }, "tag_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tag Ids", "default": [] }, "lifecycle_id": { "type": "string", "format": "uuid", "title": "Lifecycle Id" }, "environment_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Environment Ids" }, "visibility": { "$ref": "#/components/schemas/DataProductVisibility", "default": "discoverable" }, "owners": { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1, "title": "Owners" }, "input_ports": { "anyOf": [ { "$ref": "#/components/schemas/RequestInputPortsForDataProductRequest" }, { "type": "null" } ] } }, "type": "object", "required": [ "name", "namespace", "description", "type_id", "domain_id", "lifecycle_id", "owners" ], "title": "DataProductCreate" }, "DataProductEnvironment": { "properties": { "environment_id": { "type": "string", "format": "uuid", "title": "Environment Id" }, "environment": { "$ref": "#/components/schemas/EnvironmentGetItem" }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date" } }, "type": "object", "required": [ "environment_id", "environment", "creation_date" ], "title": "DataProductEnvironment" }, "DataProductEnvironmentAddedEvent": { "properties": { "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "environment": { "type": "string", "title": "Environment" }, "creation_date": { "type": "string", "format": "date-time", "title": "Creation Date" } }, "type": "object", "required": [ "data_product_id", "environment", "creation_date" ], "title": "DataProductEnvironmentAddedEvent" }, "DataProductEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "DataProductEvent" }, "DataProductIconKey": { "type": "string", "enum": [ "reporting", "processing", "exploration", "ingestion", "machine_learning", "analytics", "default" ], "title": "DataProductIconKey" }, "DataProductLifeCycle": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "value": { "type": "integer", "title": "Value" }, "color": { "type": "string", "title": "Color" }, "is_default": { "type": "boolean", "title": "Is Default" } }, "type": "object", "required": [ "id", "name", "value", "color", "is_default" ], "title": "DataProductLifeCycle" }, "DataProductLifeCycleCreate": { "properties": { "value": { "type": "integer", "title": "Value" }, "name": { "type": "string", "title": "Name" }, "color": { "type": "string", "title": "Color" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false } }, "type": "object", "required": [ "value", "name", "color" ], "title": "DataProductLifeCycleCreate" }, "DataProductLifeCycleUpdate": { "properties": { "value": { "type": "integer", "title": "Value" }, "name": { "type": "string", "title": "Name" }, "color": { "type": "string", "title": "Color" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false } }, "type": "object", "required": [ "value", "name", "color" ], "title": "DataProductLifeCycleUpdate" }, "DataProductLifeCyclesGet": { "properties": { "data_product_life_cycles": { "items": { "$ref": "#/components/schemas/DataProductLifeCyclesGetItem" }, "type": "array", "title": "Data Product Life Cycles" } }, "type": "object", "required": [ "data_product_life_cycles" ], "title": "DataProductLifeCyclesGet" }, "DataProductLifeCyclesGetItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "value": { "type": "integer", "title": "Value" }, "name": { "type": "string", "title": "Name" }, "color": { "type": "string", "title": "Color" }, "is_default": { "type": "boolean", "title": "Is Default" } }, "type": "object", "required": [ "id", "value", "name", "color", "is_default" ], "title": "DataProductLifeCyclesGetItem" }, "DataProductRoleAssignmentEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" } }, "type": "object", "required": [ "id", "data_product_id", "user_id" ], "title": "DataProductRoleAssignmentEvent", "description": "Fired on insert, update, and delete of a data-product role assignment." }, "DataProductRoleAssignmentRequest": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product": { "$ref": "#/components/schemas/DataProduct" }, "user": { "$ref": "#/components/schemas/User" }, "role": { "anyOf": [ { "$ref": "#/components/schemas/Role" }, { "type": "null" } ] }, "decision": { "$ref": "#/components/schemas/DecisionStatus" }, "requested_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Requested On" }, "requested_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "decided_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided On" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "request_type": { "type": "string", "const": "DataProductRoleAssignment", "title": "Request Type", "default": "DataProductRoleAssignment" } }, "type": "object", "required": [ "id", "data_product", "user", "role", "decision", "requested_on", "requested_by", "decided_on", "decided_by" ], "title": "DataProductRoleAssignmentRequest" }, "DataProductRoleAssignmentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product": { "$ref": "#/components/schemas/DataProduct" }, "user": { "$ref": "#/components/schemas/User" }, "role": { "anyOf": [ { "$ref": "#/components/schemas/Role" }, { "type": "null" } ] }, "decision": { "$ref": "#/components/schemas/DecisionStatus" }, "requested_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Requested On" }, "requested_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "decided_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided On" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "data_product", "user", "role", "decision", "requested_on", "requested_by", "decided_on", "decided_by" ], "title": "DataProductRoleAssignmentResponse" }, "DataProductSetting": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "category": { "type": "string", "title": "Category" }, "type": { "$ref": "#/components/schemas/DataProductSettingType" }, "tooltip": { "type": "string", "title": "Tooltip" }, "namespace": { "type": "string", "title": "Namespace" }, "name": { "type": "string", "title": "Name" }, "default": { "type": "string", "title": "Default" }, "order": { "type": "integer", "title": "Order", "default": 100 }, "scope": { "$ref": "#/components/schemas/DataProductSettingScope" } }, "type": "object", "required": [ "id", "category", "type", "tooltip", "namespace", "name", "default", "scope" ], "title": "DataProductSetting" }, "DataProductSettingCreate": { "properties": { "category": { "type": "string", "title": "Category" }, "type": { "$ref": "#/components/schemas/DataProductSettingType" }, "tooltip": { "type": "string", "title": "Tooltip" }, "namespace": { "type": "string", "title": "Namespace" }, "name": { "type": "string", "title": "Name" }, "default": { "type": "string", "title": "Default" }, "order": { "type": "integer", "title": "Order", "default": 100 }, "scope": { "$ref": "#/components/schemas/DataProductSettingScope" } }, "type": "object", "required": [ "category", "type", "tooltip", "namespace", "name", "default", "scope" ], "title": "DataProductSettingCreate" }, "DataProductSettingScope": { "type": "string", "enum": [ "dataproduct", "dataset" ], "title": "DataProductSettingScope" }, "DataProductSettingType": { "type": "string", "enum": [ "checkbox", "tags", "input" ], "title": "DataProductSettingType" }, "DataProductSettingUpdate": { "properties": { "category": { "type": "string", "title": "Category" }, "type": { "$ref": "#/components/schemas/DataProductSettingType" }, "tooltip": { "type": "string", "title": "Tooltip" }, "namespace": { "type": "string", "title": "Namespace" }, "name": { "type": "string", "title": "Name" }, "default": { "type": "string", "title": "Default" }, "order": { "type": "integer", "title": "Order", "default": 100 }, "scope": { "$ref": "#/components/schemas/DataProductSettingScope" } }, "type": "object", "required": [ "category", "type", "tooltip", "namespace", "name", "default", "scope" ], "title": "DataProductSettingUpdate" }, "DataProductSettingValue": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_setting_id": { "type": "string", "format": "uuid", "title": "Data Product Setting Id" }, "value": { "type": "string", "title": "Value" }, "data_product_setting": { "$ref": "#/components/schemas/DataProductSetting" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "id", "data_product_setting_id", "value", "data_product_setting", "data_product_id" ], "title": "DataProductSettingValue" }, "DataProductSettingValueEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "id", "data_product_id" ], "title": "DataProductSettingValueEvent" }, "DataProductSettingsGet": { "properties": { "data_product_settings": { "items": { "$ref": "#/components/schemas/DataProductSettingsGetItem" }, "type": "array", "title": "Data Product Settings" } }, "type": "object", "required": [ "data_product_settings" ], "title": "DataProductSettingsGet" }, "DataProductSettingsGetItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "category": { "type": "string", "title": "Category" }, "type": { "$ref": "#/components/schemas/DataProductSettingType" }, "tooltip": { "type": "string", "title": "Tooltip" }, "namespace": { "type": "string", "title": "Namespace" }, "name": { "type": "string", "title": "Name" }, "default": { "type": "string", "title": "Default" }, "order": { "type": "integer", "title": "Order", "default": 100 }, "scope": { "$ref": "#/components/schemas/DataProductSettingScope" } }, "type": "object", "required": [ "id", "category", "type", "tooltip", "namespace", "name", "default", "scope" ], "title": "DataProductSettingsGetItem" }, "DataProductStatusUpdate": { "properties": { "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" } }, "type": "object", "required": [ "status" ], "title": "DataProductStatusUpdate" }, "DataProductType": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "icon_key": { "$ref": "#/components/schemas/DataProductIconKey" } }, "type": "object", "required": [ "id", "name", "description", "icon_key" ], "title": "DataProductType" }, "DataProductTypeCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "icon_key": { "$ref": "#/components/schemas/DataProductIconKey" } }, "type": "object", "required": [ "name", "description", "icon_key" ], "title": "DataProductTypeCreate" }, "DataProductTypeGet": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "icon_key": { "$ref": "#/components/schemas/DataProductIconKey" }, "data_products": { "items": { "$ref": "#/components/schemas/DataProduct" }, "type": "array", "title": "Data Products" } }, "type": "object", "required": [ "id", "name", "description", "icon_key", "data_products" ], "title": "DataProductTypeGet" }, "DataProductTypeUpdate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "icon_key": { "$ref": "#/components/schemas/DataProductIconKey" } }, "type": "object", "required": [ "name", "description", "icon_key" ], "title": "DataProductTypeUpdate" }, "DataProductTypesGet": { "properties": { "data_product_types": { "items": { "$ref": "#/components/schemas/DataProductTypesGetItem" }, "type": "array", "title": "Data Product Types" } }, "type": "object", "required": [ "data_product_types" ], "title": "DataProductTypesGet" }, "DataProductTypesGetItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "icon_key": { "$ref": "#/components/schemas/DataProductIconKey" }, "data_product_count": { "type": "integer", "title": "Data Product Count" } }, "type": "object", "required": [ "id", "name", "description", "icon_key", "data_product_count" ], "title": "DataProductTypesGetItem" }, "DataProductUpdate": { "properties": { "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "type_id": { "type": "string", "format": "uuid", "title": "Type Id" }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About" }, "domain_id": { "type": "string", "format": "uuid", "title": "Domain Id" }, "tag_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tag Ids", "default": [] }, "lifecycle_id": { "type": "string", "format": "uuid", "title": "Lifecycle Id" }, "environment_ids": { "anyOf": [ { "items": { "type": "string", "format": "uuid" }, "type": "array", "minItems": 1 }, { "type": "null" } ], "title": "Environment Ids" } }, "type": "object", "required": [ "name", "namespace", "description", "type_id", "domain_id", "lifecycle_id" ], "title": "DataProductUpdate" }, "DataProductUsageUpdate": { "properties": { "usage": { "type": "string", "title": "Usage" } }, "type": "object", "required": [ "usage" ], "title": "DataProductUsageUpdate" }, "DataProductVisibility": { "type": "string", "enum": [ "hidden", "discoverable" ], "title": "DataProductVisibility" }, "DataQualityStatus": { "type": "string", "enum": [ "success", "failure", "warning", "error", "unknown" ], "title": "DataQualityStatus" }, "DataQualityTechnicalAsset": { "properties": { "name": { "type": "string", "title": "Name" }, "status": { "$ref": "#/components/schemas/DataQualityStatus" } }, "type": "object", "required": [ "name", "status" ], "title": "DataQualityTechnicalAsset" }, "DatabricksConfig": { "properties": { "identifier": { "type": "string", "title": "Identifier" } }, "additionalProperties": false, "type": "object", "required": [ "identifier" ], "title": "DatabricksConfig" }, "DatabricksEnvironmentPlatformConfiguration": { "properties": { "workspace_urls": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Workspace Urls" }, "account_id": { "type": "string", "title": "Account Id" }, "metastore_id": { "type": "string", "title": "Metastore Id" }, "credential_name": { "type": "string", "title": "Credential Name" } }, "type": "object", "required": [ "workspace_urls", "account_id", "metastore_id", "credential_name" ], "title": "DatabricksEnvironmentPlatformConfiguration" }, "DecideDataProductRoleAssignment": { "properties": { "decision": { "$ref": "#/components/schemas/DecisionStatus" } }, "type": "object", "required": [ "decision" ], "title": "DecideDataProductRoleAssignment" }, "DecideGlobalRoleAssignment": { "properties": { "decision": { "$ref": "#/components/schemas/DecisionStatus" } }, "type": "object", "required": [ "decision" ], "title": "DecideGlobalRoleAssignment" }, "DecideOutputPortRoleAssignment": { "properties": { "decision": { "$ref": "#/components/schemas/DecisionStatus" } }, "type": "object", "required": [ "decision" ], "title": "DecideOutputPortRoleAssignment" }, "DecisionStatus": { "type": "string", "enum": [ "approved", "pending", "denied" ], "title": "DecisionStatus" }, "DeleteDataProductRoleAssignmentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "id", "data_product_id" ], "title": "DeleteDataProductRoleAssignmentResponse" }, "DeleteGlobalRoleAssignmentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "DeleteGlobalRoleAssignmentResponse" }, "DeleteOutputPortRoleAssignmentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" } }, "type": "object", "required": [ "id", "output_port_id" ], "title": "DeleteOutputPortRoleAssignmentResponse" }, "DenyLinkBetweenTechnicalAssetAndOutputPortRequest": { "properties": { "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" } }, "type": "object", "required": [ "technical_asset_id" ], "title": "DenyLinkBetweenTechnicalAssetAndOutputPortRequest" }, "DenyOutputPortAsInputPortRequest": { "properties": { "consuming_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Data Product Id" }, "decision_note": { "type": "string", "title": "Decision Note" } }, "type": "object", "required": [ "consuming_data_product_id", "decision_note" ], "title": "DenyOutputPortAsInputPortRequest" }, "DeviceFlow": { "properties": { "device_code": { "type": "string", "format": "uuid", "title": "Device Code" }, "user_code": { "type": "string", "title": "User Code" }, "scope": { "type": "string", "title": "Scope" }, "interval": { "type": "integer", "title": "Interval" }, "expiration": { "type": "integer", "title": "Expiration" }, "oidc_redirect_uri": { "type": "string", "title": "Oidc Redirect Uri" }, "status": { "$ref": "#/components/schemas/DeviceFlowStatus" }, "authz_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authz Code" }, "authz_state": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authz State" }, "authz_verif": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authz Verif" }, "verification_uri_complete": { "type": "string", "title": "Verification Uri Complete", "default": "" } }, "type": "object", "required": [ "device_code", "user_code", "scope", "interval", "expiration", "oidc_redirect_uri", "status", "authz_code", "authz_state", "authz_verif" ], "title": "DeviceFlow" }, "DeviceFlowStatus": { "type": "string", "enum": [ "authorization_pending", "expired", "denied", "authorized" ], "title": "DeviceFlowStatus" }, "Domain": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "id", "name", "namespace", "description" ], "title": "Domain" }, "DomainCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "namespace": { "type": "string", "title": "Namespace" } }, "type": "object", "required": [ "name", "description", "namespace" ], "title": "DomainCreate" }, "DomainEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "DomainEvent" }, "DomainStatus": { "type": "string", "enum": [ "active", "deleting" ], "title": "DomainStatus" }, "DomainUpdate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" } }, "type": "object", "required": [ "name", "description" ], "title": "DomainUpdate" }, "Edge": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ], "title": "Id" }, "source": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ], "title": "Source" }, "target": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ], "title": "Target" }, "animated": { "type": "boolean", "title": "Animated" }, "sourceHandle": { "type": "string", "title": "Sourcehandle", "default": "right_s" }, "targetHandle": { "type": "string", "title": "Targethandle", "default": "left_t" } }, "type": "object", "required": [ "id", "source", "target", "animated" ], "title": "Edge" }, "Environment": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "acronym": { "type": "string", "title": "Acronym" }, "context": { "type": "string", "title": "Context" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false }, "is_global": { "type": "boolean", "title": "Is Global", "default": true } }, "type": "object", "required": [ "id", "name", "acronym", "context" ], "title": "Environment" }, "EnvironmentConfigsGet": { "properties": { "environment_configs": { "items": { "$ref": "#/components/schemas/EnvironmentConfigsGetItem" }, "type": "array", "title": "Environment Configs" } }, "type": "object", "required": [ "environment_configs" ], "title": "EnvironmentConfigsGet" }, "EnvironmentConfigsGetItem": { "properties": { "config": { "items": { "anyOf": [ { "$ref": "#/components/schemas/AWSS3Config" }, { "$ref": "#/components/schemas/AWSGlueConfig" }, { "$ref": "#/components/schemas/DatabricksConfig" }, { "$ref": "#/components/schemas/SnowflakeConfig" }, { "$ref": "#/components/schemas/RedshiftConfig" }, { "$ref": "#/components/schemas/PostgreSQLConfig" }, { "$ref": "#/components/schemas/AzureBlobConfig" } ] }, "type": "array", "title": "Config" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "platform": { "$ref": "#/components/schemas/Platform" }, "environment": { "$ref": "#/components/schemas/Environment" }, "service": { "$ref": "#/components/schemas/PlatformService" } }, "type": "object", "required": [ "config", "id", "platform", "environment", "service" ], "title": "EnvironmentConfigsGetItem" }, "EnvironmentGetItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "acronym": { "type": "string", "title": "Acronym" }, "context": { "type": "string", "title": "Context" }, "is_default": { "type": "boolean", "title": "Is Default", "default": false }, "is_global": { "type": "boolean", "title": "Is Global", "default": true } }, "type": "object", "required": [ "id", "name", "acronym", "context" ], "title": "EnvironmentGetItem" }, "EnvironmentPlatformConfigGet": { "properties": { "config": { "anyOf": [ { "$ref": "#/components/schemas/AWSEnvironmentPlatformConfiguration" }, { "$ref": "#/components/schemas/DatabricksEnvironmentPlatformConfiguration" }, { "$ref": "#/components/schemas/AzureEnvironmentPlatformConfiguration" } ], "title": "Config" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "environment": { "$ref": "#/components/schemas/Environment" }, "platform": { "$ref": "#/components/schemas/Platform" } }, "type": "object", "required": [ "config", "id", "environment", "platform" ], "title": "EnvironmentPlatformConfigGet" }, "EnvironmentUpdateGlobal": { "properties": { "is_global": { "type": "boolean", "title": "Is Global" } }, "type": "object", "required": [ "is_global" ], "title": "EnvironmentUpdateGlobal" }, "EnvironmentsGet": { "properties": { "environments": { "items": { "$ref": "#/components/schemas/EnvironmentGetItem" }, "type": "array", "title": "Environments" } }, "type": "object", "required": [ "environments" ], "title": "EnvironmentsGet" }, "EventEntityType": { "type": "string", "enum": [ "data_product", "output_port", "technical_asset", "user", "exploration" ], "title": "EventEntityType" }, "ExpiringSoonThresholdResponse": { "properties": { "days": { "type": "integer", "title": "Days" } }, "type": "object", "required": [ "days" ], "title": "ExpiringSoonThresholdResponse" }, "Exploration": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "domain": { "$ref": "#/components/schemas/Domain" }, "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "domain", "status", "finalizers" ], "title": "Exploration" }, "ExplorationEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "ExplorationEvent" }, "FieldDependency": { "properties": { "field_name": { "type": "string", "title": "Field Name" }, "value": { "title": "Value" } }, "type": "object", "required": [ "field_name", "value" ], "title": "FieldDependency", "description": "Represents a field dependency for conditional visibility.\ne.g. if field A has depends_on(field_name=B, value=Y), then field A is only shown when field B has value Y\nIn practice this is often used with checkbox fields having value=True" }, "FinalizerRequest": { "properties": { "finalizer": { "type": "string", "pattern": "^(?:[^/\\s][^/]*)?[^/\\s.](?:[^/]*[^/\\s])?$", "title": "Finalizer" } }, "type": "object", "required": [ "finalizer" ], "title": "FinalizerRequest" }, "GetAccessDurationResponse": { "properties": { "access_durations": { "items": { "$ref": "#/components/schemas/AccessDuration" }, "type": "array", "title": "Access Durations" } }, "type": "object", "required": [ "access_durations" ], "title": "GetAccessDurationResponse" }, "GetAccessModes": { "properties": { "access_modes": { "items": { "$ref": "#/components/schemas/AccessModeWithType" }, "type": "array", "title": "Access Modes" } }, "type": "object", "required": [ "access_modes" ], "title": "GetAccessModes" }, "GetAllPlatformServiceConfigurationsResponse": { "properties": { "platform_service_configurations": { "items": { "$ref": "#/components/schemas/PlatformServiceConfiguration" }, "type": "array", "title": "Platform Service Configurations" } }, "type": "object", "required": [ "platform_service_configurations" ], "title": "GetAllPlatformServiceConfigurationsResponse" }, "GetAllPlatformsResponse": { "properties": { "platforms": { "items": { "$ref": "#/components/schemas/Platform" }, "type": "array", "title": "Platforms" } }, "type": "object", "required": [ "platforms" ], "title": "GetAllPlatformsResponse" }, "GetDataProductInputPortsResponse": { "properties": { "input_ports": { "items": { "$ref": "#/components/schemas/AbstractDataProductInputPort" }, "type": "array", "title": "Input Ports" } }, "type": "object", "required": [ "input_ports" ], "title": "GetDataProductInputPortsResponse" }, "GetDataProductOutputPortsResponse": { "properties": { "output_ports": { "items": { "$ref": "#/components/schemas/OutputPort" }, "type": "array", "title": "Output Ports" } }, "type": "object", "required": [ "output_ports" ], "title": "GetDataProductOutputPortsResponse" }, "GetDataProductResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "namespace": { "type": "string", "title": "Namespace" }, "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "title": "Tags" }, "usage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage" }, "domain": { "$ref": "#/components/schemas/Domain" }, "type": { "$ref": "#/components/schemas/DataProductType" }, "lifecycle": { "anyOf": [ { "$ref": "#/components/schemas/DataProductLifeCycle" }, { "type": "null" } ] }, "visibility": { "$ref": "#/components/schemas/DataProductVisibility" }, "environments": { "items": { "$ref": "#/components/schemas/DataProductEnvironment" }, "type": "array", "title": "Environments" }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About" } }, "type": "object", "required": [ "id", "name", "description", "namespace", "status", "finalizers", "tags", "usage", "domain", "type", "lifecycle", "visibility", "environments", "about" ], "title": "GetDataProductResponse" }, "GetDataProductRolledUpTagsResponse": { "properties": { "rolled_up_tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "uniqueItems": true, "title": "Rolled Up Tags" } }, "type": "object", "required": [ "rolled_up_tags" ], "title": "GetDataProductRolledUpTagsResponse" }, "GetDataProductSettingsResponse": { "properties": { "data_product_settings": { "items": { "$ref": "#/components/schemas/DataProductSettingValue" }, "type": "array", "title": "Data Product Settings" } }, "type": "object", "required": [ "data_product_settings" ], "title": "GetDataProductSettingsResponse" }, "GetDataProductsResponse": { "properties": { "data_products": { "items": { "$ref": "#/components/schemas/GetDataProductsResponseItem" }, "type": "array", "title": "Data Products" } }, "type": "object", "required": [ "data_products" ], "title": "GetDataProductsResponse" }, "GetDataProductsResponseItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "namespace": { "type": "string", "title": "Namespace" }, "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "title": "Tags" }, "usage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage" }, "domain": { "$ref": "#/components/schemas/Domain" }, "type": { "$ref": "#/components/schemas/DataProductType" }, "lifecycle": { "anyOf": [ { "$ref": "#/components/schemas/DataProductLifeCycle" }, { "type": "null" } ] }, "visibility": { "$ref": "#/components/schemas/DataProductVisibility" }, "environments": { "items": { "$ref": "#/components/schemas/DataProductEnvironment" }, "type": "array", "title": "Environments" }, "user_count": { "type": "integer", "title": "User Count" }, "input_port_count": { "type": "integer", "title": "Input Port Count" }, "technical_asset_count": { "type": "integer", "title": "Technical Asset Count" } }, "type": "object", "required": [ "id", "name", "description", "namespace", "status", "finalizers", "tags", "usage", "domain", "type", "lifecycle", "visibility", "environments", "user_count", "input_port_count", "technical_asset_count" ], "title": "GetDataProductsResponseItem" }, "GetDomainResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/DomainStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "status", "finalizers" ], "title": "GetDomainResponse" }, "GetDomainsItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/DomainStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" }, "abstract_data_product_count": { "type": "integer", "title": "Abstract Data Product Count" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "status", "finalizers", "abstract_data_product_count" ], "title": "GetDomainsItem" }, "GetDomainsResponse": { "properties": { "domains": { "items": { "$ref": "#/components/schemas/GetDomainsItem" }, "type": "array", "title": "Domains" } }, "type": "object", "required": [ "domains" ], "title": "GetDomainsResponse" }, "GetEventHistoryResponse": { "properties": { "events": { "items": { "$ref": "#/components/schemas/GetEventHistoryResponseItem" }, "type": "array", "title": "Events" } }, "type": "object", "required": [ "events" ], "title": "GetEventHistoryResponse" }, "GetEventHistoryResponseItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "subject_id": { "type": "string", "format": "uuid", "title": "Subject Id" }, "target_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Target Id" }, "subject_type": { "$ref": "#/components/schemas/EventEntityType" }, "target_type": { "anyOf": [ { "$ref": "#/components/schemas/EventEntityType" }, { "type": "null" } ] }, "actor_id": { "type": "string", "format": "uuid", "title": "Actor Id" }, "created_on": { "type": "string", "format": "date-time", "title": "Created On" }, "deleted_subject_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted Subject Identifier" }, "deleted_target_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted Target Identifier" }, "deleted_actor_identifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted Actor Identifier" }, "actor": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "data_product": { "anyOf": [ { "$ref": "#/components/schemas/DataProduct" }, { "type": "null" } ] }, "user": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "output_port": { "anyOf": [ { "$ref": "#/components/schemas/OutputPort" }, { "type": "null" } ] }, "technical_asset": { "anyOf": [ { "$ref": "#/components/schemas/TechnicalAsset" }, { "type": "null" } ] }, "exploration": { "anyOf": [ { "$ref": "#/components/schemas/Exploration" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "name", "subject_id", "subject_type", "actor_id", "created_on" ], "title": "GetEventHistoryResponseItem" }, "GetExplorationInputPortsResponse": { "properties": { "input_ports": { "items": { "$ref": "#/components/schemas/AbstractDataProductInputPort" }, "type": "array", "title": "Input Ports" } }, "type": "object", "required": [ "input_ports" ], "title": "GetExplorationInputPortsResponse" }, "GetExplorationResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "domain": { "$ref": "#/components/schemas/Domain" }, "status": { "$ref": "#/components/schemas/AbstractDataProductStatus" }, "finalizers": { "items": { "type": "string" }, "type": "array", "title": "Finalizers" }, "owner": { "$ref": "#/components/schemas/User" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "domain", "status", "finalizers", "owner" ], "title": "GetExplorationResponse" }, "GetExplorationsResponse": { "properties": { "explorations": { "items": { "$ref": "#/components/schemas/Exploration" }, "type": "array", "title": "Explorations" } }, "type": "object", "required": [ "explorations" ], "title": "GetExplorationsResponse" }, "GetInputPortsForOutputPortResponse": { "properties": { "input_ports": { "items": { "$ref": "#/components/schemas/OutputPortInputPort" }, "type": "array", "title": "Input Ports" } }, "type": "object", "required": [ "input_ports" ], "title": "GetInputPortsForOutputPortResponse" }, "GetOutputPortAccessDurationsResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_access_duration": { "$ref": "#/components/schemas/OutputPortAccessDuration" }, "exploration_access_duration": { "$ref": "#/components/schemas/OutputPortAccessDuration" } }, "type": "object", "required": [ "id", "data_product_access_duration", "exploration_access_duration" ], "title": "GetOutputPortAccessDurationsResponse" }, "GetOutputPortResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "namespace": { "type": "string", "title": "Namespace" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/OutputPortStatus" }, "usage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage" }, "access_type": { "$ref": "#/components/schemas/OutputPortAccessType" }, "data_product_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "exploration_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "title": "Tags" }, "domain": { "$ref": "#/components/schemas/Domain" }, "lifecycle": { "anyOf": [ { "$ref": "#/components/schemas/DataProductLifeCycle" }, { "type": "null" } ] }, "access_modes": { "items": { "$ref": "#/components/schemas/AccessMode" }, "type": "array", "title": "Access Modes" }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About" }, "rolled_up_tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "uniqueItems": true, "title": "Rolled Up Tags" }, "data_product_settings": { "items": { "$ref": "#/components/schemas/OutputPortSettingValue" }, "type": "array", "title": "Data Product Settings" }, "technical_asset_links": { "items": { "$ref": "#/components/schemas/TechnicalAssetLink" }, "type": "array", "title": "Technical Asset Links" } }, "type": "object", "required": [ "id", "namespace", "name", "description", "status", "usage", "access_type", "data_product_access_duration_type", "exploration_access_duration_type", "data_product_id", "tags", "domain", "lifecycle", "access_modes", "about", "rolled_up_tags", "data_product_settings", "technical_asset_links" ], "title": "GetOutputPortResponse" }, "GetPlatformServicesResponse": { "properties": { "platform_services": { "items": { "$ref": "#/components/schemas/PlatformService" }, "type": "array", "title": "Platform Services" } }, "type": "object", "required": [ "platform_services" ], "title": "GetPlatformServicesResponse" }, "GetRolesResponse": { "properties": { "roles": { "items": { "$ref": "#/components/schemas/Role" }, "type": "array", "title": "Roles" } }, "type": "object", "required": [ "roles" ], "title": "GetRolesResponse" }, "GetTechnicalAssetsResponse": { "properties": { "technical_assets": { "items": { "$ref": "#/components/schemas/GetTechnicalAssetsResponseItem" }, "type": "array", "title": "Technical Assets" } }, "type": "object", "required": [ "technical_assets" ], "title": "GetTechnicalAssetsResponse" }, "GetTechnicalAssetsResponseItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "namespace": { "type": "string", "title": "Namespace" }, "owner_id": { "type": "string", "format": "uuid", "title": "Owner Id" }, "platform_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Platform Id" }, "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Service Id" }, "status": { "$ref": "#/components/schemas/TechnicalAssetStatus" }, "technical_mapping": { "$ref": "#/components/schemas/TechnicalMapping" }, "access_modes": { "items": { "$ref": "#/components/schemas/AccessMode" }, "type": "array", "title": "Access Modes" }, "configuration": { "properties": { "name": { "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "Configuration", "description": "Configuration of the technical asset. The available fields depend on `name`; retrieve them from /v2/plugins/{name}/form." }, "owner": { "$ref": "#/components/schemas/DataProduct" }, "environments": { "items": { "$ref": "#/components/schemas/DataProductEnvironment" }, "type": "array", "title": "Environments" }, "output_port_links": { "items": { "$ref": "#/components/schemas/OutputPortLink" }, "type": "array", "title": "Output Port Links" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "title": "Tags" }, "sourceAligned": { "type": "boolean", "title": "Sourcealigned", "description": "DEPRECATED: Use 'technical_mapping' instead. This field will be removed in a future version." }, "result_string": { "type": "string", "title": "Result String" }, "technical_info": { "items": { "$ref": "#/components/schemas/TechnicalInfo" }, "type": "array", "title": "Technical Info" } }, "type": "object", "required": [ "id", "name", "description", "namespace", "owner_id", "status", "technical_mapping", "access_modes", "configuration", "owner", "environments", "output_port_links", "tags", "sourceAligned", "result_string", "technical_info" ], "title": "GetTechnicalAssetsResponseItem" }, "GetUserNotificationsResponse": { "properties": { "notifications": { "items": { "$ref": "#/components/schemas/GetUserNotificationsResponseItem" }, "type": "array", "title": "Notifications" } }, "type": "object", "required": [ "notifications" ], "title": "GetUserNotificationsResponse" }, "GetUserNotificationsResponseItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "event_id": { "type": "string", "format": "uuid", "title": "Event Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "event": { "$ref": "#/components/schemas/GetEventHistoryResponseItem" }, "user": { "$ref": "#/components/schemas/User" } }, "type": "object", "required": [ "id", "event_id", "user_id", "event", "user" ], "title": "GetUserNotificationsResponseItem" }, "GetUsersResponse": { "properties": { "users": { "items": { "$ref": "#/components/schemas/UsersGet" }, "type": "array", "title": "Users" } }, "type": "object", "required": [ "users" ], "title": "GetUsersResponse" }, "GlobalRoleAssignmentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "user": { "$ref": "#/components/schemas/User" }, "role": { "$ref": "#/components/schemas/Role" }, "decision": { "$ref": "#/components/schemas/DecisionStatus" }, "requested_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Requested On" }, "requested_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "decided_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided On" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "user", "role", "decision", "requested_on", "requested_by", "decided_on", "decided_by" ], "title": "GlobalRoleAssignmentResponse" }, "GrantOutputPortAccessRequest": { "properties": { "consuming_abstract_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Abstract Data Product Id" }, "justification": { "type": "string", "title": "Justification" }, "access_mode_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Access Mode Id" } }, "type": "object", "required": [ "consuming_abstract_data_product_id", "justification" ], "title": "GrantOutputPortAccessRequest" }, "Graph": { "properties": { "edges": { "items": { "$ref": "#/components/schemas/Edge" }, "type": "array", "uniqueItems": true, "title": "Edges" }, "nodes": { "items": { "$ref": "#/components/schemas/Node" }, "type": "array", "uniqueItems": true, "title": "Nodes" } }, "type": "object", "required": [ "edges", "nodes" ], "title": "Graph" }, "GroupCreate": { "properties": { "external_id": { "$ref": "#/components/schemas/NonEmptyStr" }, "display_name": { "$ref": "#/components/schemas/NonEmptyStr" } }, "type": "object", "required": [ "external_id", "display_name" ], "title": "GroupCreate" }, "GroupCreateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "GroupCreateResponse" }, "GroupGet": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "external_id": { "type": "string", "title": "External Id" }, "display_name": { "type": "string", "title": "Display Name" } }, "type": "object", "required": [ "id", "external_id", "display_name" ], "title": "GroupGet" }, "GroupMemberIdentityGet": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "type": { "$ref": "#/components/schemas/IdentityType" }, "external_id": { "type": "string", "title": "External Id" } }, "type": "object", "required": [ "id", "type", "external_id" ], "title": "GroupMemberIdentityGet" }, "GroupMembersAdd": { "properties": { "member_identity_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Member Identity Ids" } }, "type": "object", "required": [ "member_identity_ids" ], "title": "GroupMembersAdd" }, "GroupMembersRemove": { "properties": { "member_identity_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Member Identity Ids" } }, "type": "object", "required": [ "member_identity_ids" ], "title": "GroupMembersRemove" }, "GroupMembersReplace": { "properties": { "member_identity_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Member Identity Ids" } }, "type": "object", "required": [ "member_identity_ids" ], "title": "GroupMembersReplace" }, "GroupMembershipGet": { "properties": { "group_id": { "type": "string", "format": "uuid", "title": "Group Id" }, "member_identity_id": { "type": "string", "format": "uuid", "title": "Member Identity Id" }, "member": { "$ref": "#/components/schemas/GroupMemberIdentityGet" } }, "type": "object", "required": [ "group_id", "member_identity_id", "member" ], "title": "GroupMembershipGet" }, "GroupMembershipsGetResponse": { "properties": { "members": { "items": { "$ref": "#/components/schemas/GroupMembershipGet" }, "type": "array", "title": "Members" } }, "type": "object", "required": [ "members" ], "title": "GroupMembershipsGetResponse" }, "GroupUpdate": { "properties": { "display_name": { "$ref": "#/components/schemas/NonEmptyStr" } }, "additionalProperties": false, "type": "object", "required": [ "display_name" ], "title": "GroupUpdate" }, "GroupUpdateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "GroupUpdateResponse" }, "GroupsGetResponse": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/GroupGet" }, "type": "array", "title": "Groups" } }, "type": "object", "required": [ "groups" ], "title": "GroupsGetResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "IdentityBatchCreateError": { "properties": { "item": { "title": "Item" }, "errors": { "items": { "type": "string" }, "type": "array", "title": "Errors" } }, "type": "object", "required": [ "item", "errors" ], "title": "IdentityBatchCreateError" }, "IdentityBatchCreateRequest_GroupCreate_": { "properties": { "items": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/NonEmptyStr" }, "display_name": { "$ref": "#/components/schemas/NonEmptyStr" } }, "type": "object", "required": [ "external_id", "display_name" ], "title": "GroupCreate" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "IdentityBatchCreateRequest_GroupCreate_" }, "IdentityBatchCreateRequest_MachineUserCreate_": { "properties": { "items": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/NonEmptyStr" }, "display_name": { "$ref": "#/components/schemas/NonEmptyStr" } }, "type": "object", "required": [ "external_id", "display_name" ], "title": "MachineUserCreate" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "IdentityBatchCreateRequest_MachineUserCreate_" }, "IdentityBatchCreateRequest_UserCreate_": { "properties": { "items": { "items": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "external_id": { "type": "string", "title": "External Id" }, "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" } }, "type": "object", "required": [ "email", "external_id", "first_name", "last_name" ], "title": "UserCreate" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "IdentityBatchCreateRequest_UserCreate_" }, "IdentityBatchCreateResponse": { "properties": { "ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Ids" }, "errors": { "items": { "$ref": "#/components/schemas/IdentityBatchCreateError" }, "type": "array", "title": "Errors" } }, "type": "object", "required": [ "ids", "errors" ], "title": "IdentityBatchCreateResponse" }, "IdentityBatchDeleteRequest": { "properties": { "ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "maxItems": 50, "minItems": 1, "title": "Ids" } }, "type": "object", "required": [ "ids" ], "title": "IdentityBatchDeleteRequest" }, "IdentityType": { "type": "string", "enum": [ "user", "group", "machine_user" ], "title": "IdentityType" }, "InputPortEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "consuming_abstract_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Abstract Data Product Id" }, "consuming_abstract_data_product_type": { "$ref": "#/components/schemas/AbstractDataProductType" }, "producing_data_product_id": { "type": "string", "format": "uuid", "title": "Producing Data Product Id" } }, "type": "object", "required": [ "id", "consuming_abstract_data_product_id", "consuming_abstract_data_product_type", "producing_data_product_id" ], "title": "InputPortEvent" }, "InputPortRequest": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "justification": { "type": "string", "title": "Justification" }, "decision_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Note" }, "valid_from": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Valid From" }, "valid_until": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Valid Until" }, "access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "requested_duration_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Requested Duration Days" }, "requested_by": { "$ref": "#/components/schemas/User" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "decision": { "$ref": "#/components/schemas/InputPortRequestDecision" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Revoked At" }, "revoked_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On" }, "requested_on": { "type": "string", "format": "date-time", "title": "Requested On" }, "access_mode": { "anyOf": [ { "$ref": "#/components/schemas/AccessMode" }, { "type": "null" } ] }, "request_type": { "type": "string", "const": "InputPort", "title": "Request Type", "default": "InputPort" }, "input_port": { "$ref": "#/components/schemas/UserInputPort" } }, "type": "object", "required": [ "id", "justification", "valid_until", "access_duration_type", "requested_by", "decision", "created_on", "requested_on", "input_port" ], "title": "InputPortRequest" }, "InputPortRequestBase": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "justification": { "type": "string", "title": "Justification" }, "decision_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Decision Note" }, "valid_from": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Valid From" }, "valid_until": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Valid Until" }, "access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "requested_duration_days": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Requested Duration Days" }, "requested_by": { "$ref": "#/components/schemas/User" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "decision": { "$ref": "#/components/schemas/InputPortRequestDecision" }, "revoked_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Revoked At" }, "revoked_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "created_on": { "type": "string", "format": "date-time", "title": "Created On" }, "requested_on": { "type": "string", "format": "date-time", "title": "Requested On" }, "access_mode": { "anyOf": [ { "$ref": "#/components/schemas/AccessMode" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "justification", "valid_until", "access_duration_type", "requested_by", "decision", "created_on", "requested_on" ], "title": "InputPortRequestBase" }, "InputPortRequestDecision": { "type": "string", "enum": [ "pending", "approved", "denied", "cancelled" ], "title": "InputPortRequestDecision" }, "InputPortStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "expired", "revoked", "cancelled" ], "title": "InputPortStatus" }, "IsAdminResponse": { "properties": { "is_admin": { "type": "boolean", "title": "Is Admin" }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Time" } }, "type": "object", "required": [ "is_admin" ], "title": "IsAdminResponse" }, "LinkTechnicalAssetToOutputPortRequest": { "properties": { "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" } }, "type": "object", "required": [ "technical_asset_id" ], "title": "LinkTechnicalAssetToOutputPortRequest" }, "LinkTechnicalAssetsToOutputPortResponse": { "properties": { "link_id": { "type": "string", "format": "uuid", "title": "Link Id" } }, "type": "object", "required": [ "link_id" ], "title": "LinkTechnicalAssetsToOutputPortResponse" }, "ListDataProductRoleAssignmentsResponse": { "properties": { "role_assignments": { "items": { "$ref": "#/components/schemas/DataProductRoleAssignmentResponse" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "role_assignments" ], "title": "ListDataProductRoleAssignmentsResponse" }, "ListGlobalRoleAssignmentsResponse": { "properties": { "role_assignments": { "items": { "$ref": "#/components/schemas/GlobalRoleAssignmentResponse" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "role_assignments" ], "title": "ListGlobalRoleAssignmentsResponse" }, "ListOutputPortRoleAssignmentsResponse": { "properties": { "role_assignments": { "items": { "$ref": "#/components/schemas/OutputPortRoleAssignmentResponse" }, "type": "array", "title": "Role Assignments" } }, "type": "object", "required": [ "role_assignments" ], "title": "ListOutputPortRoleAssignmentsResponse" }, "MachineUserCreate": { "properties": { "external_id": { "$ref": "#/components/schemas/NonEmptyStr" }, "display_name": { "$ref": "#/components/schemas/NonEmptyStr" } }, "type": "object", "required": [ "external_id", "display_name" ], "title": "MachineUserCreate" }, "MachineUserCreateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "MachineUserCreateResponse" }, "MachineUserGet": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "external_id": { "type": "string", "title": "External Id" }, "display_name": { "type": "string", "title": "Display Name" } }, "type": "object", "required": [ "id", "external_id", "display_name" ], "title": "MachineUserGet" }, "MachineUserUpdate": { "properties": { "display_name": { "$ref": "#/components/schemas/NonEmptyStr" } }, "additionalProperties": false, "type": "object", "required": [ "display_name" ], "title": "MachineUserUpdate" }, "MachineUserUpdateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "MachineUserUpdateResponse" }, "MachineUsersGetResponse": { "properties": { "machine_users": { "items": { "$ref": "#/components/schemas/MachineUserGet" }, "type": "array", "title": "Machine Users" } }, "type": "object", "required": [ "machine_users" ], "title": "MachineUsersGetResponse" }, "ModifyDataProductRoleAssignment": { "properties": { "role_id": { "type": "string", "format": "uuid", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "ModifyDataProductRoleAssignment" }, "ModifyGlobalRoleAssignment": { "properties": { "role_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "string", "const": "admin" } ], "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "ModifyGlobalRoleAssignment" }, "ModifyOutputPortRoleAssignment": { "properties": { "role_id": { "type": "string", "format": "uuid", "title": "Role Id" } }, "type": "object", "required": [ "role_id" ], "title": "ModifyOutputPortRoleAssignment" }, "MyRequestsResponse": { "properties": { "my_requests": { "items": { "anyOf": [ { "$ref": "#/components/schemas/InputPortRequest" }, { "$ref": "#/components/schemas/TechnicalAssetOutputPortRequest" }, { "$ref": "#/components/schemas/DataProductRoleAssignmentRequest" } ] }, "type": "array", "title": "My Requests" } }, "type": "object", "required": [ "my_requests" ], "title": "MyRequestsResponse" }, "Node": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ], "title": "Id" }, "data": { "$ref": "#/components/schemas/NodeData" }, "type": { "$ref": "#/components/schemas/NodeType" }, "isMain": { "type": "boolean", "title": "Ismain", "default": false } }, "type": "object", "required": [ "id", "data", "type" ], "title": "Node" }, "NodeData": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "link_to_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Link To Id" }, "icon_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Key" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "domain_id": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Domain Id" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "type": "object", "required": [ "id", "name" ], "title": "NodeData" }, "NodeType": { "type": "string", "enum": [ "dataProductNode", "explorationNode", "technicalAssetNode", "outputPortNode" ], "title": "NodeType" }, "NonEmptyStr": { "type": "string", "minLength": 1, "title": "NonEmptyStr" }, "OIDCTokenResponse": { "properties": { "access_token": { "type": "string", "title": "Access Token" }, "token_type": { "type": "string", "title": "Token Type" }, "expires_in": { "type": "integer", "title": "Expires In" }, "id_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id Token" }, "refresh_token": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Refresh Token" } }, "type": "object", "required": [ "access_token", "token_type", "expires_in" ], "title": "OIDCTokenResponse", "description": "OIDC token endpoint response." }, "OutputPort": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/OutputPortStatus" }, "access_type": { "$ref": "#/components/schemas/OutputPortAccessType" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "title": "Tags" }, "access_modes": { "items": { "$ref": "#/components/schemas/AccessMode" }, "type": "array", "title": "Access Modes" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "status", "access_type", "data_product_id", "tags", "access_modes" ], "title": "OutputPort" }, "OutputPortAboutUpdate": { "properties": { "about": { "type": "string", "title": "About" } }, "type": "object", "required": [ "about" ], "title": "OutputPortAboutUpdate" }, "OutputPortAccessDuration": { "properties": { "access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "days": { "type": "integer", "title": "Days" } }, "type": "object", "required": [ "access_duration_type", "days" ], "title": "OutputPortAccessDuration" }, "OutputPortAccessFunction": { "type": "string", "enum": [ "restricted", "private", "unrestricted" ], "title": "OutputPortAccessFunction" }, "OutputPortAccessType": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "access_function": { "$ref": "#/components/schemas/OutputPortAccessFunction" } }, "type": "object", "required": [ "id", "name", "access_function" ], "title": "OutputPortAccessType" }, "OutputPortAccessTypeCreate": { "properties": { "name": { "$ref": "#/components/schemas/NonEmptyStr" }, "description": { "type": "string", "title": "Description", "default": "" }, "access_function": { "$ref": "#/components/schemas/OutputPortAccessFunction" } }, "type": "object", "required": [ "name", "access_function" ], "title": "OutputPortAccessTypeCreate" }, "OutputPortAccessTypeUpdate": { "properties": { "name": { "$ref": "#/components/schemas/NonEmptyStr" }, "description": { "type": "string", "title": "Description", "default": "" }, "access_function": { "$ref": "#/components/schemas/OutputPortAccessFunction" } }, "type": "object", "required": [ "name", "access_function" ], "title": "OutputPortAccessTypeUpdate" }, "OutputPortAccessTypesGet": { "properties": { "output_port_access_types": { "items": { "$ref": "#/components/schemas/OutputPortAccessTypesGetItem" }, "type": "array", "title": "Output Port Access Types" } }, "type": "object", "required": [ "output_port_access_types" ], "title": "OutputPortAccessTypesGet" }, "OutputPortAccessTypesGetItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "access_function": { "$ref": "#/components/schemas/OutputPortAccessFunction" }, "description": { "type": "string", "title": "Description" }, "output_port_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Port Count" } }, "type": "object", "required": [ "id", "name", "access_function", "description" ], "title": "OutputPortAccessTypesGetItem" }, "OutputPortCuratedQueries": { "properties": { "output_port_curated_queries": { "items": { "$ref": "#/components/schemas/OutputPortCuratedQuery" }, "type": "array", "title": "Output Port Curated Queries" } }, "type": "object", "required": [ "output_port_curated_queries" ], "title": "OutputPortCuratedQueries" }, "OutputPortCuratedQueriesUpdate": { "properties": { "curated_queries": { "items": { "$ref": "#/components/schemas/OutputPortCuratedQueryInput" }, "type": "array", "title": "Curated Queries" } }, "type": "object", "required": [ "curated_queries" ], "title": "OutputPortCuratedQueriesUpdate" }, "OutputPortCuratedQuery": { "properties": { "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "sort_order": { "type": "integer", "title": "Sort Order" }, "title": { "type": "string", "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "query_text": { "type": "string", "title": "Query Text" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "output_port_id", "sort_order", "title", "description", "query_text", "created_at", "updated_at" ], "title": "OutputPortCuratedQuery" }, "OutputPortCuratedQueryInput": { "properties": { "title": { "type": "string", "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "query_text": { "type": "string", "title": "Query Text" } }, "type": "object", "required": [ "title", "query_text" ], "title": "OutputPortCuratedQueryInput" }, "OutputPortDataQualitySummary": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "overall_status": { "$ref": "#/components/schemas/DataQualityStatus" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "details_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Details Url" }, "technical_assets": { "items": { "$ref": "#/components/schemas/DataQualityTechnicalAsset" }, "type": "array", "title": "Technical Assets" }, "dimensions": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/DataQualityStatus" }, "type": "object" }, { "type": "null" } ], "title": "Dimensions" } }, "type": "object", "required": [ "created_at", "overall_status", "technical_assets" ], "title": "OutputPortDataQualitySummary" }, "OutputPortDataQualitySummaryResponse": { "properties": { "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "overall_status": { "$ref": "#/components/schemas/DataQualityStatus" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "details_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Details Url" }, "technical_assets": { "items": { "$ref": "#/components/schemas/DataQualityTechnicalAsset" }, "type": "array", "title": "Technical Assets" }, "dimensions": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/DataQualityStatus" }, "type": "object" }, { "type": "null" } ], "title": "Dimensions" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" } }, "type": "object", "required": [ "created_at", "overall_status", "technical_assets", "id", "output_port_id" ], "title": "OutputPortDataQualitySummaryResponse" }, "OutputPortEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "id", "data_product_id" ], "title": "OutputPortEvent" }, "OutputPortInputPort": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "status": { "$ref": "#/components/schemas/InputPortStatus" }, "current_request": { "$ref": "#/components/schemas/InputPortRequestBase" }, "renewal_status": { "anyOf": [ { "$ref": "#/components/schemas/RenewalStatus" }, { "type": "null" } ] }, "consuming_abstract_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Abstract Data Product Id" }, "consuming_abstract_data_product": { "$ref": "#/components/schemas/AbstractDataProductInfo" } }, "type": "object", "required": [ "id", "status", "current_request", "consuming_abstract_data_product_id", "consuming_abstract_data_product" ], "title": "OutputPortInputPort" }, "OutputPortLink": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" }, "status": { "$ref": "#/components/schemas/DecisionStatus" }, "output_port": { "$ref": "#/components/schemas/OutputPort" } }, "type": "object", "required": [ "id", "output_port_id", "technical_asset_id", "status", "output_port" ], "title": "OutputPortLink" }, "OutputPortQueryStatsDelete": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "Day to delete, in ISO 8601 format (YYYY-MM-DD)", "examples": [ "2025-01-15" ] }, "consumer_data_product_id": { "type": "string", "format": "uuid", "title": "Consumer Data Product Id", "description": "ID of the consuming data product whose count to delete" } }, "type": "object", "required": [ "date", "consumer_data_product_id" ], "title": "OutputPortQueryStatsDelete" }, "OutputPortQueryStatsResponse": { "properties": { "date": { "type": "string", "format": "date", "title": "Date" }, "consumer_data_product_id": { "type": "string", "format": "uuid", "title": "Consumer Data Product Id" }, "query_count": { "type": "integer", "title": "Query Count" }, "consumer_data_product_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Consumer Data Product Name" } }, "type": "object", "required": [ "date", "consumer_data_product_id", "query_count" ], "title": "OutputPortQueryStatsResponse" }, "OutputPortQueryStatsResponses": { "properties": { "output_port_query_stats_responses": { "items": { "$ref": "#/components/schemas/OutputPortQueryStatsResponse" }, "type": "array", "title": "Output Port Query Stats Responses" } }, "type": "object", "required": [ "output_port_query_stats_responses" ], "title": "OutputPortQueryStatsResponses" }, "OutputPortQueryStatsUpdate": { "properties": { "date": { "type": "string", "format": "date", "title": "Date", "description": "Day the queries were executed, in ISO 8601 format (YYYY-MM-DD)", "examples": [ "2025-01-15" ] }, "consumer_data_product_id": { "type": "string", "format": "uuid", "title": "Consumer Data Product Id", "description": "ID of the data product that queried the output port" }, "query_count": { "type": "integer", "maximum": 2147483647.0, "minimum": 0.0, "title": "Query Count", "description": "Number of queries the consuming data product ran against the output port on this day. Overwrites any count previously sent for the same day and consuming data product.", "examples": [ 42 ] } }, "type": "object", "required": [ "date", "consumer_data_product_id", "query_count" ], "title": "OutputPortQueryStatsUpdate" }, "OutputPortRoleAssignmentEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "user_id": { "type": "string", "format": "uuid", "title": "User Id" } }, "type": "object", "required": [ "id", "output_port_id", "data_product_id", "user_id" ], "title": "OutputPortRoleAssignmentEvent", "description": "Fired on insert, update, and delete of an output-port role assignment." }, "OutputPortRoleAssignmentResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port": { "$ref": "#/components/schemas/OutputPort" }, "user": { "$ref": "#/components/schemas/User" }, "role": { "anyOf": [ { "$ref": "#/components/schemas/Role" }, { "type": "null" } ] }, "decision": { "$ref": "#/components/schemas/DecisionStatus" }, "requested_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Requested On" }, "requested_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "decided_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Decided On" }, "decided_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "output_port", "user", "role", "decision", "requested_on", "requested_by", "decided_on", "decided_by" ], "title": "OutputPortRoleAssignmentResponse" }, "OutputPortSchemaResponse": { "properties": { "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "schema_objects": { "items": { "$ref": "#/components/schemas/SchemaObjectResponse" }, "type": "array", "title": "Schema Objects", "default": [] } }, "type": "object", "required": [ "output_port_id" ], "title": "OutputPortSchemaResponse" }, "OutputPortSettingValue": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_setting_id": { "type": "string", "format": "uuid", "title": "Data Product Setting Id" }, "value": { "type": "string", "title": "Value" }, "data_product_setting": { "$ref": "#/components/schemas/DataProductSetting" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" } }, "type": "object", "required": [ "id", "data_product_setting_id", "value", "data_product_setting", "output_port_id" ], "title": "OutputPortSettingValue" }, "OutputPortStatus": { "type": "string", "enum": [ "pending", "active", "archived" ], "title": "OutputPortStatus" }, "OutputPortStatusUpdate": { "properties": { "status": { "$ref": "#/components/schemas/OutputPortStatus" } }, "type": "object", "required": [ "status" ], "title": "OutputPortStatusUpdate" }, "OutputPortTechnicalAssetLinkEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" } }, "type": "object", "required": [ "id", "data_product_id", "output_port_id", "technical_asset_id" ], "title": "OutputPortTechnicalAssetLinkEvent" }, "OutputPortUpdate": { "properties": { "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "access_type_id": { "type": "string", "format": "uuid", "title": "Access Type Id" }, "data_product_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "exploration_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About" }, "lifecycle_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Lifecycle Id" }, "tag_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tag Ids" } }, "type": "object", "required": [ "name", "namespace", "description", "access_type_id", "data_product_access_duration_type", "exploration_access_duration_type", "tag_ids" ], "title": "OutputPortUpdate" }, "OwnedTechnicalAsset": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/TechnicalAssetStatus" }, "technical_mapping": { "$ref": "#/components/schemas/TechnicalMapping" }, "owner_id": { "type": "string", "format": "uuid", "title": "Owner Id" }, "platform_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Platform Id" }, "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Service Id" }, "configuration": { "properties": { "name": { "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "Configuration", "description": "Configuration of the technical asset. The available fields depend on `name`; retrieve them from /v2/plugins/{name}/form." }, "owner": { "$ref": "#/components/schemas/DataProduct" } }, "type": "object", "required": [ "id", "name", "namespace", "description", "status", "technical_mapping", "owner_id", "configuration", "owner" ], "title": "OwnedTechnicalAsset" }, "PendingActionResponse": { "properties": { "pending_actions": { "items": { "anyOf": [ { "$ref": "#/components/schemas/InputPortRequest" }, { "$ref": "#/components/schemas/TechnicalAssetOutputPortRequest" }, { "$ref": "#/components/schemas/DataProductRoleAssignmentRequest" } ] }, "type": "array", "title": "Pending Actions" } }, "type": "object", "required": [ "pending_actions" ], "title": "PendingActionResponse" }, "Platform": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "id", "name" ], "title": "Platform" }, "PlatformService": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "platform": { "$ref": "#/components/schemas/Platform" }, "result_string_template": { "type": "string", "title": "Result String Template" }, "technical_info_template": { "type": "string", "title": "Technical Info Template" } }, "type": "object", "required": [ "id", "name", "platform", "result_string_template", "technical_info_template" ], "title": "PlatformService" }, "PlatformServiceConfiguration": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "platform": { "$ref": "#/components/schemas/Platform" }, "service": { "$ref": "#/components/schemas/PlatformService" }, "config": { "items": { "type": "string" }, "type": "array", "title": "Config" } }, "type": "object", "required": [ "id", "platform", "service", "config" ], "title": "PlatformServiceConfiguration" }, "PlatformTile": { "properties": { "label": { "type": "string", "title": "Label" }, "value": { "type": "string", "title": "Value" }, "icon_name": { "type": "string", "title": "Icon Name" }, "icon_data_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Data Uri" }, "has_environments": { "type": "boolean", "title": "Has Environments", "default": true }, "has_config": { "type": "boolean", "title": "Has Config", "default": true }, "children": { "items": { "$ref": "#/components/schemas/PlatformTile" }, "type": "array", "title": "Children", "default": [] }, "show_in_form": { "type": "boolean", "title": "Show In Form", "default": true } }, "type": "object", "required": [ "label", "value", "icon_name" ], "title": "PlatformTile", "description": "Represents a platform tile in the UI" }, "PlatformTileResponse": { "properties": { "platform_tiles": { "items": { "$ref": "#/components/schemas/PlatformTile" }, "type": "array", "title": "Platform Tiles" } }, "type": "object", "required": [ "platform_tiles" ], "title": "PlatformTileResponse", "description": "Response model for platform tiles" }, "PluginResponse": { "properties": { "plugins": { "items": { "$ref": "#/components/schemas/UIElementMetadataResponse" }, "type": "array", "title": "Plugins" } }, "type": "object", "required": [ "plugins" ], "title": "PluginResponse", "description": "Response model for listing available plugins" }, "PostgreSQLConfig": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "host": { "type": "string", "title": "Host" }, "port": { "type": "string", "title": "Port" }, "admin_user": { "type": "string", "title": "Admin User" }, "admin_pwd": { "type": "string", "title": "Admin Pwd" } }, "type": "object", "required": [ "identifier", "host", "port", "admin_user", "admin_pwd" ], "title": "PostgreSQLConfig" }, "Prototype": { "type": "integer", "enum": [ 0, 1, 2, 3 ], "title": "Prototype" }, "QueryStatsGranularity": { "type": "string", "enum": [ "day", "week", "month" ], "title": "QueryStatsGranularity" }, "RedshiftConfig": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "database_name": { "type": "string", "title": "Database Name" }, "bucket_identifier": { "type": "string", "title": "Bucket Identifier" }, "s3_path": { "type": "string", "title": "S3 Path" } }, "type": "object", "required": [ "identifier", "database_name", "bucket_identifier", "s3_path" ], "title": "RedshiftConfig" }, "RemoveOutputPortAsInputPortRequest": { "properties": { "consuming_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Data Product Id" } }, "type": "object", "required": [ "consuming_data_product_id" ], "title": "RemoveOutputPortAsInputPortRequest" }, "RenderTechnicalAssetAccessPathRequest": { "properties": { "platform_id": { "type": "string", "format": "uuid", "title": "Platform Id" }, "service_id": { "type": "string", "format": "uuid", "title": "Service Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "namespace": { "type": "string", "title": "Namespace" }, "technical_mapping": { "$ref": "#/components/schemas/TechnicalMapping" }, "configuration": { "properties": { "name": { "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "Configuration", "description": "Configuration of the technical asset. The available fields depend on `name`; retrieve them from /v2/plugins/{name}/form." } }, "type": "object", "required": [ "platform_id", "service_id", "data_product_id", "namespace", "technical_mapping", "configuration" ], "title": "RenderTechnicalAssetAccessPathRequest" }, "RenderTechnicalAssetAccessPathResponse": { "properties": { "technical_asset_access_path": { "type": "string", "title": "Technical Asset Access Path" } }, "type": "object", "required": [ "technical_asset_access_path" ], "title": "RenderTechnicalAssetAccessPathResponse" }, "RenewInputPortForDataProductResponse": { "properties": { "input_port_link": { "type": "string", "format": "uuid", "title": "Input Port Link" } }, "type": "object", "required": [ "input_port_link" ], "title": "RenewInputPortForDataProductResponse" }, "RenewInputPortForExplorationResponse": { "properties": { "input_port_id": { "type": "string", "format": "uuid", "title": "Input Port Id" } }, "type": "object", "required": [ "input_port_id" ], "title": "RenewInputPortForExplorationResponse" }, "RenewOutputPortAsInputPortRequest": { "properties": { "consuming_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Data Product Id" } }, "type": "object", "required": [ "consuming_data_product_id" ], "title": "RenewOutputPortAsInputPortRequest" }, "RenewalStatus": { "type": "string", "enum": [ "pending", "denied" ], "title": "RenewalStatus" }, "RequestDataProductRoleAssignment": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role_id": { "type": "string", "format": "uuid", "title": "Role Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "user_id", "role_id", "data_product_id" ], "title": "RequestDataProductRoleAssignment" }, "RequestInputPortsForAbstractDataProductRequestItem": { "properties": { "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "access_mode_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Access Mode Id" } }, "type": "object", "required": [ "output_port_id" ], "title": "RequestInputPortsForAbstractDataProductRequestItem" }, "RequestInputPortsForDataProductRequest": { "properties": { "output_ports": { "items": { "$ref": "#/components/schemas/RequestInputPortsForAbstractDataProductRequestItem" }, "type": "array", "title": "Output Ports" }, "justification": { "type": "string", "title": "Justification" } }, "type": "object", "required": [ "output_ports", "justification" ], "title": "RequestInputPortsForDataProductRequest" }, "RequestInputPortsForDataProductResponse": { "properties": { "input_port_links": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Input Port Links" } }, "type": "object", "required": [ "input_port_links" ], "title": "RequestInputPortsForDataProductResponse" }, "RequestInputPortsForExplorationRequest": { "properties": { "output_ports": { "items": { "$ref": "#/components/schemas/RequestInputPortsForAbstractDataProductRequestItem" }, "type": "array", "title": "Output Ports" }, "justification": { "type": "string", "title": "Justification" } }, "type": "object", "required": [ "output_ports", "justification" ], "title": "RequestInputPortsForExplorationRequest" }, "RequestInputPortsForExplorationResponse": { "properties": { "input_port_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Input Port Ids" } }, "type": "object", "required": [ "input_port_ids" ], "title": "RequestInputPortsForExplorationResponse" }, "RequestOutputPortRoleAssignment": { "properties": { "user_id": { "type": "string", "format": "uuid", "title": "User Id" }, "role_id": { "type": "string", "format": "uuid", "title": "Role Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" } }, "type": "object", "required": [ "user_id", "role_id", "output_port_id" ], "title": "RequestOutputPortRoleAssignment" }, "ResourceNameLengthLimits": { "properties": { "max_length": { "type": "integer", "title": "Max Length" } }, "type": "object", "required": [ "max_length" ], "title": "ResourceNameLengthLimits" }, "ResourceNameModel": { "type": "string", "enum": [ "data_product", "technical_asset", "output_port", "data_product_setting", "output_port_setting", "exploration", "domain" ], "title": "ResourceNameModel" }, "ResourceNameSuggestion": { "properties": { "resource_name": { "type": "string", "title": "Resource Name" } }, "type": "object", "required": [ "resource_name" ], "title": "ResourceNameSuggestion" }, "ResourceNameValidation": { "properties": { "validity": { "$ref": "#/components/schemas/ResourceNameValidityType" } }, "type": "object", "required": [ "validity" ], "title": "ResourceNameValidation" }, "ResourceNameValidityType": { "type": "string", "enum": [ "VALID", "INVALID_LENGTH", "INVALID_CHARACTERS", "DUPLICATE" ], "title": "ResourceNameValidityType" }, "RevokeInputPortForDataProductResponse": { "properties": { "input_port_link": { "type": "string", "format": "uuid", "title": "Input Port Link" } }, "type": "object", "required": [ "input_port_link" ], "title": "RevokeInputPortForDataProductResponse" }, "RevokeInputPortForExplorationResponse": { "properties": { "input_port_id": { "type": "string", "format": "uuid", "title": "Input Port Id" } }, "type": "object", "required": [ "input_port_id" ], "title": "RevokeInputPortForExplorationResponse" }, "RevokeOutputPortAsInputPortRequest": { "properties": { "consuming_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Data Product Id" } }, "type": "object", "required": [ "consuming_data_product_id" ], "title": "RevokeOutputPortAsInputPortRequest" }, "Role": { "properties": { "name": { "type": "string", "title": "Name" }, "scope": { "$ref": "#/components/schemas/Scope" }, "description": { "type": "string", "title": "Description" }, "permissions": { "items": { "$ref": "#/components/schemas/AuthorizationAction" }, "type": "array", "title": "Permissions" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "prototype": { "$ref": "#/components/schemas/Prototype" } }, "type": "object", "required": [ "name", "scope", "description", "permissions", "id", "prototype" ], "title": "Role" }, "SchemaObjectRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "logicalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logicaltype" }, "physicalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physicaltype" }, "physicalName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physicalname" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "properties": { "items": { "$ref": "#/components/schemas/SchemaPropertyRequest" }, "type": "array", "title": "Properties", "default": [] } }, "type": "object", "required": [ "name" ], "title": "SchemaObjectRequest" }, "SchemaObjectResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "logical_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logical Type" }, "physical_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physical Type" }, "physical_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physical Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "position": { "type": "integer", "title": "Position" }, "properties": { "items": { "$ref": "#/components/schemas/SchemaPropertyResponse" }, "type": "array", "title": "Properties", "default": [] } }, "type": "object", "required": [ "id", "name", "position" ], "title": "SchemaObjectResponse" }, "SchemaPropertyRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "businessName": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Businessname" }, "logicalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logicaltype" }, "physicalType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physicaltype" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "examples": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "primaryKey": { "type": "boolean", "title": "Primarykey", "default": false }, "primaryKeyPosition": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Primarykeyposition" }, "unique": { "type": "boolean", "title": "Unique", "default": false }, "required": { "type": "boolean", "title": "Required", "default": false }, "partitioned": { "type": "boolean", "title": "Partitioned", "default": false }, "partitionKeyPosition": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Partitionkeyposition" }, "properties": { "items": { "$ref": "#/components/schemas/SchemaPropertyRequest" }, "type": "array", "title": "Properties", "default": [] } }, "type": "object", "required": [ "name" ], "title": "SchemaPropertyRequest" }, "SchemaPropertyResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "business_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Business Name" }, "logical_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Logical Type" }, "physical_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Physical Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "examples": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Examples" }, "primary_key": { "type": "boolean", "title": "Primary Key", "default": false }, "primary_key_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Primary Key Position" }, "unique": { "type": "boolean", "title": "Unique", "default": false }, "required": { "type": "boolean", "title": "Required", "default": false }, "partitioned": { "type": "boolean", "title": "Partitioned", "default": false }, "partition_key_position": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Partition Key Position" }, "position": { "type": "integer", "title": "Position" }, "properties": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SchemaPropertyResponse" }, "type": "array" }, { "type": "null" } ], "title": "Properties" } }, "type": "object", "required": [ "id", "name", "position" ], "title": "SchemaPropertyResponse" }, "Scope": { "type": "string", "enum": [ "dataset", "data_product", "domain", "global" ], "title": "Scope" }, "SearchOutputPortsResponse": { "properties": { "output_ports": { "items": { "$ref": "#/components/schemas/SearchOutputPortsResponseItem" }, "type": "array", "title": "Output Ports" } }, "type": "object", "required": [ "output_ports" ], "title": "SearchOutputPortsResponse" }, "SearchOutputPortsResponseItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "namespace": { "type": "string", "title": "Namespace" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/OutputPortStatus" }, "usage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage" }, "access_type": { "$ref": "#/components/schemas/OutputPortAccessType" }, "data_product_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "exploration_access_duration_type": { "$ref": "#/components/schemas/AccessDurationType" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" }, "tags": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array", "title": "Tags" }, "domain": { "$ref": "#/components/schemas/Domain" }, "lifecycle": { "anyOf": [ { "$ref": "#/components/schemas/DataProductLifeCycle" }, { "type": "null" } ] }, "access_modes": { "items": { "$ref": "#/components/schemas/AccessMode" }, "type": "array", "title": "Access Modes" }, "abstract_data_product_count": { "type": "integer", "title": "Abstract Data Product Count" }, "technical_assets_count": { "type": "integer", "title": "Technical Assets Count" }, "data_product_name": { "type": "string", "title": "Data Product Name" }, "quality_status": { "anyOf": [ { "$ref": "#/components/schemas/DataQualityStatus" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "namespace", "name", "description", "status", "usage", "access_type", "data_product_access_duration_type", "exploration_access_duration_type", "data_product_id", "tags", "domain", "lifecycle", "access_modes", "abstract_data_product_count", "technical_assets_count", "data_product_name" ], "title": "SearchOutputPortsResponseItem" }, "SelectOption": { "properties": { "label": { "type": "string", "title": "Label" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ], "title": "Value" } }, "type": "object", "required": [ "label", "value" ], "title": "SelectOption", "description": "Option for select UI elements" }, "SnowflakeConfig": { "properties": { "identifier": { "type": "string", "title": "Identifier" }, "database_name": { "type": "string", "title": "Database Name" } }, "type": "object", "required": [ "identifier", "database_name" ], "title": "SnowflakeConfig" }, "Tag": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "id", "value" ], "title": "Tag" }, "TagCreate": { "properties": { "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "value" ], "title": "TagCreate" }, "TagUpdate": { "properties": { "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "value" ], "title": "TagUpdate" }, "TagsGet": { "properties": { "tags": { "items": { "$ref": "#/components/schemas/TagsGetItem" }, "type": "array", "title": "Tags" } }, "type": "object", "required": [ "tags" ], "title": "TagsGet" }, "TagsGetItem": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "value": { "type": "string", "title": "Value" } }, "type": "object", "required": [ "id", "value" ], "title": "TagsGetItem" }, "TechnicalAsset": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "namespace": { "type": "string", "title": "Namespace" }, "description": { "type": "string", "title": "Description" }, "status": { "$ref": "#/components/schemas/TechnicalAssetStatus" }, "technical_mapping": { "$ref": "#/components/schemas/TechnicalMapping" }, "owner_id": { "type": "string", "format": "uuid", "title": "Owner Id" }, "platform_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Platform Id" }, "service_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Service Id" }, "configuration": { "properties": { "name": { "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "Configuration", "description": "Configuration of the technical asset. The available fields depend on `name`; retrieve them from /v2/plugins/{name}/form." } }, "type": "object", "required": [ "id", "name", "namespace", "description", "status", "technical_mapping", "owner_id", "configuration" ], "title": "TechnicalAsset" }, "TechnicalAssetEvent": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "data_product_id": { "type": "string", "format": "uuid", "title": "Data Product Id" } }, "type": "object", "required": [ "id", "data_product_id" ], "title": "TechnicalAssetEvent" }, "TechnicalAssetLink": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" }, "status": { "$ref": "#/components/schemas/DecisionStatus" }, "technical_asset": { "$ref": "#/components/schemas/TechnicalAsset" } }, "type": "object", "required": [ "id", "output_port_id", "technical_asset_id", "status", "technical_asset" ], "title": "TechnicalAssetLink" }, "TechnicalAssetOutputPortRequest": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "output_port": { "$ref": "#/components/schemas/OutputPort" }, "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" }, "technical_asset": { "$ref": "#/components/schemas/OwnedTechnicalAsset" }, "status": { "$ref": "#/components/schemas/DecisionStatus" }, "requested_on": { "type": "string", "format": "date-time", "title": "Requested On" }, "denied_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Denied On" }, "approved_on": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Approved On" }, "requested_by": { "$ref": "#/components/schemas/User" }, "denied_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "approved_by": { "anyOf": [ { "$ref": "#/components/schemas/User" }, { "type": "null" } ] }, "request_type": { "type": "string", "const": "TechnicalAssetOutputPort", "title": "Request Type", "default": "TechnicalAssetOutputPort" } }, "type": "object", "required": [ "id", "output_port_id", "output_port", "technical_asset_id", "technical_asset", "status", "requested_on", "denied_on", "approved_on", "requested_by", "denied_by", "approved_by" ], "title": "TechnicalAssetOutputPortRequest" }, "TechnicalAssetStatus": { "type": "string", "enum": [ "pending", "active", "archived" ], "title": "TechnicalAssetStatus" }, "TechnicalAssetStatusUpdate": { "properties": { "status": { "$ref": "#/components/schemas/TechnicalAssetStatus" } }, "type": "object", "required": [ "status" ], "title": "TechnicalAssetStatusUpdate" }, "TechnicalAssetUpdate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "tag_ids": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Tag Ids" } }, "type": "object", "required": [ "name", "description", "tag_ids" ], "title": "TechnicalAssetUpdate" }, "TechnicalInfo": { "properties": { "environment_id": { "type": "string", "format": "uuid", "title": "Environment Id" }, "environment": { "type": "string", "title": "Environment" }, "info": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Info" } }, "type": "object", "required": [ "environment_id", "environment", "info" ], "title": "TechnicalInfo" }, "TechnicalMapping": { "type": "string", "enum": [ "default", "custom" ], "title": "TechnicalMapping" }, "ThemeSettings": { "properties": { "portal_name": { "type": "string", "title": "Portal Name" } }, "type": "object", "required": [ "portal_name" ], "title": "ThemeSettings" }, "TimeBoundAccessEnabledResponse": { "properties": { "enabled": { "type": "boolean", "title": "Enabled" } }, "type": "object", "required": [ "enabled" ], "title": "TimeBoundAccessEnabledResponse" }, "UIElementCheckbox": { "properties": { "initial_value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Initial Value" } }, "type": "object", "title": "UIElementCheckbox" }, "UIElementMetadata": { "properties": { "label": { "type": "string", "title": "Label" }, "type": { "$ref": "#/components/schemas/UIElementType" }, "required": { "type": "boolean", "title": "Required" }, "name": { "type": "string", "title": "Name" }, "tooltip": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tooltip" }, "hidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Hidden" }, "checkbox": { "anyOf": [ { "$ref": "#/components/schemas/UIElementCheckbox" }, { "type": "null" } ] }, "select": { "anyOf": [ { "$ref": "#/components/schemas/UIElementSelect" }, { "type": "null" } ] }, "string": { "anyOf": [ { "$ref": "#/components/schemas/UIElementString" }, { "type": "null" } ] }, "radio": { "anyOf": [ { "$ref": "#/components/schemas/UIElementRadio" }, { "type": "null" } ] }, "depends_on": { "anyOf": [ { "items": { "$ref": "#/components/schemas/FieldDependency" }, "type": "array" }, { "type": "null" } ], "title": "Depends On" }, "disabled": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Disabled" }, "use_namespace_when_not_source_aligned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Use Namespace When Not Source Aligned" } }, "type": "object", "required": [ "label", "type", "required", "name" ], "title": "UIElementMetadata" }, "UIElementMetadataResponse": { "properties": { "not_configured": { "type": "boolean", "title": "Not Configured", "default": false }, "ui_metadata": { "items": { "$ref": "#/components/schemas/UIElementMetadata" }, "type": "array", "title": "Ui Metadata" }, "plugin": { "type": "string", "title": "Plugin" }, "has_environments": { "type": "boolean", "title": "Has Environments" }, "result_label": { "type": "string", "title": "Result Label", "default": "Resulting path" }, "result_tooltip": { "type": "string", "title": "Result Tooltip", "default": "The path you can access through this technical asset" }, "platform": { "type": "string", "title": "Platform" }, "display_name": { "type": "string", "title": "Display Name" }, "icon_name": { "type": "string", "title": "Icon Name" }, "icon_data_uri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Icon Data Uri" }, "parent_platform": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent Platform" }, "platform_tile": { "anyOf": [ { "$ref": "#/components/schemas/PlatformTile" }, { "type": "null" } ] }, "show_in_form": { "type": "boolean", "title": "Show In Form", "default": true }, "shareable": { "type": "boolean", "title": "Shareable", "default": true }, "detailed_name": { "type": "string", "title": "Detailed Name" } }, "type": "object", "required": [ "ui_metadata", "plugin", "has_environments", "platform", "display_name", "icon_name", "detailed_name" ], "title": "UIElementMetadataResponse" }, "UIElementRadio": { "properties": { "max_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Count", "default": 1 }, "initial_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Value" }, "options": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SelectOption" }, "type": "array" }, { "type": "null" } ], "title": "Options" } }, "type": "object", "title": "UIElementRadio" }, "UIElementSelect": { "properties": { "max_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Count", "default": 1 }, "options": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SelectOption" }, "type": "array" }, { "type": "null" } ], "title": "Options" } }, "type": "object", "title": "UIElementSelect" }, "UIElementString": { "properties": { "initial_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Initial Value" } }, "type": "object", "title": "UIElementString" }, "UIElementType": { "type": "string", "enum": [ "string", "select", "checkbox", "radio" ], "title": "UIElementType" }, "URLResponse": { "properties": { "url": { "type": "string", "title": "Url" } }, "type": "object", "required": [ "url" ], "title": "URLResponse", "description": "Response model for platform URLs" }, "UnLinkTechnicalAssetToOutputPortRequest": { "properties": { "technical_asset_id": { "type": "string", "format": "uuid", "title": "Technical Asset Id" } }, "type": "object", "required": [ "technical_asset_id" ], "title": "UnLinkTechnicalAssetToOutputPortRequest" }, "UpdateAccessDurationResponse": { "properties": { "access_durations": { "items": { "$ref": "#/components/schemas/AccessDuration" }, "type": "array", "title": "Access Durations" } }, "type": "object", "required": [ "access_durations" ], "title": "UpdateAccessDurationResponse" }, "UpdateDataProductLifeCycleResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateDataProductLifeCycleResponse" }, "UpdateDataProductResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateDataProductResponse" }, "UpdateDataProductSettingResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateDataProductSettingResponse" }, "UpdateDataProductTypeResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateDataProductTypeResponse" }, "UpdateDomainResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateDomainResponse" }, "UpdateOutputPortAccessTypeResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateOutputPortAccessTypeResponse" }, "UpdateOutputPortQueryStatus": { "properties": { "output_port_query_stats_updates": { "items": { "$ref": "#/components/schemas/OutputPortQueryStatsUpdate" }, "type": "array", "title": "Output Port Query Stats Updates", "description": "Daily query counts per consuming data product" } }, "type": "object", "required": [ "output_port_query_stats_updates" ], "title": "UpdateOutputPortQueryStatus" }, "UpdateOutputPortResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateOutputPortResponse" }, "UpdateRole": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "permissions": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AuthorizationAction" }, "type": "array" }, { "type": "null" } ], "title": "Permissions" } }, "type": "object", "title": "UpdateRole" }, "UpdateTagResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateTagResponse" }, "UpdateTechnicalAssetResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UpdateTechnicalAssetResponse" }, "User": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "external_id": { "type": "string", "title": "External Id" }, "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "has_seen_tour": { "type": "boolean", "title": "Has Seen Tour" }, "can_become_admin": { "type": "boolean", "title": "Can Become Admin" }, "admin_expiry": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Admin Expiry" } }, "type": "object", "required": [ "id", "email", "external_id", "first_name", "last_name", "has_seen_tour", "can_become_admin" ], "title": "User" }, "UserCreate": { "properties": { "email": { "type": "string", "format": "email", "title": "Email" }, "external_id": { "type": "string", "title": "External Id" }, "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" } }, "type": "object", "required": [ "email", "external_id", "first_name", "last_name" ], "title": "UserCreate" }, "UserCreateResponse": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "UserCreateResponse" }, "UserInputPort": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "consuming_abstract_data_product_id": { "type": "string", "format": "uuid", "title": "Consuming Abstract Data Product Id" }, "consuming_abstract_data_product": { "$ref": "#/components/schemas/AbstractDataProductInfo" }, "output_port_id": { "type": "string", "format": "uuid", "title": "Output Port Id" }, "output_port": { "$ref": "#/components/schemas/OutputPort" }, "renewal_status": { "anyOf": [ { "$ref": "#/components/schemas/RenewalStatus" }, { "type": "null" } ] }, "current_request": { "$ref": "#/components/schemas/InputPortRequestBase" } }, "type": "object", "required": [ "id", "consuming_abstract_data_product_id", "consuming_abstract_data_product", "output_port_id", "output_port", "current_request" ], "title": "UserInputPort" }, "UsersGet": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "email": { "type": "string", "format": "email", "title": "Email" }, "external_id": { "type": "string", "title": "External Id" }, "first_name": { "type": "string", "title": "First Name" }, "last_name": { "type": "string", "title": "Last Name" }, "has_seen_tour": { "type": "boolean", "title": "Has Seen Tour" }, "can_become_admin": { "type": "boolean", "title": "Can Become Admin" }, "admin_expiry": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Admin Expiry" }, "global_role": { "anyOf": [ { "$ref": "#/components/schemas/GlobalRoleAssignmentResponse" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "email", "external_id", "first_name", "last_name", "has_seen_tour", "can_become_admin", "global_role" ], "title": "UsersGet" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "TechnicalAssetPlugin": { "properties": { "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "TechnicalAssetPlugin" } }, "securitySchemes": { "HTTPBasic": { "type": "http", "scheme": "basic" } } } }