Updated Resource Manager REST API doc for 2026R1.1 beta-1 release #265
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This pull request adds documentation for the AVxcelerate Resource Manager REST API v0.1.0 for the 2026R1.1 beta-1 release. The documentation includes API specifications for multiple services and their associated documentation files.
- Adds comprehensive API documentation for Post Controller, Extensions Services, Explore Resources, and Assets Manager APIs
- Introduces new features like concrete scenario file downloads and worker management capabilities
- Provides usage examples and configuration guidelines for queue management and resource optimization
Reviewed Changes
Copilot reviewed 10 out of 18 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| intro_archv2_post_controller_api.md | Introduction documentation for Post Controller API with concrete scenario download features |
| explore.aws-pre-prod-api-post-controller-v1.json | OpenAPI specification for Post Controller service |
| changelog-post-controller.md | Version history and feature list for Post Controller API |
| explore.aws-pre-prod-api-extensions-v1.json | OpenAPI specification for Extensions Services |
| changelog-extensions.md | Version history for Extensions Services API |
| intro_archv2_resources_api.md | Comprehensive documentation for Resource Manager API including usage examples and queue configuration |
| explore.aws-pre-prod-api-resources-v1.json | OpenAPI specification for Resource Manager service |
| changelog.md | Version history and feature updates for Resource Manager API |
| scenario-manager.aws-preprod-api-asset-manager-v1.json | OpenAPI specification for Assets Manager service |
| changelog-asset-manager.md | Version history for Assets Manager API |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| 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. |
There was a problem hiding this comment.
Corrected grammar from 'provides' to 'provide'.
Suggested change
| To do this, you need to provides a list of *sample_ids* to generate concrete scenario files for those samples. | |
| To do this, you need to provide a list of *sample_ids* to generate concrete scenario files for those samples. |
| 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. |
There was a problem hiding this comment.
Corrected spelling from 'than' to 'then'.
Suggested change
| * If 'samples' is specified, than all the concrete files will be included for these samples in the zip. | |
| * If 'samples' is specified, then all the concrete files will be included for these samples in the zip. |
| ### Queues | ||
|
|
||
| * You can create queues with the required storages, resource limits and environment variables | ||
| * Allowing to manage queues helps will help you configure different applications within resource limits and group the applications requiring same storage together. |
There was a problem hiding this comment.
Removed redundant phrase 'helps will help' - should be either 'helps' or 'will help'.
Suggested change
| * Allowing to manage queues helps will help you configure different applications within resource limits and group the applications requiring same storage together. | |
| * Allowing to manage queues will help you configure different applications within resource limits and group the applications requiring same storage together. |
|
|
||
| The AVxcelerate python APIs are hosted as a python package on a cluster as part of the Explore service deployment. The developers can install the package using pip and use it to call AVx autonomy APIs without needing to make raw REST calls. | ||
|
|
||
| ### PyPi Regsitry URL: |
There was a problem hiding this comment.
Corrected spelling from 'Regsitry' to 'Registry'.
Suggested change
| ### PyPi Regsitry URL: | |
| ### PyPi Registry URL: |
| 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. |
There was a problem hiding this comment.
Corrected spelling from 'than' to 'then'.
Suggested change
| * If 'samples' is specified, than all the concrete files will be included for these samples in the zip. | |
| * If 'samples' is specified, then all the concrete files will be included for these samples in the zip. |
| $ curl \ 'GET' | ||
| -d "client_id=tsalsm-rest-api" \ | ||
| -d "client_secret=<redacted>" \ | ||
| -d "username=avx-toolchain-us1. er" \ |
There was a problem hiding this comment.
The username appears to be malformed with 'us1. er' - should likely be 'avx-toolchain-user'.
Suggested change
| -d "username=avx-toolchain-us1. er" \ | |
| -d "username=avx-toolchain-user" \ |
AnsMelanie
approved these changes
Oct 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated Resource Manager REST API doc for 2026R1.1 beta-1 release