Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add gov API version 2024-07-01 #6321

Merged
merged 22 commits into from
Jul 11, 2024

Conversation

eddyashton
Copy link
Member

@eddyashton eddyashton commented Jul 2, 2024

See #6280. The contents and behaviour of this api-version are identical to 2023-06-01-preview, but since we've proved out the new API we're now marking it non-preview.

Opening this as draft as there are still a few blockers:

@eddyashton eddyashton marked this pull request as ready for review July 10, 2024 14:12
@eddyashton eddyashton requested a review from a team as a code owner July 10, 2024 14:12
@eddyashton
Copy link
Member Author

eddyashton commented Jul 10, 2024

This PR now includes a few additional changes, with a view to closing #5691 as well as introducing the new API version, which I'll try to summarise here:

  • Pull the latest (generated from TypeSpec) OpenAPI document for the 2023-06-01-preview API version. Essentially this just means the OpenAPI document (stored in our repo, returned from GET /gov/api?api-version=2023-06-01-preview) now matches the implementation (as much as possible), including fixing all of the discrepancies described in Track discrepancies between versioned governance API spec and implementation #5691.
  • Renames these files (including example requests/responses) for clarity - here they're the gov API, not mccf.
  • Pulls a (generated from TypeSpec) OpenAPI document describing the 2024-07-01 API version. This isn't a great situation - the source lives on a branch on my fork for now (https://github.com/eddyashton/azure-rest-api-specs/tree/ccf_gov_2024_07_01/specification/confidentialledger/Microsoft.ManagedCcf), and is manually exported. Eventually we need to decide if we stay TypeSpec-first for this API (and bear the cost of a TypeSpec toolchain dependency), or abandon this and go source-first again. The current solution is a temporary bandaid.
  • Adds 2 new APIs for accessing JS modules, to resolve Need modern API equivalent of the classic gov/kv/modules API #6117, only available with this newest API. Really just an opportunity to test the API versioning machinery, that we can safely introduce new APIs.
  • Extend our api_version_adapter wrapper to support a minimum accepted version, for newly introduced APIs.
  • Some additional tests for the new endpoints.

@achamayou achamayou added this pull request to the merge queue Jul 11, 2024
Merged via the queue into microsoft:main with commit ccf21db Jul 11, 2024
17 checks passed
@achamayou achamayou deleted the non_preview_api_version branch July 11, 2024 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants