Updated Resource Manager REST API doc for 2026R1.1 beta-1 release

2026R1.1-beta-1/AVX_Assets_Manager_API_V1_ArchV2/changelog-asset-manager.md

@@ -0,0 +1,5 @@
+## Version 0.1.0: Initial release
+
+v0.1.0 of the AVxcelerate Asset Manager REST API has been officially released as part of the 2025 R2.2 release.
+
+The AVxcelerate Resource Manager REST API v0.1.0 is compatible with the AVX Architecture V2.

2026R1.1-beta-1/AVX_Explore_Resources_API_V1_ArchV2/changelog.md

@@ -0,0 +1,15 @@
+## Version 0.1.0: Initial release
+
+v0.1.0 of the AVxcelerate Resource Manager REST API has been officially released as part of the 2025 R2 release.
+
+The AVxcelerate Resource Manager REST API v0.1.0 is compatible with the AVX Architecture V2.
+
+## Version 0.1.0: September 2025R2.2 release (V1)
+
+New Features:
+
+* The "maximum_allowed_worker_instances" parameter has been added and it allows you to configure the maximum number of parallel running workers per queue. 
+
+## Version 0.1.0: November 2026R1.1 Beta-1 release
+
+The process to create and configure a queue has been added. This feature can be used to allocate a specific node group to a specific queue and select this queue in the Avx simulation job template configuration in the Explore & Analyze Web app.

2026R1.1-beta-1/AVX_Extensions_Services_API_V1_ArchV2/changelog-extensions.md

@@ -0,0 +1,6 @@
+## Version 0.1.0: Initial release
+
+v0.1.0 of the AVxcelerate Resource Manager REST API has been officially released as part of the 2025 R2.2 release.
+
+The AVxcelerate Resource Manager REST API v0.1.0 is compatible with the AVX Architecture V2.
+

2026R1.1-beta-1/AVX_Post_Controller_API_V1_ArchV2/changelog-post-controller.md

@@ -0,0 +1,9 @@
+## Version 0.1.0: Initial release
+
+v0.1.0 of the AVxcelerate Resource Manager REST API has been officially released as part of the 2025 R2.2 release.
+
+The AVxcelerate Resource Manager REST API v0.1.0 is compatible with the AVX Architecture V2.
+
+Feature List: 
+
+It is possible to download concrete scenario files for specific simulations. 

2026R1.1-beta-1/AVX_Post_Controller_API_V1_ArchV2/explore.aws-pre-prod-api-post-controller-v1.json

@@ -0,0 +1 @@
+{"openapi":"3.1.0","info":{"title":"AVxcelerate Post Controller","summary":"Service to manage post processing jobs","version":"0.1.0"},"servers":[{"url":"/transient-services/exp-ea1f3db4-557c-44dc-abec-5243227e36d7-post-service/UKnylwME6pK-NcW7Oz0XExA9WrJlgOf2yzwT3vV3IBHhyLaujBibTrC8G4F6pmq71Ni7rNKmGbEHaBrSBer-dw"}],"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":[]}]}},"/v1/usage":{"get":{"tags":["main"],"summary":"Get Health","description":"Check health of the service.\n\nAllow client to keep alive the service in auto-shutdown mode.","operationId":"main-get_health","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageStats"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/state":{"get":{"tags":["main"],"summary":"Get State","description":"Get state of the job.","operationId":"main-get_state","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateModel"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/refresh":{"post":{"tags":["main"],"summary":"Refresh","description":"Refresh data from persistent store.","operationId":"main-refresh","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/extensions":{"post":{"tags":["main"],"summary":"Load Extension","description":"Loads an extension and activates it.","operationId":"main-load_extension","parameters":[{"name":"extension_id","in":"query","required":true,"schema":{"type":"string","title":"Extension Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/simulation-results/iterations":{"get":{"tags":["simulation-results"],"summary":"Get Iterations","description":"Returns list of iterations.","operationId":"simulation-results-get_iterations","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"integer"},"type":"array","title":"Response Simulation-Results-Get Iterations"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/simulation-results/iterations/{iteration}":{"get":{"tags":["simulation-results"],"summary":"Get Iteration Data","description":"Get results data.","operationId":"simulation-results-get_iteration_data","parameters":[{"name":"iteration","in":"path","required":true,"schema":{"type":"integer","title":"Iteration"}},{"name":"$filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"$Filter"}},{"name":"$skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"$Skip"}},{"name":"$top","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"$Top"}},{"name":"$select","in":"query","required":false,"schema":{"type":"string","default":"*","title":"$Select"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultsData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/simulation-results":{"get":{"tags":["simulation-results"],"summary":"Get Data","description":"Get results data.","operationId":"simulation-results-get_data","parameters":[{"name":"$filter","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"$Filter"}},{"name":"$skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"$Skip"}},{"name":"$top","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"$Top"}},{"name":"$select","in":"query","required":false,"schema":{"type":"string","default":"*","title":"$Select"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultsData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/simulation-results/scalar-results":{"get":{"tags":["simulation-results"],"summary":"Get Scalar","description":"Gets all scalar results.","operationId":"simulation-results-get_scalar","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResultsData"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/files:list":{"get":{"tags":["files"],"summary":"Get Files","description":"Get results data.","operationId":"files-get_files","parameters":[{"name":"path","in":"query","required":false,"schema":{"type":"string","default":"","title":"Path"}},{"name":"recursive","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Recursive"}},{"name":"filter_regex","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter Regex"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Files-Get Files"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/files:download":{"get":{"tags":["files"],"summary":"Get File","description":"Get file.","operationId":"files-get_file","parameters":[{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"Path"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/files/stream/{file_path}":{"get":{"tags":["files"],"summary":"Stream File","description":"Stream the content of the passed file path.\n\n:param file_path: Path of the file to stream.\n:param range_header: Standard HTTP header indicating the part of a resource that the server should return\n:return: StreamingResponse: The response containing the trace file.","operationId":"files-stream_file","parameters":[{"name":"file_path","in":"path","required":true,"schema":{"type":"string","title":"File Path"}},{"name":"range","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Range"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/v1/files/stream-intermediate-file/":{"get":{"tags":["files"],"summary":"Stream Intermediate File","description":"Stream the concrete sample files for the passed sample list.\n\n:param samples: List of sample ids from all iterations, starting from 1.\n:param filter_by_asset_declaration_list: List of filter_by_asset_declaration_list to download.\n\n:return: StreamingResponse: The response containing archive of intermediate files.","operationId":"files-stream_intermediate_file","parameters":[{"name":"samples","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Samples"}},{"name":"filter_by_asset_declaration_list","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filter By Asset Declaration List"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"JsonValue":{},"ResultsData":{"properties":{"columns":{"items":{"type":"string"},"type":"array","title":"Columns","default":[]},"data":{"items":{"items":{"$ref":"#/components/schemas/JsonValue"},"type":"array"},"type":"array","title":"Data","default":[]},"metadata":{"allOf":[{"$ref":"#/components/schemas/JsonValue"}],"default":{}}},"type":"object","title":"ResultsData","description":"Raw results data returned by the Post Controller REST API."},"SamplesStatusInfo":{"properties":{"Success":{"type":"integer","title":"Success"},"Failed":{"type":"integer","title":"Failed"},"Pending":{"type":"integer","title":"Pending"},"Scheduled":{"type":"integer","title":"Scheduled"}},"type":"object","required":["Success","Failed","Pending","Scheduled"],"title":"SamplesStatusInfo","description":"This class contains status info of all samples."},"StateModel":{"properties":{"job_id":{"type":"string","title":"Job Id"},"tasks_state":{"additionalProperties":{"$ref":"#/components/schemas/TaskState"},"type":"object","title":"Tasks State","default":{}},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"last_update_time":{"type":"string","format":"date-time","title":"Last Update Time"},"completion_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completion Time"},"duration_in_seconds":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Duration In Seconds"},"sample_status_info":{"additionalProperties":{"$ref":"#/components/schemas/SamplesStatusInfo"},"type":"object","title":"Sample Status Info","default":{}}},"type":"object","required":["job_id"],"title":"StateModel","description":"This Module is defined to save/restore the state of a Job Run."},"TaskHistory":{"properties":{"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"default":"Pending"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"}},"type":"object","title":"TaskHistory","description":"Holds historical changes in state of class."},"TaskState":{"properties":{"task_name":{"type":"string","title":"Task Name"},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"completion_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completion Time"},"duration_in_seconds":{"type":"number","title":"Duration In Seconds","default":0},"status":{"allOf":[{"$ref":"#/components/schemas/TaskStatus"}],"default":"Pending"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"},"history":{"items":{"$ref":"#/components/schemas/TaskHistory"},"type":"array","title":"History"},"attribute":{"additionalProperties":{"$ref":"#/components/schemas/JsonValue"},"type":"object","title":"Attribute"},"sub_states":{"anyOf":[{"items":{"$ref":"#/components/schemas/StateModel"},"type":"array"},{"type":"null"}],"title":"Sub States"}},"type":"object","required":["task_name"],"title":"TaskState","description":"Holds state of a task."},"TaskStatus":{"type":"string","enum":["Pending","Running","Succeeded","Failed"],"title":"TaskStatus","description":"Possible statuses of a task."},"UsageStats":{"properties":{"memory":{"type":"number","title":"Memory"},"cpu":{"type":"number","title":"Cpu"}},"type":"object","required":["memory","cpu"],"title":"UsageStats","description":"Basic usage statistics."},"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"}}}}

2026R1.1-beta-1/AVX_Post_Controller_API_V1_ArchV2/intro_archv2_post_controller_api.md

@@ -0,0 +1,26 @@
+## Introduction
+
+The AVxcelerate Post Controller REST API v0.1.0 is compatible with the AVX Architecture V2.
+
+This REST API allows you to manage post processing jobs
+
+## Features
+
+### Download concrete scenario files
+
+It is possible to download concrete scenario files of simulation jobs
+
+To do this, you need to provides a list of *sample_ids* to generate concrete scenario files for those samples. 
+
+* If 'samples' is empty or not provided, no concrete file is included. 
+* If 'samples' is specified, than all the concrete files will be included for these samples in the zip.
+
+
+You can also specify what kind of documents you want to download:
+
+* Scenario files
+* Asset files
+
+ If the parameter: *"filter_by_asset_declaration"* is empty or not provided, all the "common" asset data will be provided.
+
+