##  [Resource Manager API](/docs/resource-manager-api-0-1-0) 

Source file

Attached file *explore.aws-pre-prod-api-resources-v1.json* with *json* extension available at *https://developer.synopsys.com/system/files/2026-03/explore.aws-pre-prod-api-resources-v1.json* follows:  
*{ "openapi": "3.1.0", "info": { "title": "Resource Manager API", "summary": "Service to manage resources to run the jobs.", "description": "\\nResource Manager API enables CRUD operations on resources such as queues, deployments, applications,\\nand app-runtime-configs.\\n\\n### Features\\n\\n\*\*Queues\*\*\\n- Create queues with custom storage, resource limits, and environment variables.\\n- Specify resource limits in two ways:\\n - `maximum\_allowed\_worker\_instances`: Maximum concurrent worker instances in the queue (`-1` means unlimited).\\n - `maximum\_allowed\_resources`: Maximum CPU and memory resources for the queue (currently only CPU is supported).\\n - If a job specifies `resources\_requested`, it is used.\\n - Otherwise, the application's `default\_resources` (from AppRuntimeConfig) are used.\\n - If neither is specified, the queue's `maximum\_resources` are used.\\n- Manage queues to configure applications within resource limits and group applications with similar storage needs.\\n\\n\*\*Plugins\*\*\\n- Register plugins defining container runtimes (e.g., Docker Engine, Kubernetes).\\n\\n\*\*Jobs\*\*\\n- Submit jobs by providing application details (name, version, image, environment variables, etc.).\\n- Track job status and clean up resources after completion.\\n", "contact": { "name": "Ansys AVxcelerate Autonomy", "url": "https://developer.ansys.com/docs/avxcelerate", "email": "TeamTyson@ansys.com" }, "version": "0.1.0" }, "servers": \[ { "url": "/api/resources/v1" } \], "paths": { "/health": { "get": { "tags": \[ "health" \], "summary": "Health", "description": "Returns healthy message.", "operationId": "health-health", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Response Health-Health" } } } } }, "security": \[ { "HTTPBearer": \[\] } \] } }, "/queues": { "post": { "tags": \[ "queues" \], "summary": "Create Queue", "description": "Create a new queue.\\n\\n:param queue: The queue to create", "operationId": "queues-create\_queue", "security": \[ { "HTTPBearer": \[\] } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Queues-Create Queue" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": \[ "queues" \], "summary": "Update Queue", "description": "Update a queue using its name.\\n\\n:param queue: The queue to update", "operationId": "queues-update\_queue", "security": \[ { "HTTPBearer": \[\] } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Queues-Update Queue" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": \[ "queues" \], "summary": "Get Queues", "description": "Get all queues using filter.\\n\\n:param filter\_exp: OData filter to filter queues\\n:param offset: items to skip\\n:param limit: number of items to retrieve", "operationId": "queues-get\_queues", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 100, "title": "The pagination limit" } }, { "name": "filter\_exp", "in": "query", "required": false, "schema": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "Filter expression", "description": "The expression must be compatible with OData" }, "description": "The expression must be compatible with OData" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "title": "The pagination offset", "default": 0 } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueueRead" }, "title": "Response Queues-Get Queues" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/queues/{queue\_id}": { "get": { "tags": \[ "queues" \], "summary": "Get Queue", "description": "Get a queue by its id.\\n\\n:param queue\_id: id of the queue to retrieve", "operationId": "queues-get\_queue", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "queue\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Queue Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueueRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/jobs": { "post": { "tags": \[ "jobs" \], "summary": "Create Job", "description": "Create a new job.\\n\\n:param job: The job to create", "operationId": "jobs-create\_job", "security": \[ { "HTTPBearer": \[\] } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Jobs-Create Job" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": \[ "jobs" \], "summary": "Get Jobs", "description": "Get all jobs using filter.\\n\\n:param filter: OData filter to filter jobs\\n:param offset: items to skip\\n:param limit: number of items to retrieve", "operationId": "jobs-get\_jobs", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 100, "title": "Limit" } }, { "name": "filter\_exp", "in": "query", "required": false, "schema": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "Filter Exp" } }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0, "title": "Offset" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JobRead" }, "title": "Response Jobs-Get Jobs" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/jobs/{job\_id}": { "get": { "tags": \[ "jobs" \], "summary": "Get Job", "description": "Get a job by its id.\\n\\n:param job\_id: id of the job to retrieve", "operationId": "jobs-get\_job", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "job\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/jobs/{job\_id}/status": { "get": { "tags": \[ "jobs" \], "summary": "Get Job Status", "description": "Get job status by its id.\\n\\n:param job\_id: id of the job to retrieve", "operationId": "jobs-get\_job\_status", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "job\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatusEnum" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/jobs/{job\_id}/job-stats": { "get": { "tags": \[ "jobs" \], "summary": "Get Job Stats", "description": "Get job containers statistics by its id.\\n\\nFormat of the response:\\n\\n.. code-block:: json\\n\\n{\\n \\"containers\\": {\\n \\"\\u003Cjob-subtask-1-name\\u003E\\": {\\n \\"name\\": \\"\\u003Cjob-subtask-1-container-name\\u003E\\",\\n \\"exit\_codes\\": {\\n \\"\\u003Cexit-code-1\\u003E\\" : \\u003Cnumber of containers exited with exit-code-1\\u003E,\\n \\"\\u003Cexit-code-2\\u003E\\" : \\u003Cnumber of containers exited with exit-code-2\\u003E,\\n ...\\n }\\n },\\n ...\\n }\\n}\\n\\n\\n:param job\_id: id of the job to retrieve", "operationId": "jobs-get\_job\_stats", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "job\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobContainerStats" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/jobs/{job\_id}/clean": { "post": { "tags": \[ "jobs" \], "summary": "Clean Job", "description": "Clean job resources.\\n\\n:param job\_id: id of the job to clean", "operationId": "jobs-clean\_job", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "job\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Job Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/plugins": { "get": { "tags": \[ "plugins" \], "summary": "Get Plugins", "description": "Get all plugins.", "operationId": "plugins-get\_plugins", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PluginConfiguration" }, "type": "array", "title": "Response Plugins-Get Plugins" } } } } }, "security": \[ { "HTTPBearer": \[\] } \] }, "post": { "tags": \[ "plugins" \], "summary": "Register Plugin", "description": "Register a new plugin.\\n\\n:param plugin: The plugin configuration", "operationId": "plugins-register\_plugin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginConfiguration" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginConfiguration" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": \[ { "HTTPBearer": \[\] } \] } }, "/applications": { "get": { "tags": \[ "applications" \], "summary": "Get Applications", "description": "Get applications.", "operationId": "applications-get\_applications", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 100, "title": "The pagination limit" } }, { "name": "filter\_exp", "in": "query", "required": false, "schema": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "Filter expression", "description": "The expression must be compatible with OData" }, "description": "The expression must be compatible with OData" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "title": "The pagination offset", "default": 0 } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApplicationRead" }, "title": "Response Applications-Get Applications" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": \[ "applications" \], "summary": "Create Application", "description": "Creates a new application.\\n\\n:param application: The application to create", "operationId": "applications-create\_application", "security": \[ { "HTTPBearer": \[\] } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Applications-Create Application" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": \[ "applications" \], "summary": "Update Application", "description": "Updates an application.\\n\\n:param application: The application to update", "operationId": "applications-update\_application", "security": \[ { "HTTPBearer": \[\] } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response Applications-Update Application" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/applications/{app\_id}": { "get": { "tags": \[ "applications" \], "summary": "Get Application", "description": "Gets application by its id.\\n\\n:param app\_id: id of the application", "operationId": "applications-get\_application", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "app\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "App Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/app-runtime-config/application/{app\_id}": { "get": { "tags": \[ "app-runtime-config" \], "summary": "Get App Runtime Configs For Application", "description": "Get all AppRuntimeConfigs registered for the given application id.\\n\\nIt retrieves the queues for the provided application from AppRuntimeConfig Model.\\n\\n:param app\_id: Optional field if provided returns the registered queues for given application\\n:param filter\_exp: OData filter to filter queues\\n:param offset: items to skip\\n:param limit: number of items to retrieve", "operationId": "app-runtime-config-get\_app\_runtime\_configs\_for\_application", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "app\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "App Id" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "integer", "maximum": 100, "title": "The pagination limit" } }, { "name": "filter\_exp", "in": "query", "required": false, "schema": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "Filter expression", "description": "The expression must be compatible with OData" }, "description": "The expression must be compatible with OData" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "title": "The pagination offset", "default": 0 } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AppRuntimeConfigRead" }, "title": "Response App-Runtime-Config-Get App Runtime Configs For Application" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/app-runtime-config": { "get": { "tags": \[ "app-runtime-config" \], "summary": "Get App Runtime Config", "description": "Get application queue for given queue id and application id.\\n\\n:param queue\_id: queue id\\n:param app\_id: application id", "operationId": "app-runtime-config-get\_app\_runtime\_config", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "queue\_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "Queue Id" } }, { "name": "app\_id", "in": "query", "required": true, "schema": { "type": "integer", "title": "App Id" } } \], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppRuntimeConfigRead" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/app-runtime-config/{queue\_id}/application/{app\_id}": { "post": { "tags": \[ "app-runtime-config" \], "summary": "Register Application To Queue", "description": "Registers an application to the provided queue.\\n\\n:param queue\_id: The queue where the application will be registered\\n:param app\_id: The application to register", "operationId": "app-runtime-config-register\_application\_to\_queue", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "queue\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Queue Id" } }, { "name": "app\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "App Id" } } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppRuntimeConfigCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response App-Runtime-Config-Register Application To Queue" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": \[ "app-runtime-config" \], "summary": "Update Application To Queue", "description": "Update an application to the provided queue.\\n\\n:param queue\_id: The queue where the application will be registered\\n:param app\_id: The application to update", "operationId": "app-runtime-config-update\_application\_to\_queue", "security": \[ { "HTTPBearer": \[\] } \], "parameters": \[ { "name": "queue\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "Queue Id" } }, { "name": "app\_id", "in": "path", "required": true, "schema": { "type": "integer", "title": "App Id" } } \], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppRuntimeConfigCreate" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "integer", "title": "Response App-Runtime-Config-Update Application To Queue" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AppRuntimeConfigAttributes": { "properties": { "image": { "type": "string", "title": "Image" }, "command": { "items": { "type": "string" }, "type": "array", "title": "Command" }, "working\_dir": { "type": "string", "title": "Working Dir" }, "mount": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Mount" }, "network": { "type": "string", "title": "Network" }, "ports": { "items": { "type": "integer" }, "type": "array", "title": "Ports" } }, "type": "object", "title": "AppRuntimeConfigAttributes", "description": "Attribute definition for AppRuntimeConfig data model." }, "AppRuntimeConfigCreate": { "properties": { "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "default\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "attributes": { "anyOf": \[ { "$ref": "#/components/schemas/AppRuntimeConfigAttributes" }, { "type": "null" } \] }, "service\_port": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Service Port" } }, "type": "object", "title": "AppRuntimeConfigCreate", "description": "AppRuntimeConfig definition for creation." }, "AppRuntimeConfigRead": { "properties": { "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "default\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "attributes": { "anyOf": \[ { "$ref": "#/components/schemas/AppRuntimeConfigAttributes" }, { "type": "null" } \] }, "service\_port": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Service Port" }, "app\_id": { "type": "integer", "title": "App Id" }, "queue\_id": { "type": "integer", "title": "Queue Id" }, "application": { "$ref": "#/components/schemas/ApplicationRead" }, "queue": { "$ref": "#/components/schemas/QueueRead" } }, "type": "object", "required": \[ "app\_id", "queue\_id", "application", "queue" \], "title": "AppRuntimeConfigRead", "description": "Public application queue definition." }, "ApplicationAttributes": { "properties": { "kpis": { "items": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object" }, "type": "array", "title": "Kpis" }, "asset\_declarations": { "additionalProperties": { "$ref": "#/components/schemas/AssetDeclaration" }, "type": "object", "title": "Asset Declarations" }, "features": { "additionalProperties": { "$ref": "#/components/schemas/FeatureDefinition" }, "type": "object", "title": "Features" }, "solver\_settings": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Solver Settings" }, "command": { "items": { "type": "string" }, "type": "array", "title": "Command" } }, "type": "object", "title": "ApplicationAttributes", "description": "Attribute definition for Application data model." }, "ApplicationCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "version": { "type": "string", "title": "Version" }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "parent": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Parent" }, "application\_type": { "type": "string", "title": "Application Type" }, "attributes": { "anyOf": \[ { "$ref": "#/components/schemas/ApplicationAttributes" }, { "type": "null" } \] } }, "type": "object", "required": \[ "name", "version" \], "title": "ApplicationCreate", "description": "Application definition for creation." }, "ApplicationRead": { "properties": { "name": { "type": "string", "title": "Name" }, "version": { "type": "string", "title": "Version" }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "parent": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Parent" }, "application\_type": { "type": "string", "title": "Application Type" }, "attributes": { "anyOf": \[ { "$ref": "#/components/schemas/ApplicationAttributes" }, { "type": "null" } \] }, "id": { "type": "integer", "title": "Id" } }, "type": "object", "required": \[ "name", "version", "id" \], "title": "ApplicationRead", "description": "Public application definition." }, "AssetDeclaration": { "properties": { "label": { "type": "string", "title": "Label" }, "asset\_type": { "type": "string", "title": "Asset Type" }, "file\_format": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "File Format" }, "description": { "type": "string", "title": "Description" }, "is\_optional": { "type": "boolean", "title": "Is Optional" }, "is\_list": { "type": "boolean", "title": "Is List" }, "is\_parametrizable": { "type": "boolean", "title": "Is Parametrizable" } }, "type": "object", "required": \[ "label", "asset\_type", "file\_format", "description", "is\_optional", "is\_list", "is\_parametrizable" \], "title": "AssetDeclaration", "description": "Asset declaration for simulation loop configuration." }, "ContainerStat": { "properties": { "name": { "type": "string", "title": "Name" }, "exit\_codes": { "additionalProperties": { "type": "integer" }, "type": "object", "title": "Exit Codes" } }, "type": "object", "required": \[ "name", "exit\_codes" \], "title": "ContainerStat", "description": "Statistics stored per container." }, "FeatureDefinition": { "properties": { "label": { "type": "string", "title": "Label" }, "description": { "type": "string", "title": "Description" }, "is\_optional": { "type": "boolean", "title": "Is Optional" } }, "type": "object", "required": \[ "label", "description", "is\_optional" \], "title": "FeatureDefinition", "description": "Asset declaration for simulation loop configuration." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "JobContainerStats": { "properties": { "containers": { "additionalProperties": { "$ref": "#/components/schemas/ContainerStat" }, "type": "object", "title": "Containers" } }, "type": "object", "required": \[ "containers" \], "title": "JobContainerStats", "description": "Statistics stored per container." }, "JobCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "queue\_id": { "type": "integer", "title": "Queue Id" }, "parent\_job\_id": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Parent Job Id" }, "application\_id": { "type": "integer", "title": "Application Id" }, "arguments": { "items": { "type": "string" }, "type": "array", "title": "Arguments", "default": \[\] }, "replica\_count": { "type": "integer", "title": "Replica Count", "default": 1 }, "auto\_clean": { "type": "boolean", "title": "Auto Clean", "default": false }, "resources\_requested": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Labels", "default": { } }, "attributes": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Attributes", "default": { } } }, "type": "object", "required": \[ "name", "queue\_id", "application\_id" \], "title": "JobCreate", "description": "Job definition on creation." }, "JobRead": { "properties": { "name": { "type": "string", "title": "Name" }, "queue\_id": { "type": "integer", "title": "Queue Id" }, "parent\_job\_id": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Parent Job Id" }, "application\_id": { "type": "integer", "title": "Application Id" }, "arguments": { "items": { "type": "string" }, "type": "array", "title": "Arguments", "default": \[\] }, "replica\_count": { "type": "integer", "title": "Replica Count", "default": 1 }, "auto\_clean": { "type": "boolean", "title": "Auto Clean", "default": false }, "resources\_requested": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "labels": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Labels", "default": { } }, "attributes": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Attributes", "default": { } }, "id": { "type": "integer", "title": "Id" }, "internal\_id": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "Internal Id" }, "status": { "$ref": "#/components/schemas/JobStatusEnum" }, "cleaned": { "type": "boolean", "title": "Cleaned" }, "created\_at": { "anyOf": \[ { "type": "string", "format": "date-time" }, { "type": "null" } \], "title": "Created At" }, "status\_updated\_at": { "anyOf": \[ { "type": "string", "format": "date-time" }, { "type": "null" } \], "title": "Status Updated At" }, "failed\_reason": { "anyOf": \[ { "type": "string" }, { "type": "null" } \], "title": "Failed Reason" } }, "type": "object", "required": \[ "name", "queue\_id", "application\_id", "id", "internal\_id", "status", "cleaned", "created\_at", "status\_updated\_at", "failed\_reason" \], "title": "JobRead", "description": "Public job definition." }, "JobStatusEnum": { "type": "string", "enum": \[ "pending", "scheduled", "running", "failed", "succeeded" \], "title": "JobStatusEnum", "description": "Enum of job status." }, "JsonValue": { }, "PluginConfiguration": { "properties": { "name": { "type": "string", "title": "Name" }, "module\_name": { "type": "string", "title": "Module Name" }, "class\_name": { "type": "string", "title": "Class Name" }, "attributes": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Attributes", "default": { } } }, "type": "object", "required": \[ "name", "module\_name", "class\_name" \], "title": "PluginConfiguration", "description": "Plugin configuration." }, "QueueCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "plugin": { "type": "string", "title": "Plugin" }, "working\_dir": { "type": "string", "title": "Working Dir", "default": "/jobs" }, "default\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "maximum\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "maximum\_allowed\_worker\_instances": { "type": "integer", "title": "Maximum Allowed Worker Instances", "default": -1 }, "maximum\_allowed\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "attributes": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Attributes", "default": { } }, "storages": { "items": { "$ref": "#/components/schemas/JsonValue" }, "type": "array", "title": "Storages", "default": \[\] }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } } }, "type": "object", "required": \[ "name", "description", "plugin" \], "title": "QueueCreate", "description": "Queue definition for creation." }, "QueueRead": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description" }, "plugin": { "type": "string", "title": "Plugin" }, "working\_dir": { "type": "string", "title": "Working Dir", "default": "/jobs" }, "default\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "maximum\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "maximum\_allowed\_worker\_instances": { "type": "integer", "title": "Maximum Allowed Worker Instances", "default": -1 }, "maximum\_allowed\_resources": { "anyOf": \[ { "$ref": "#/components/schemas/ResourcesDefinition" }, { "type": "null" } \] }, "attributes": { "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "type": "object", "title": "Attributes", "default": { } }, "storages": { "items": { "$ref": "#/components/schemas/JsonValue" }, "type": "array", "title": "Storages", "default": \[\] }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env", "default": { } }, "id": { "type": "integer", "title": "Id" } }, "type": "object", "required": \[ "name", "description", "plugin", "id" \], "title": "QueueRead", "description": "Public queue definition." }, "ResourcesDefinition": { "properties": { "cpu": { "anyOf": \[ { "type": "number" }, { "type": "null" } \], "title": "Cpu" }, "memory\_gb": { "anyOf": \[ { "type": "number" }, { "type": "null" } \], "title": "Memory Gb" }, "nvidia\_gpu": { "anyOf": \[ { "type": "integer" }, { "type": "null" } \], "title": "Nvidia Gpu" } }, "type": "object", "title": "ResourcesDefinition", "description": "Resource definition." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": \[ { "type": "string" }, { "type": "integer" } \] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": \[ "loc", "msg", "type" \], "title": "ValidationError" } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } } }*