diff --git a/.bumpversion.cfg b/.bumpversion.cfg index a3b92aab9..bfb198771 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.4.0-rc3 +current_version = 0.4.0-rc4 commit = False tag = False parse = (?P\d+)\.(?P\d+)\.(?P\d+)((\-rc)(?P\d+))? diff --git a/docs/architecture/application/openapi.json b/docs/architecture/application/openapi.json index bfae072ed..bfb0de7d2 100644 --- a/docs/architecture/application/openapi.json +++ b/docs/architecture/application/openapi.json @@ -1 +1 @@ -{"openapi":"3.0.2","info":{"title":"The Orchestrator","description":"The orchestrator is a project that enables users to run workflows.","version":"1.0.0"},"paths":{"/api/fixed_inputs/configuration":{"get":{"tags":["Core","Fixed Inputs"],"summary":"Fi Configuration","operationId":"fi_configuration_api_fixed_inputs_configuration_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixedInputConfigurationSchema"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{pid}":{"get":{"tags":["Core","Processes"],"summary":"Show","operationId":"show_api_processes__pid__get","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Processes"],"summary":"Delete","operationId":"delete_api_processes__pid__delete","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{workflow_key}":{"post":{"tags":["Core","Processes"],"summary":"New Process","operationId":"new_process_api_processes__workflow_key__post","parameters":[{"required":true,"schema":{"title":"Workflow Key","type":"string"},"name":"workflow_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Json Data"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessIdSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{pid}/resume":{"put":{"tags":["Core","Processes"],"summary":"Resume Process Endpoint","operationId":"resume_process_endpoint_api_processes__pid__resume_put","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Json Data"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{pid}/abort":{"put":{"tags":["Core","Processes"],"summary":"Abort Process Endpoint","operationId":"abort_process_endpoint_api_processes__pid__abort_put","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/process-subscriptions-by-subscription-id/{subscription_id}":{"get":{"tags":["Core","Processes"],"summary":"Process Subscriptions By Subscription Id","operationId":"process_subscriptions_by_subscription_id_api_processes_process_subscriptions_by_subscription_id__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Process Subscriptions By Subscription Id Api Processes Process Subscriptions By Subscription Id Subscription Id Get","type":"array","items":{"$ref":"#/components/schemas/ProcessSubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/process-subscriptions-by-pid/{pid}":{"get":{"tags":["Core","Processes"],"summary":"Process Subscriptions By Process Pid","operationId":"process_subscriptions_by_process_pid_api_processes_process_subscriptions_by_pid__pid__get","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Process Subscriptions By Process Pid Api Processes Process Subscriptions By Pid Pid Get","type":"array","items":{"$ref":"#/components/schemas/ProcessSubscriptionBaseSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/statuses":{"get":{"tags":["Core","Processes"],"summary":"Statuses","operationId":"statuses_api_processes_statuses_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessStatus"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/assignees":{"get":{"tags":["Core","Processes"],"summary":"Assignees","operationId":"assignees_api_processes_assignees_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Assignee"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/":{"get":{"tags":["Core","Processes"],"summary":"Processes Filterable","operationId":"processes_filterable_api_processes__get","parameters":[{"required":false,"schema":{"title":"Range","type":"string"},"name":"range","in":"query"},{"required":false,"schema":{"title":"Sort","type":"string"},"name":"sort","in":"query"},{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"},{"required":false,"schema":{"title":"If-None-Match","type":"string"},"name":"if-none-match","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Processes Filterable Api Processes Get","type":"array","items":{"$ref":"#/components/schemas/ProcessListItemSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/product_blocks/":{"get":{"tags":["Core","Product Blocks"],"summary":"Fetch","operationId":"fetch_api_product_blocks__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Fetch Api Product Blocks Get","type":"array","items":{"$ref":"#/components/schemas/ProductBlockEnrichedSchema"}}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Product Blocks"],"summary":"Update Product Block","operationId":"update_product_block_api_product_blocks__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBlockBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Product Blocks"],"summary":"Save Product Block","operationId":"save_product_block_api_product_blocks__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBlockBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/product_blocks/{product_block_id}":{"get":{"tags":["Core","Product Blocks"],"summary":"Product Block By Id","operationId":"product_block_by_id_api_product_blocks__product_block_id__get","parameters":[{"required":true,"schema":{"title":"Product Block Id","type":"string","format":"uuid"},"name":"product_block_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBlockEnrichedSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Product Blocks"],"summary":"Delete Product Block","operationId":"delete_product_block_api_product_blocks__product_block_id__delete","parameters":[{"required":true,"schema":{"title":"Product Block Id","type":"string","format":"uuid"},"name":"product_block_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/":{"get":{"tags":["Core","Product"],"summary":"Fetch","operationId":"fetch_api_products__get","parameters":[{"required":false,"schema":{"title":"Tag","type":"string"},"name":"tag","in":"query"},{"required":false,"schema":{"title":"Product Type","type":"string"},"name":"product_type","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Fetch Api Products Get","type":"array","items":{"$ref":"#/components/schemas/ProductSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Product"],"summary":"Update Product","operationId":"update_product_api_products__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCRUDSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Product"],"summary":"Save Product","operationId":"save_product_api_products__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCRUDSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/{product_id}":{"get":{"tags":["Core","Product"],"summary":"Product By Id","operationId":"product_by_id_api_products__product_id__get","parameters":[{"required":true,"schema":{"title":"Product Id","type":"string","format":"uuid"},"name":"product_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Product"],"summary":"Delete Product","operationId":"delete_product_api_products__product_id__delete","parameters":[{"required":true,"schema":{"title":"Product Id","type":"string","format":"uuid"},"name":"product_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/tags/all":{"get":{"tags":["Core","Product"],"summary":"Tags","operationId":"tags_api_products_tags_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Tags Api Products Tags All Get","type":"array","items":{"type":"string"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/types/all":{"get":{"tags":["Core","Product"],"summary":"Types","operationId":"types_api_products_types_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Types Api Products Types All Get","type":"array","items":{"type":"string"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/statuses/all":{"get":{"tags":["Core","Product"],"summary":"Statuses","operationId":"statuses_api_products_statuses_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductLifecycle"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/resource_types/":{"get":{"tags":["Core","Resource Types"],"summary":"Fetch","operationId":"fetch_api_resource_types__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Fetch Api Resource Types Get","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeSchema"}}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Resource Types"],"summary":"Update Resource Type","operationId":"update_resource_type_api_resource_types__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTypeSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Resource Types"],"summary":"Save Resource Type","operationId":"save_resource_type_api_resource_types__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTypeBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/resource_types/{resource_type_id}":{"get":{"tags":["Core","Resource Types"],"summary":"Resource Type By Id","operationId":"resource_type_by_id_api_resource_types__resource_type_id__get","parameters":[{"required":true,"schema":{"title":"Resource Type Id","type":"string","format":"uuid"},"name":"resource_type_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTypeSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Resource Types"],"summary":"Delete Resource Type","operationId":"delete_resource_type_api_resource_types__resource_type_id__delete","parameters":[{"required":true,"schema":{"title":"Resource Type Id","type":"string","format":"uuid"},"name":"resource_type_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/all":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscriptions All","description":"Return subscriptions with only a join on products.","operationId":"subscriptions_all_api_subscriptions_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Subscriptions All Api Subscriptions All Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/domain-model/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscription Details By Id With Domain Model","operationId":"subscription_details_by_id_with_domain_model_api_subscriptions_domain_model__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDomainModelSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/{subscription_id}":{"delete":{"tags":["Core","Subscriptions"],"summary":"Delete Subscription","operationId":"delete_subscription_api_subscriptions__subscription_id__delete","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/in_use_by_subscriptions/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Parent Subscriptions","operationId":"in_use_by_subscriptions_api_subscriptions_in_use_by_subscriptions__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Parent Subscriptions Api Subscriptions Parent Subscriptions Subscription Id Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/depends_on_subscriptions/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Child Subscriptions","operationId":"depends_on_subscriptions_api_subscriptions_depends_on_subscriptions__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Child Subscriptions Api Subscriptions Child Subscriptions Subscription Id Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscriptions Filterable","description":"Get subscriptions filtered.\n\nArgs:\n response: Fastapi Response object\n range: Range\n sort: Sort\n filter: Filter\n\nReturns:\n List of subscriptions","operationId":"subscriptions_filterable_api_subscriptions__get","parameters":[{"required":false,"schema":{"title":"Range","type":"string"},"name":"range","in":"query"},{"required":false,"schema":{"title":"Sort","type":"string"},"name":"sort","in":"query"},{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Subscriptions Filterable Api Subscriptions Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/workflows/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscription Workflows By Id","operationId":"subscription_workflows_by_id_api_subscriptions_workflows__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionWorkflowListsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscription_customer_descriptions/":{"put":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Update Subscription Customer Descriptions","operationId":"update_subscription_customer_descriptions_api_subscription_customer_descriptions__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Save Subscription Customer Description","operationId":"save_subscription_customer_description_api_subscription_customer_descriptions__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscription_customer_descriptions/{_id}":{"get":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Get Subscription Customer Descriptions","operationId":"get_subscription_customer_descriptions_api_subscription_customer_descriptions___id__get","parameters":[{"required":true,"schema":{"title":" Id","type":"string","format":"uuid"},"name":"_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Delete Subscription Customer Descriptions","operationId":"delete_subscription_customer_descriptions_api_subscription_customer_descriptions___id__delete","parameters":[{"required":true,"schema":{"title":" Id","type":"string","format":"uuid"},"name":"_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscription_customer_descriptions/customer/{customer_id}/subscription/{subscription_id}":{"get":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Get Subscription Customer Description By Customer Subscription","operationId":"get_subscription_customer_description_by_customer_subscription_api_subscription_customer_descriptions_customer__customer_id__subscription__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Customer Id","type":"string","format":"uuid"},"name":"customer_id","in":"path"},{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/user/error":{"post":{"tags":["Core","User"],"summary":"Log Error","operationId":"log_error_api_user_error_post","requestBody":{"content":{"application/json":{"schema":{"title":"Data","type":"object"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Log Error Api User Error Post","type":"object"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/user/log/{user_name}":{"post":{"tags":["Core","User"],"summary":"Log User Info","description":"Log frontend messages that are related to user actions.\n\nWhen the frontend finalizes the setup of a login session it will do a HTTP POST to this endpoint. The frontend\nwill also post to this endpoint when it ends a user session.\n\nArgs:\n user_name: the username (email) of the user involved\n message: A log message.\n\nReturns:\n {}","operationId":"log_user_info_api_user_log__user_name__post","parameters":[{"required":true,"schema":{"title":"User Name","type":"string"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Message","type":"object"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Log User Info Api User Log User Name Post","type":"object"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/workflows/":{"get":{"tags":["Core","Workflows"],"summary":"Get All","operationId":"get_all_api_workflows__get","parameters":[{"required":false,"schema":{"title":"Target","type":"string"},"name":"target","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get All Api Workflows Get","type":"array","items":{"$ref":"#/components/schemas/WorkflowSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/workflows/with_product_tags":{"get":{"tags":["Core","Workflows"],"summary":"Get All With Product Tags","operationId":"get_all_with_product_tags_api_workflows_with_product_tags_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get All With Product Tags Api Workflows With Product Tags Get","type":"array","items":{"$ref":"#/components/schemas/WorkflowWithProductTagsSchema"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/settings/cache/{name}":{"delete":{"tags":["Core","Settings"],"summary":"Clear Cache","operationId":"clear_cache_api_settings_cache__name__delete","parameters":[{"required":true,"schema":{"title":"Name","type":"string"},"name":"name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/settings/status":{"get":{"tags":["Core","Settings"],"summary":"Get Global Status","description":"Retrieve the global status object.\n\nReturns:\n The global status of the engine","operationId":"get_global_status_api_settings_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineSettingsSchema"}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Settings"],"summary":"Set Global Status","description":"Update the global status of the engine to a new state.\n\nArgs:\n body: The GlobalStatus object\n\nReturns:\n The updated global status object","operationId":"set_global_status_api_settings_status_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineSettingsBaseSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineSettingsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/health/":{"get":{"tags":["Core"],"summary":"Get Health","operationId":"get_health_api_health__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Health Api Health Get","type":"string"}}}}}}},"/api/translations/{language}":{"get":{"tags":["Core","Translations"],"summary":"Get Translations","operationId":"get_translations_api_translations__language__get","parameters":[{"required":true,"schema":{"title":"Language","type":"string"},"name":"language","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Translations Api Translations Language Get","type":"object"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Assignee":{"title":"Assignee","enum":["NOC","SYSTEM","CHANGES","KLANTSUPPORT"],"type":"string","description":"An enumeration."},"EngineSettingsBaseSchema":{"title":"EngineSettingsBaseSchema","required":["global_lock"],"type":"object","properties":{"global_lock":{"title":"Global Lock","type":"boolean"}}},"EngineSettingsSchema":{"title":"EngineSettingsSchema","required":["global_lock","running_processes"],"type":"object","properties":{"global_lock":{"title":"Global Lock","type":"boolean"},"global_status":{"$ref":"#/components/schemas/GlobalStatusEnum"},"running_processes":{"title":"Running Processes","type":"integer"}}},"FixedInputBaseSchema":{"title":"FixedInputBaseSchema","required":["name","value"],"type":"object","properties":{"fixed_input_id":{"title":"Fixed Input Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"value":{"title":"Value","type":"string"},"product_id":{"title":"Product Id","type":"string","format":"uuid"}}},"FixedInputConfigurationItemSchema":{"title":"FixedInputConfigurationItemSchema","required":["name","description","values"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"values":{"title":"Values","type":"array","items":{"type":"string"}}}},"FixedInputConfigurationSchema":{"title":"FixedInputConfigurationSchema","required":["fixed_inputs","by_tag"],"type":"object","properties":{"fixed_inputs":{"title":"Fixed Inputs","type":"array","items":{"$ref":"#/components/schemas/FixedInputConfigurationItemSchema"}},"by_tag":{"title":"By Tag","type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{"type":"boolean"}}}}}},"FixedInputSchema":{"title":"FixedInputSchema","required":["fixed_input_id","name","value","product_id","created_at"],"type":"object","properties":{"fixed_input_id":{"title":"Fixed Input Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"value":{"title":"Value","type":"string"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"GlobalStatusEnum":{"title":"GlobalStatusEnum","enum":["RUNNING","PAUSED","PAUSING"],"type":"string","description":"An enumeration."},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ProcessForm":{"title":"ProcessForm","required":["title","type","properties","additionalProperties"],"type":"object","properties":{"title":{"title":"Title","type":"string"},"type":{"title":"Type","type":"string"},"properties":{"title":"Properties","type":"object"},"additionalProperties":{"title":"Additionalproperties","type":"boolean"},"required":{"title":"Required","type":"array","items":{"type":"string"},"default":[]},"definitions":{"title":"Definitions","type":"object"}}},"ProcessIdSchema":{"title":"ProcessIdSchema","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"}}},"ProcessListItemSchema":{"title":"ProcessListItemSchema","required":["assignee","last_modified_at","pid","started_at","last_status","workflow","is_task","subscriptions"],"type":"object","properties":{"assignee":{"$ref":"#/components/schemas/Assignee"},"created_by":{"title":"Created By","type":"string"},"failed_reason":{"title":"Failed Reason","type":"string"},"last_modified_at":{"title":"Last Modified At","type":"string","format":"date-time"},"pid":{"title":"Pid","type":"string","format":"uuid"},"started_at":{"title":"Started At","type":"string","format":"date-time"},"last_status":{"$ref":"#/components/schemas/ProcessStatus"},"last_step":{"title":"Last Step","type":"string"},"workflow":{"title":"Workflow","type":"string"},"workflow_target":{"$ref":"#/components/schemas/Target"},"is_task":{"title":"Is Task","type":"boolean"},"subscriptions":{"title":"Subscriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}},"ProcessSchema":{"title":"ProcessSchema","required":["id","workflow_name","assignee","status","started","last_modified","subscriptions","is_task","current_state","steps"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"workflow_name":{"title":"Workflow Name","type":"string"},"product":{"title":"Product","type":"string","format":"uuid"},"customer":{"title":"Customer","type":"string","format":"uuid"},"assignee":{"$ref":"#/components/schemas/Assignee"},"failed_reason":{"title":"Failed Reason","type":"string"},"traceback":{"title":"Traceback","type":"string"},"step":{"title":"Step","type":"string"},"status":{"$ref":"#/components/schemas/ProcessStatus"},"last_step":{"title":"Last Step","type":"string"},"created_by":{"title":"Created By","type":"string"},"started":{"title":"Started","type":"string","format":"date-time"},"last_modified":{"title":"Last Modified","type":"string","format":"date-time"},"subscriptions":{"title":"Subscriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionBaseSchema"}},"is_task":{"title":"Is Task","type":"boolean"},"current_state":{"title":"Current State","type":"object"},"steps":{"title":"Steps","type":"array","items":{"$ref":"#/components/schemas/ProcessStepSchema"}},"form":{"$ref":"#/components/schemas/ProcessForm"}}},"ProcessStatus":{"title":"ProcessStatus","enum":["created","running","suspended","waiting","aborted","failed","api_unavailable","inconsistent_data","completed"],"type":"string","description":"An enumeration."},"ProcessStepSchema":{"title":"ProcessStepSchema","required":["name","status"],"type":"object","properties":{"stepid":{"title":"Stepid","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"status":{"title":"Status","type":"string"},"created_by":{"title":"Created By","type":"string"},"executed":{"title":"Executed","type":"string","format":"date-time"},"commit_hash":{"title":"Commit Hash","type":"string"},"state":{"title":"State","type":"object"}}},"ProcessSubscriptionBaseSchema":{"title":"ProcessSubscriptionBaseSchema","required":["subscription_id","id","pid","created_at"],"type":"object","properties":{"workflow_target":{"$ref":"#/components/schemas/Target"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"id":{"title":"Id","type":"string","format":"uuid"},"pid":{"title":"Pid","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"ProcessSubscriptionProcessSchema":{"title":"ProcessSubscriptionProcessSchema","required":["workflow","pid","is_task","started_at","last_status","assignee","last_modified_at"],"type":"object","properties":{"workflow":{"title":"Workflow","type":"string"},"pid":{"title":"Pid","type":"string","format":"uuid"},"is_task":{"title":"Is Task","type":"boolean"},"created_by":{"title":"Created By","type":"string"},"failed_reason":{"title":"Failed Reason","type":"string"},"started_at":{"title":"Started At","type":"string","format":"date-time"},"last_status":{"$ref":"#/components/schemas/ProcessStatus"},"assignee":{"$ref":"#/components/schemas/Assignee"},"last_modified_at":{"title":"Last Modified At","type":"string","format":"date-time"},"traceback":{"title":"Traceback","type":"string"},"last_step":{"title":"Last Step","type":"string"}}},"ProcessSubscriptionSchema":{"title":"ProcessSubscriptionSchema","required":["subscription_id","id","pid","created_at","process"],"type":"object","properties":{"workflow_target":{"$ref":"#/components/schemas/Target"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"id":{"title":"Id","type":"string","format":"uuid"},"pid":{"title":"Pid","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"process":{"$ref":"#/components/schemas/ProcessSubscriptionProcessSchema"}}},"ProductBaseSchema":{"title":"ProductBaseSchema","required":["name","description","product_type","status","tag"],"type":"object","properties":{"product_id":{"title":"Product Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"product_type":{"title":"Product Type","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"tag":{"title":"Tag","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"}}},"ProductBlockBaseSchema":{"title":"ProductBlockBaseSchema","required":["name","description"],"type":"object","properties":{"product_block_id":{"title":"Product Block Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"tag":{"title":"Tag","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"resource_types":{"title":"Resource Types","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeBaseSchema"}}}},"ProductBlockEnrichedSchema":{"title":"ProductBlockEnrichedSchema","required":["product_block_id","name","description","status"],"type":"object","properties":{"product_block_id":{"title":"Product Block Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"tag":{"title":"Tag","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"resource_types":{"title":"Resource Types","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeSchema"}}}},"ProductBlockSchema":{"title":"ProductBlockSchema","required":["product_block_id","name","description","status","created_at"],"type":"object","properties":{"product_block_id":{"title":"Product Block Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"tag":{"title":"Tag","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"resource_types":{"title":"Resource Types","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeBaseSchema"}},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"}}},"ProductCRUDSchema":{"title":"ProductCRUDSchema","required":["name","description","product_type","status","tag"],"type":"object","properties":{"product_id":{"title":"Product Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"product_type":{"title":"Product Type","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"tag":{"title":"Tag","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product_blocks":{"title":"Product Blocks","type":"array","items":{"$ref":"#/components/schemas/ProductBlockBaseSchema"}},"fixed_inputs":{"title":"Fixed Inputs","type":"array","items":{"$ref":"#/components/schemas/FixedInputBaseSchema"}}}},"ProductLifecycle":{"title":"ProductLifecycle","enum":["active","pre production","phase out","end of life"],"type":"string","description":"An enumeration."},"ProductSchema":{"title":"ProductSchema","required":["product_id","name","description","product_type","status","tag","created_at","product_blocks","fixed_inputs","workflows"],"type":"object","properties":{"product_id":{"title":"Product Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"product_type":{"title":"Product Type","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"tag":{"title":"Tag","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product_blocks":{"title":"Product Blocks","type":"array","items":{"$ref":"#/components/schemas/ProductBlockSchema"}},"fixed_inputs":{"title":"Fixed Inputs","type":"array","items":{"$ref":"#/components/schemas/FixedInputSchema"}},"workflows":{"title":"Workflows","type":"array","items":{"$ref":"#/components/schemas/WorkflowSchema"}}}},"ResourceTypeBaseSchema":{"title":"ResourceTypeBaseSchema","required":["resource_type"],"type":"object","properties":{"resource_type":{"title":"Resource Type","type":"string"},"description":{"title":"Description","type":"string"},"resource_type_id":{"title":"Resource Type Id","type":"string","format":"uuid"}}},"ResourceTypeSchema":{"title":"ResourceTypeSchema","required":["resource_type","resource_type_id"],"type":"object","properties":{"resource_type":{"title":"Resource Type","type":"string"},"description":{"title":"Description","type":"string"},"resource_type_id":{"title":"Resource Type Id","type":"string","format":"uuid"}}},"SubscriptionBaseSchema":{"title":"SubscriptionBaseSchema","required":["description","status","customer_id","insync"],"type":"object","properties":{"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"start_date":{"title":"Start Date","type":"string","format":"date-time"},"description":{"title":"Description","type":"string"},"status":{"$ref":"#/components/schemas/SubscriptionLifecycle"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"insync":{"title":"Insync","type":"boolean"},"note":{"title":"Note","type":"string"}}},"SubscriptionDescriptionBaseSchema":{"title":"SubscriptionDescriptionBaseSchema","required":["description","customer_id","subscription_id"],"type":"object","properties":{"description":{"title":"Description","type":"string"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"}}},"SubscriptionDescriptionSchema":{"title":"SubscriptionDescriptionSchema","required":["description","customer_id","subscription_id","id"],"type":"object","properties":{"description":{"title":"Description","type":"string"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"id":{"title":"Id","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"SubscriptionDomainModelSchema":{"title":"SubscriptionDomainModelSchema","required":["subscription_id","description","status","customer_id","insync","customer_descriptions"],"type":"object","properties":{"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"start_date":{"title":"Start Date","type":"string","format":"date-time"},"description":{"title":"Description","type":"string"},"status":{"$ref":"#/components/schemas/SubscriptionLifecycle"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"insync":{"title":"Insync","type":"boolean"},"note":{"title":"Note","type":"string"},"name":{"title":"Name","type":"string"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product":{"$ref":"#/components/schemas/ProductBaseSchema"},"customer_descriptions":{"title":"Customer Descriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}},"tag":{"title":"Tag","type":"string"}}},"SubscriptionLifecycle":{"title":"SubscriptionLifecycle","enum":["initial","active","migrating","disabled","terminated","provisioning"],"type":"string","description":"An enumeration."},"SubscriptionSchema":{"title":"SubscriptionSchema","required":["subscription_id","description","status","customer_id","insync"],"type":"object","properties":{"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"start_date":{"title":"Start Date","type":"string","format":"date-time"},"description":{"title":"Description","type":"string"},"status":{"$ref":"#/components/schemas/SubscriptionLifecycle"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"insync":{"title":"Insync","type":"boolean"},"note":{"title":"Note","type":"string"},"name":{"title":"Name","type":"string"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product":{"$ref":"#/components/schemas/ProductBaseSchema"},"customer_descriptions":{"title":"Customer Descriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}},"tag":{"title":"Tag","type":"string"}}},"SubscriptionWorkflowListsSchema":{"title":"SubscriptionWorkflowListsSchema","required":["create","modify","terminate","system"],"type":"object","properties":{"reason":{"title":"Reason","type":"string"},"locked_relations":{"title":"Locked Relations","type":"array","items":{"type":"string","format":"uuid"}},"create":{"title":"Create","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}},"modify":{"title":"Modify","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}},"terminate":{"title":"Terminate","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}},"system":{"title":"System","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}}}},"Target":{"title":"Target","enum":["CREATE","MODIFY","TERMINATE","SYSTEM"],"type":"string","description":"An enumeration."},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"WorkflowListItemSchema":{"title":"WorkflowListItemSchema","required":["name"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"reason":{"title":"Reason","type":"string"},"usable_when":{"title":"Usable When","type":"array","items":{}},"status":{"title":"Status","type":"string"},"action":{"title":"Action","type":"string"},"locked_relations":{"title":"Locked Relations","type":"array","items":{"type":"string","format":"uuid"}},"unterminated_depends_on_subscriptions":{"title":"Unterminated Parents","type":"array","items":{"type":"string","format":"uuid"}}}},"WorkflowSchema":{"title":"WorkflowSchema","required":["name","target","created_at","workflow_id"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"target":{"$ref":"#/components/schemas/Target"},"description":{"title":"Description","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"workflow_id":{"title":"Workflow Id","type":"string","format":"uuid"}}},"WorkflowWithProductTagsSchema":{"title":"WorkflowWithProductTagsSchema","required":["name","target","product_tags"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"target":{"$ref":"#/components/schemas/Target"},"description":{"title":"Description","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"product_tags":{"title":"Product Tags","type":"array","items":{"type":"string"}}}}},"securitySchemes":{"OIDCUser":{"type":"http","scheme":"bearer"}}}} +{"openapi":"3.0.2","info":{"title":"The Orchestrator","description":"The orchestrator is a project that enables users to run workflows.","version":"1.0.0"},"paths":{"/api/fixed_inputs/configuration":{"get":{"tags":["Core","Fixed Inputs"],"summary":"Fi Configuration","operationId":"fi_configuration_api_fixed_inputs_configuration_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FixedInputConfigurationSchema"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{pid}":{"get":{"tags":["Core","Processes"],"summary":"Show","operationId":"show_api_processes__pid__get","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Processes"],"summary":"Delete","operationId":"delete_api_processes__pid__delete","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{workflow_key}":{"post":{"tags":["Core","Processes"],"summary":"New Process","operationId":"new_process_api_processes__workflow_key__post","parameters":[{"required":true,"schema":{"title":"Workflow Key","type":"string"},"name":"workflow_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Json Data"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessIdSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{pid}/resume":{"put":{"tags":["Core","Processes"],"summary":"Resume Process Endpoint","operationId":"resume_process_endpoint_api_processes__pid__resume_put","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Json Data"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/{pid}/abort":{"put":{"tags":["Core","Processes"],"summary":"Abort Process Endpoint","operationId":"abort_process_endpoint_api_processes__pid__abort_put","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/process-subscriptions-by-subscription-id/{subscription_id}":{"get":{"tags":["Core","Processes"],"summary":"Process Subscriptions By Subscription Id","operationId":"process_subscriptions_by_subscription_id_api_processes_process_subscriptions_by_subscription_id__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Process Subscriptions By Subscription Id Api Processes Process Subscriptions By Subscription Id Subscription Id Get","type":"array","items":{"$ref":"#/components/schemas/ProcessSubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/process-subscriptions-by-pid/{pid}":{"get":{"tags":["Core","Processes"],"summary":"Process Subscriptions By Process Pid","operationId":"process_subscriptions_by_process_pid_api_processes_process_subscriptions_by_pid__pid__get","parameters":[{"required":true,"schema":{"title":"Pid","type":"string","format":"uuid"},"name":"pid","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Process Subscriptions By Process Pid Api Processes Process Subscriptions By Pid Pid Get","type":"array","items":{"$ref":"#/components/schemas/ProcessSubscriptionBaseSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/statuses":{"get":{"tags":["Core","Processes"],"summary":"Statuses","operationId":"statuses_api_processes_statuses_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProcessStatus"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/assignees":{"get":{"tags":["Core","Processes"],"summary":"Assignees","operationId":"assignees_api_processes_assignees_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Assignee"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/processes/":{"get":{"tags":["Core","Processes"],"summary":"Processes Filterable","operationId":"processes_filterable_api_processes__get","parameters":[{"required":false,"schema":{"title":"Range","type":"string"},"name":"range","in":"query"},{"required":false,"schema":{"title":"Sort","type":"string"},"name":"sort","in":"query"},{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"},{"required":false,"schema":{"title":"If-None-Match","type":"string"},"name":"if-none-match","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Processes Filterable Api Processes Get","type":"array","items":{"$ref":"#/components/schemas/ProcessListItemSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/product_blocks/":{"get":{"tags":["Core","Product Blocks"],"summary":"Fetch","operationId":"fetch_api_product_blocks__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Fetch Api Product Blocks Get","type":"array","items":{"$ref":"#/components/schemas/ProductBlockEnrichedSchema"}}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Product Blocks"],"summary":"Update Product Block","operationId":"update_product_block_api_product_blocks__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBlockBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Product Blocks"],"summary":"Save Product Block","operationId":"save_product_block_api_product_blocks__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBlockBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/product_blocks/{product_block_id}":{"get":{"tags":["Core","Product Blocks"],"summary":"Product Block By Id","operationId":"product_block_by_id_api_product_blocks__product_block_id__get","parameters":[{"required":true,"schema":{"title":"Product Block Id","type":"string","format":"uuid"},"name":"product_block_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductBlockEnrichedSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Product Blocks"],"summary":"Delete Product Block","operationId":"delete_product_block_api_product_blocks__product_block_id__delete","parameters":[{"required":true,"schema":{"title":"Product Block Id","type":"string","format":"uuid"},"name":"product_block_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/":{"get":{"tags":["Core","Product"],"summary":"Fetch","operationId":"fetch_api_products__get","parameters":[{"required":false,"schema":{"title":"Tag","type":"string"},"name":"tag","in":"query"},{"required":false,"schema":{"title":"Product Type","type":"string"},"name":"product_type","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Fetch Api Products Get","type":"array","items":{"$ref":"#/components/schemas/ProductSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Product"],"summary":"Update Product","operationId":"update_product_api_products__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCRUDSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Product"],"summary":"Save Product","operationId":"save_product_api_products__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCRUDSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/{product_id}":{"get":{"tags":["Core","Product"],"summary":"Product By Id","operationId":"product_by_id_api_products__product_id__get","parameters":[{"required":true,"schema":{"title":"Product Id","type":"string","format":"uuid"},"name":"product_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Product"],"summary":"Delete Product","operationId":"delete_product_api_products__product_id__delete","parameters":[{"required":true,"schema":{"title":"Product Id","type":"string","format":"uuid"},"name":"product_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/tags/all":{"get":{"tags":["Core","Product"],"summary":"Tags","operationId":"tags_api_products_tags_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Tags Api Products Tags All Get","type":"array","items":{"type":"string"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/types/all":{"get":{"tags":["Core","Product"],"summary":"Types","operationId":"types_api_products_types_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Types Api Products Types All Get","type":"array","items":{"type":"string"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/products/statuses/all":{"get":{"tags":["Core","Product"],"summary":"Statuses","operationId":"statuses_api_products_statuses_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductLifecycle"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/resource_types/":{"get":{"tags":["Core","Resource Types"],"summary":"Fetch","operationId":"fetch_api_resource_types__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Fetch Api Resource Types Get","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeSchema"}}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Resource Types"],"summary":"Update Resource Type","operationId":"update_resource_type_api_resource_types__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTypeSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Resource Types"],"summary":"Save Resource Type","operationId":"save_resource_type_api_resource_types__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTypeBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/resource_types/{resource_type_id}":{"get":{"tags":["Core","Resource Types"],"summary":"Resource Type By Id","operationId":"resource_type_by_id_api_resource_types__resource_type_id__get","parameters":[{"required":true,"schema":{"title":"Resource Type Id","type":"string","format":"uuid"},"name":"resource_type_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceTypeSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Resource Types"],"summary":"Delete Resource Type","operationId":"delete_resource_type_api_resource_types__resource_type_id__delete","parameters":[{"required":true,"schema":{"title":"Resource Type Id","type":"string","format":"uuid"},"name":"resource_type_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/all":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscriptions All","description":"Return subscriptions with only a join on products.","operationId":"subscriptions_all_api_subscriptions_all_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Subscriptions All Api Subscriptions All Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/domain-model/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscription Details By Id With Domain Model","operationId":"subscription_details_by_id_with_domain_model_api_subscriptions_domain_model__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDomainModelSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/{subscription_id}":{"delete":{"tags":["Core","Subscriptions"],"summary":"Delete Subscription","operationId":"delete_subscription_api_subscriptions__subscription_id__delete","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/in_use_by_subscriptions/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Parent Subscriptions","operationId":"in_use_by_subscriptions_api_subscriptions_in_use_by_subscriptions__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Parent Subscriptions Api Subscriptions Parent Subscriptions Subscription Id Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/depends_on_subscriptions/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Child Subscriptions","operationId":"depends_on_subscriptions_api_subscriptions_depends_on_subscriptions__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Child Subscriptions Api Subscriptions Child Subscriptions Subscription Id Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscriptions Filterable","description":"Get subscriptions filtered.\n\nArgs:\n response: Fastapi Response object\n range: Range\n sort: Sort\n filter: Filter\n\nReturns:\n List of subscriptions","operationId":"subscriptions_filterable_api_subscriptions__get","parameters":[{"required":false,"schema":{"title":"Range","type":"string"},"name":"range","in":"query"},{"required":false,"schema":{"title":"Sort","type":"string"},"name":"sort","in":"query"},{"required":false,"schema":{"title":"Filter","type":"string"},"name":"filter","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Subscriptions Filterable Api Subscriptions Get","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscriptions/workflows/{subscription_id}":{"get":{"tags":["Core","Subscriptions"],"summary":"Subscription Workflows By Id","operationId":"subscription_workflows_by_id_api_subscriptions_workflows__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionWorkflowListsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscription_customer_descriptions/":{"put":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Update Subscription Customer Descriptions","operationId":"update_subscription_customer_descriptions_api_subscription_customer_descriptions__put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"post":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Save Subscription Customer Description","operationId":"save_subscription_customer_description_api_subscription_customer_descriptions__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionBaseSchema"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscription_customer_descriptions/{_id}":{"get":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Get Subscription Customer Descriptions","operationId":"get_subscription_customer_descriptions_api_subscription_customer_descriptions___id__get","parameters":[{"required":true,"schema":{"title":" Id","type":"string","format":"uuid"},"name":"_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]},"delete":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Delete Subscription Customer Descriptions","operationId":"delete_subscription_customer_descriptions_api_subscription_customer_descriptions___id__delete","parameters":[{"required":true,"schema":{"title":" Id","type":"string","format":"uuid"},"name":"_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/subscription_customer_descriptions/customer/{customer_id}/subscription/{subscription_id}":{"get":{"tags":["Core","Subscription Customer Descriptions"],"summary":"Get Subscription Customer Description By Customer Subscription","operationId":"get_subscription_customer_description_by_customer_subscription_api_subscription_customer_descriptions_customer__customer_id__subscription__subscription_id__get","parameters":[{"required":true,"schema":{"title":"Customer Id","type":"string","format":"uuid"},"name":"customer_id","in":"path"},{"required":true,"schema":{"title":"Subscription Id","type":"string","format":"uuid"},"name":"subscription_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/user/error":{"post":{"tags":["Core","User"],"summary":"Log Error","operationId":"log_error_api_user_error_post","requestBody":{"content":{"application/json":{"schema":{"title":"Data","type":"object"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Log Error Api User Error Post","type":"object"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/user/log/{user_name}":{"post":{"tags":["Core","User"],"summary":"Log User Info","description":"Log frontend messages that are related to user actions.\n\nWhen the frontend finalizes the setup of a login session it will do a HTTP POST to this endpoint. The frontend\nwill also post to this endpoint when it ends a user session.\n\nArgs:\n user_name: the username (email) of the user involved\n message: A log message.\n\nReturns:\n {}","operationId":"log_user_info_api_user_log__user_name__post","parameters":[{"required":true,"schema":{"title":"User Name","type":"string"},"name":"user_name","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"title":"Message","type":"object"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Log User Info Api User Log User Name Post","type":"object"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/workflows/":{"get":{"tags":["Core","Workflows"],"summary":"Get All","operationId":"get_all_api_workflows__get","parameters":[{"required":false,"schema":{"title":"Target","type":"string"},"name":"target","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get All Api Workflows Get","type":"array","items":{"$ref":"#/components/schemas/WorkflowSchema"}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/workflows/with_product_tags":{"get":{"tags":["Core","Workflows"],"summary":"Get All With Product Tags","operationId":"get_all_with_product_tags_api_workflows_with_product_tags_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get All With Product Tags Api Workflows With Product Tags Get","type":"array","items":{"$ref":"#/components/schemas/WorkflowWithProductTagsSchema"}}}}}},"security":[{"OIDCUser":[]}]}},"/api/settings/cache/{name}":{"delete":{"tags":["Core","Settings"],"summary":"Clear Cache","operationId":"clear_cache_api_settings_cache__name__delete","parameters":[{"required":true,"schema":{"title":"Name","type":"string"},"name":"name","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/settings/status":{"get":{"tags":["Core","Settings"],"summary":"Get Global Status","description":"Retrieve the global status object.\n\nReturns:\n The global status of the engine","operationId":"get_global_status_api_settings_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineSettingsSchema"}}}}},"security":[{"OIDCUser":[]}]},"put":{"tags":["Core","Settings"],"summary":"Set Global Status","description":"Update the global status of the engine to a new state.\n\nArgs:\n body: The GlobalStatus object\n\nReturns:\n The updated global status object","operationId":"set_global_status_api_settings_status_put","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineSettingsBaseSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EngineSettingsSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OIDCUser":[]}]}},"/api/health/":{"get":{"tags":["Core"],"summary":"Get Health","operationId":"get_health_api_health__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Health Api Health Get","type":"string"}}}}}}},"/api/translations/{language}":{"get":{"tags":["Core","Translations"],"summary":"Get Translations","operationId":"get_translations_api_translations__language__get","parameters":[{"required":true,"schema":{"title":"Language","type":"string"},"name":"language","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Translations Api Translations Language Get","type":"object"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Assignee":{"title":"Assignee","enum":["NOC","SYSTEM","CHANGES","KLANTSUPPORT"],"type":"string","description":"An enumeration."},"EngineSettingsBaseSchema":{"title":"EngineSettingsBaseSchema","required":["global_lock"],"type":"object","properties":{"global_lock":{"title":"Global Lock","type":"boolean"}}},"EngineSettingsSchema":{"title":"EngineSettingsSchema","required":["global_lock","running_processes"],"type":"object","properties":{"global_lock":{"title":"Global Lock","type":"boolean"},"global_status":{"$ref":"#/components/schemas/GlobalStatusEnum"},"running_processes":{"title":"Running Processes","type":"integer"}}},"FixedInputBaseSchema":{"title":"FixedInputBaseSchema","required":["name","value"],"type":"object","properties":{"fixed_input_id":{"title":"Fixed Input Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"value":{"title":"Value","type":"string"},"product_id":{"title":"Product Id","type":"string","format":"uuid"}}},"FixedInputConfigurationItemSchema":{"title":"FixedInputConfigurationItemSchema","required":["name","description","values"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"values":{"title":"Values","type":"array","items":{"type":"string"}}}},"FixedInputConfigurationSchema":{"title":"FixedInputConfigurationSchema","required":["fixed_inputs","by_tag"],"type":"object","properties":{"fixed_inputs":{"title":"Fixed Inputs","type":"array","items":{"$ref":"#/components/schemas/FixedInputConfigurationItemSchema"}},"by_tag":{"title":"By Tag","type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{"type":"boolean"}}}}}},"FixedInputSchema":{"title":"FixedInputSchema","required":["fixed_input_id","name","value","product_id","created_at"],"type":"object","properties":{"fixed_input_id":{"title":"Fixed Input Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"value":{"title":"Value","type":"string"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"GlobalStatusEnum":{"title":"GlobalStatusEnum","enum":["RUNNING","PAUSED","PAUSING"],"type":"string","description":"An enumeration."},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ProcessForm":{"title":"ProcessForm","required":["title","type","properties","additionalProperties"],"type":"object","properties":{"title":{"title":"Title","type":"string"},"type":{"title":"Type","type":"string"},"properties":{"title":"Properties","type":"object"},"additionalProperties":{"title":"Additionalproperties","type":"boolean"},"required":{"title":"Required","type":"array","items":{"type":"string"},"default":[]},"definitions":{"title":"Definitions","type":"object"}}},"ProcessIdSchema":{"title":"ProcessIdSchema","required":["id"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"}}},"ProcessListItemSchema":{"title":"ProcessListItemSchema","required":["assignee","last_modified_at","pid","started_at","last_status","workflow","is_task","subscriptions"],"type":"object","properties":{"assignee":{"$ref":"#/components/schemas/Assignee"},"created_by":{"title":"Created By","type":"string"},"failed_reason":{"title":"Failed Reason","type":"string"},"last_modified_at":{"title":"Last Modified At","type":"string","format":"date-time"},"pid":{"title":"Pid","type":"string","format":"uuid"},"started_at":{"title":"Started At","type":"string","format":"date-time"},"last_status":{"$ref":"#/components/schemas/ProcessStatus"},"last_step":{"title":"Last Step","type":"string"},"workflow":{"title":"Workflow","type":"string"},"workflow_target":{"$ref":"#/components/schemas/Target"},"is_task":{"title":"Is Task","type":"boolean"},"subscriptions":{"title":"Subscriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchema"}}}},"ProcessSchema":{"title":"ProcessSchema","required":["id","workflow_name","assignee","status","started","last_modified","subscriptions","is_task","current_state","steps"],"type":"object","properties":{"id":{"title":"Id","type":"string","format":"uuid"},"workflow_name":{"title":"Workflow Name","type":"string"},"product":{"title":"Product","type":"string","format":"uuid"},"customer":{"title":"Customer","type":"string","format":"uuid"},"assignee":{"$ref":"#/components/schemas/Assignee"},"failed_reason":{"title":"Failed Reason","type":"string"},"traceback":{"title":"Traceback","type":"string"},"step":{"title":"Step","type":"string"},"status":{"$ref":"#/components/schemas/ProcessStatus"},"last_step":{"title":"Last Step","type":"string"},"created_by":{"title":"Created By","type":"string"},"started":{"title":"Started","type":"string","format":"date-time"},"last_modified":{"title":"Last Modified","type":"string","format":"date-time"},"subscriptions":{"title":"Subscriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionBaseSchema"}},"is_task":{"title":"Is Task","type":"boolean"},"current_state":{"title":"Current State","type":"object"},"steps":{"title":"Steps","type":"array","items":{"$ref":"#/components/schemas/ProcessStepSchema"}},"form":{"$ref":"#/components/schemas/ProcessForm"}}},"ProcessStatus":{"title":"ProcessStatus","enum":["created","running","suspended","waiting","aborted","failed","api_unavailable","inconsistent_data","completed"],"type":"string","description":"An enumeration."},"ProcessStepSchema":{"title":"ProcessStepSchema","required":["name","status"],"type":"object","properties":{"stepid":{"title":"Stepid","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"status":{"title":"Status","type":"string"},"created_by":{"title":"Created By","type":"string"},"executed":{"title":"Executed","type":"string","format":"date-time"},"commit_hash":{"title":"Commit Hash","type":"string"},"state":{"title":"State","type":"object"}}},"ProcessSubscriptionBaseSchema":{"title":"ProcessSubscriptionBaseSchema","required":["subscription_id","id","pid","created_at"],"type":"object","properties":{"workflow_target":{"$ref":"#/components/schemas/Target"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"id":{"title":"Id","type":"string","format":"uuid"},"pid":{"title":"Pid","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"ProcessSubscriptionProcessSchema":{"title":"ProcessSubscriptionProcessSchema","required":["workflow","pid","is_task","started_at","last_status","assignee","last_modified_at"],"type":"object","properties":{"workflow":{"title":"Workflow","type":"string"},"pid":{"title":"Pid","type":"string","format":"uuid"},"is_task":{"title":"Is Task","type":"boolean"},"created_by":{"title":"Created By","type":"string"},"failed_reason":{"title":"Failed Reason","type":"string"},"started_at":{"title":"Started At","type":"string","format":"date-time"},"last_status":{"$ref":"#/components/schemas/ProcessStatus"},"assignee":{"$ref":"#/components/schemas/Assignee"},"last_modified_at":{"title":"Last Modified At","type":"string","format":"date-time"},"traceback":{"title":"Traceback","type":"string"},"last_step":{"title":"Last Step","type":"string"}}},"ProcessSubscriptionSchema":{"title":"ProcessSubscriptionSchema","required":["subscription_id","id","pid","created_at","process"],"type":"object","properties":{"workflow_target":{"$ref":"#/components/schemas/Target"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"id":{"title":"Id","type":"string","format":"uuid"},"pid":{"title":"Pid","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"process":{"$ref":"#/components/schemas/ProcessSubscriptionProcessSchema"}}},"ProductBaseSchema":{"title":"ProductBaseSchema","required":["name","description","product_type","status","tag"],"type":"object","properties":{"product_id":{"title":"Product Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"product_type":{"title":"Product Type","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"tag":{"title":"Tag","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"}}},"ProductBlockBaseSchema":{"title":"ProductBlockBaseSchema","required":["name","description"],"type":"object","properties":{"product_block_id":{"title":"Product Block Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"tag":{"title":"Tag","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"resource_types":{"title":"Resource Types","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeBaseSchema"}}}},"ProductBlockEnrichedSchema":{"title":"ProductBlockEnrichedSchema","required":["product_block_id","name","description","status"],"type":"object","properties":{"product_block_id":{"title":"Product Block Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"tag":{"title":"Tag","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"resource_types":{"title":"Resource Types","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeSchema"}}}},"ProductBlockSchema":{"title":"ProductBlockSchema","required":["product_block_id","name","description","status","created_at"],"type":"object","properties":{"product_block_id":{"title":"Product Block Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"tag":{"title":"Tag","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"resource_types":{"title":"Resource Types","type":"array","items":{"$ref":"#/components/schemas/ResourceTypeBaseSchema"}},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"}}},"ProductCRUDSchema":{"title":"ProductCRUDSchema","required":["name","description","product_type","status","tag"],"type":"object","properties":{"product_id":{"title":"Product Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"product_type":{"title":"Product Type","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"tag":{"title":"Tag","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product_blocks":{"title":"Product Blocks","type":"array","items":{"$ref":"#/components/schemas/ProductBlockBaseSchema"}},"fixed_inputs":{"title":"Fixed Inputs","type":"array","items":{"$ref":"#/components/schemas/FixedInputBaseSchema"}}}},"ProductLifecycle":{"title":"ProductLifecycle","enum":["active","pre production","phase out","end of life"],"type":"string","description":"An enumeration."},"ProductSchema":{"title":"ProductSchema","required":["product_id","name","description","product_type","status","tag","created_at","product_blocks","fixed_inputs","workflows"],"type":"object","properties":{"product_id":{"title":"Product Id","type":"string","format":"uuid"},"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"product_type":{"title":"Product Type","type":"string"},"status":{"$ref":"#/components/schemas/ProductLifecycle"},"tag":{"title":"Tag","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product_blocks":{"title":"Product Blocks","type":"array","items":{"$ref":"#/components/schemas/ProductBlockSchema"}},"fixed_inputs":{"title":"Fixed Inputs","type":"array","items":{"$ref":"#/components/schemas/FixedInputSchema"}},"workflows":{"title":"Workflows","type":"array","items":{"$ref":"#/components/schemas/WorkflowSchema"}}}},"ResourceTypeBaseSchema":{"title":"ResourceTypeBaseSchema","required":["resource_type"],"type":"object","properties":{"resource_type":{"title":"Resource Type","type":"string"},"description":{"title":"Description","type":"string"},"resource_type_id":{"title":"Resource Type Id","type":"string","format":"uuid"}}},"ResourceTypeSchema":{"title":"ResourceTypeSchema","required":["resource_type","resource_type_id"],"type":"object","properties":{"resource_type":{"title":"Resource Type","type":"string"},"description":{"title":"Description","type":"string"},"resource_type_id":{"title":"Resource Type Id","type":"string","format":"uuid"}}},"SubscriptionBaseSchema":{"title":"SubscriptionBaseSchema","required":["description","status","customer_id","insync"],"type":"object","properties":{"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"start_date":{"title":"Start Date","type":"string","format":"date-time"},"description":{"title":"Description","type":"string"},"status":{"$ref":"#/components/schemas/SubscriptionLifecycle"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"insync":{"title":"Insync","type":"boolean"},"note":{"title":"Note","type":"string"}}},"SubscriptionDescriptionBaseSchema":{"title":"SubscriptionDescriptionBaseSchema","required":["description","customer_id","subscription_id"],"type":"object","properties":{"description":{"title":"Description","type":"string"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"}}},"SubscriptionDescriptionSchema":{"title":"SubscriptionDescriptionSchema","required":["description","customer_id","subscription_id","id"],"type":"object","properties":{"description":{"title":"Description","type":"string"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"id":{"title":"Id","type":"string","format":"uuid"},"created_at":{"title":"Created At","type":"string","format":"date-time"}}},"SubscriptionDomainModelSchema":{"title":"SubscriptionDomainModelSchema","required":["subscription_id","description","status","customer_id","insync","customer_descriptions"],"type":"object","properties":{"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"start_date":{"title":"Start Date","type":"string","format":"date-time"},"description":{"title":"Description","type":"string"},"status":{"$ref":"#/components/schemas/SubscriptionLifecycle"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"insync":{"title":"Insync","type":"boolean"},"note":{"title":"Note","type":"string"},"name":{"title":"Name","type":"string"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product":{"$ref":"#/components/schemas/ProductBaseSchema"},"customer_descriptions":{"title":"Customer Descriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}},"tag":{"title":"Tag","type":"string"}}},"SubscriptionLifecycle":{"title":"SubscriptionLifecycle","enum":["initial","active","migrating","disabled","terminated","provisioning"],"type":"string","description":"An enumeration."},"SubscriptionSchema":{"title":"SubscriptionSchema","required":["subscription_id","description","status","customer_id","insync"],"type":"object","properties":{"subscription_id":{"title":"Subscription Id","type":"string","format":"uuid"},"start_date":{"title":"Start Date","type":"string","format":"date-time"},"description":{"title":"Description","type":"string"},"status":{"$ref":"#/components/schemas/SubscriptionLifecycle"},"product_id":{"title":"Product Id","type":"string","format":"uuid"},"customer_id":{"title":"Customer Id","type":"string","format":"uuid"},"insync":{"title":"Insync","type":"boolean"},"note":{"title":"Note","type":"string"},"name":{"title":"Name","type":"string"},"end_date":{"title":"End Date","type":"string","format":"date-time"},"product":{"$ref":"#/components/schemas/ProductBaseSchema"},"customer_descriptions":{"title":"Customer Descriptions","type":"array","items":{"$ref":"#/components/schemas/SubscriptionDescriptionSchema"}},"tag":{"title":"Tag","type":"string"}}},"SubscriptionWorkflowListsSchema":{"title":"SubscriptionWorkflowListsSchema","required":["create","modify","terminate","system"],"type":"object","properties":{"reason":{"title":"Reason","type":"string"},"locked_relations":{"title":"Locked Relations","type":"array","items":{"type":"string","format":"uuid"}},"create":{"title":"Create","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}},"modify":{"title":"Modify","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}},"terminate":{"title":"Terminate","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}},"system":{"title":"System","type":"array","items":{"$ref":"#/components/schemas/WorkflowListItemSchema"}}}},"Target":{"title":"Target","enum":["CREATE","MODIFY","TERMINATE","SYSTEM"],"type":"string","description":"An enumeration."},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}},"WorkflowListItemSchema":{"title":"WorkflowListItemSchema","required":["name"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"description":{"title":"Description","type":"string"},"reason":{"title":"Reason","type":"string"},"usable_when":{"title":"Usable When","type":"array","items":{}},"status":{"title":"Status","type":"string"},"action":{"title":"Action","type":"string"},"locked_relations":{"title":"Locked Relations","type":"array","items":{"type":"string","format":"uuid"}},"unterminated_in_use_by_subscriptions":{"title":"Unterminated Parents","type":"array","items":{"type":"string","format":"uuid"}}}},"WorkflowSchema":{"title":"WorkflowSchema","required":["name","target","created_at","workflow_id"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"target":{"$ref":"#/components/schemas/Target"},"description":{"title":"Description","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"workflow_id":{"title":"Workflow Id","type":"string","format":"uuid"}}},"WorkflowWithProductTagsSchema":{"title":"WorkflowWithProductTagsSchema","required":["name","target","product_tags"],"type":"object","properties":{"name":{"title":"Name","type":"string"},"target":{"$ref":"#/components/schemas/Target"},"description":{"title":"Description","type":"string"},"created_at":{"title":"Created At","type":"string","format":"date-time"},"product_tags":{"title":"Product Tags","type":"array","items":{"type":"string"}}}}},"securitySchemes":{"OIDCUser":{"type":"http","scheme":"bearer"}}}} diff --git a/docs/architecture/application/workflow.md b/docs/architecture/application/workflow.md index ef2b6537b..579df6565 100644 --- a/docs/architecture/application/workflow.md +++ b/docs/architecture/application/workflow.md @@ -128,7 +128,7 @@ These workflows have more in common with each other than not, it's mostly a matt By default, the associated workflow can only be run on a subscription with a lifecycle state set to `ACTIVE`. This behavior can be changed in the following data structure in the `workflows/__init__.py` file: ```python -from orchestrator.services.subscriptions import WF_BLOCKED_BY_DEPENDS_ON_SUBSCRIPTIONS +from orchestrator.services.subscriptions import WF_BLOCKED_BY_IN_USE_BY_SUBSCRIPTIONS WF_USABLE_MAP.update( { diff --git a/orchestrator/__init__.py b/orchestrator/__init__.py index e21ee107c..43cfa0bc8 100644 --- a/orchestrator/__init__.py +++ b/orchestrator/__init__.py @@ -13,7 +13,7 @@ """This is the orchestrator workflow engine.""" -__version__ = "0.4.0-rc3" +__version__ = "0.4.0-rc4" from orchestrator.app import OrchestratorCore from orchestrator.settings import app_settings, oauth2_settings diff --git a/orchestrator/schemas/workflow.py b/orchestrator/schemas/workflow.py index 1c25929c0..ab179e0d8 100644 --- a/orchestrator/schemas/workflow.py +++ b/orchestrator/schemas/workflow.py @@ -46,9 +46,9 @@ class WorkflowListItemSchema(OrchestratorBaseModel): status: Optional[str] action: Optional[str] locked_relations: Optional[List[UUID]] - # unterminated_parents deprecated since "0.4.0" renamed to unterminated_depends_on_subscriptions + # unterminated_parents deprecated since "0.4.0" renamed to unterminated_in_use_by_subscriptions unterminated_parents: Optional[List[UUID]] - unterminated_depends_on_subscriptions: Optional[List[UUID]] + unterminated_in_use_by_subscriptions: Optional[List[UUID]] class SubscriptionWorkflowListsSchema(OrchestratorBaseModel): diff --git a/orchestrator/services/subscriptions.py b/orchestrator/services/subscriptions.py index 8cf6b8dba..139a348b4 100644 --- a/orchestrator/services/subscriptions.py +++ b/orchestrator/services/subscriptions.py @@ -457,7 +457,7 @@ def status_relations(subscription: SubscriptionTable) -> Dict[str, List[UUID]]: """ in_use_by_query = query_in_use_by_subscriptions(subscription.subscription_id) - unterminated_depends_on_subscriptions = _terminated_filter(in_use_by_query) + unterminated_in_use_by_subscriptions = _terminated_filter(in_use_by_query) locked_in_use_by_block_relations = _in_sync_filter(in_use_by_query) depends_on_query = query_depends_on_subscriptions(subscription.subscription_id) @@ -466,9 +466,9 @@ def status_relations(subscription: SubscriptionTable) -> Dict[str, List[UUID]]: result = { "locked_relations": locked_in_use_by_block_relations + locked_depends_on_block_relations, - # unterminated_parents deprecated since "0.4.0", renamed to unterminated_depends_on_subscriptions - "unterminated_parents": unterminated_depends_on_subscriptions, - "unterminated_depends_on_subscriptions": unterminated_depends_on_subscriptions, + # unterminated_parents deprecated since "0.4.0", renamed to unterminated_in_use_by_subscriptions + "unterminated_parents": unterminated_in_use_by_subscriptions, + "unterminated_in_use_by_subscriptions": unterminated_in_use_by_subscriptions, } logger.debug( @@ -496,9 +496,9 @@ def get_relations(subscription_id: UUIDstr) -> Dict[str, List[UUID]]: WF_USABLE_MAP: Dict[str, List[str]] = {} -# WF_BLOCKED_BY_PARENTS deprecated since "0.4.0", renamed to WF_BLOCKED_BY_DEPENDS_ON_SUBSCRIPTIONS +# WF_BLOCKED_BY_PARENTS deprecated since "0.4.0", renamed to WF_BLOCKED_BY_IN_USE_BY_SUBSCRIPTIONS WF_BLOCKED_BY_PARENTS: Dict[str, bool] = {} -WF_BLOCKED_BY_DEPENDS_ON_SUBSCRIPTIONS: Dict[str, bool] = {} +WF_BLOCKED_BY_IN_USE_BY_SUBSCRIPTIONS: Dict[str, bool] = {} WF_USABLE_WHILE_OUT_OF_SYNC: List[str] = ["modify_note"] @@ -560,20 +560,20 @@ def subscription_workflows(subscription: SubscriptionTable) -> Dict[str, Any]: workflow_json["action"] = "terminated" if workflow.target == Target.TERMINATE else "modified" # Check if this workflow is blocked because there are unterminated relations - blocked_by_depends_on_subscriptions = WF_BLOCKED_BY_DEPENDS_ON_SUBSCRIPTIONS.get( + blocked_by_depends_on_subscriptions = WF_BLOCKED_BY_IN_USE_BY_SUBSCRIPTIONS.get( workflow.name, workflow.target == Target.TERMINATE ) - # WF_BLOCKED_BY_PARENTS deprecated since "0.4.0", renamed to WF_BLOCKED_BY_DEPENDS_ON_SUBSCRIPTIONS + # WF_BLOCKED_BY_PARENTS deprecated since "0.4.0", renamed to WF_BLOCKED_BY_IN_USE_BY_SUBSCRIPTIONS if not blocked_by_depends_on_subscriptions: blocked_by_depends_on_subscriptions = WF_BLOCKED_BY_PARENTS.get( workflow.name, workflow.target == Target.TERMINATE ) - if blocked_by_depends_on_subscriptions and data["unterminated_depends_on_subscriptions"]: + if blocked_by_depends_on_subscriptions and data["unterminated_in_use_by_subscriptions"]: workflow_json["reason"] = "subscription.no_modify_subscription_in_use_by_others" - # unterminated_parents deprecated since "0.4.0", renamed to unterminated_depends_on_subscriptions + # unterminated_parents deprecated since "0.4.0", renamed to unterminated_in_use_by_subscriptions workflow_json["unterminated_parents"] = data["unterminated_parents"] - workflow_json["unterminated_depends_on_subscriptions"] = data["unterminated_depends_on_subscriptions"] + workflow_json["unterminated_in_use_by_subscriptions"] = data["unterminated_in_use_by_subscriptions"] workflow_json["action"] = "terminated" if workflow.target == Target.TERMINATE else "modified" workflows[workflow.target.lower()].append(workflow_json)