Skip to content

Fix up API examples for armstrong compatibility#4495

Open
cadenmarchese wants to merge 3 commits intomasterfrom
cadenmarchese/armstrong-compat
Open

Fix up API examples for armstrong compatibility#4495
cadenmarchese wants to merge 3 commits intomasterfrom
cadenmarchese/armstrong-compat

Conversation

@cadenmarchese
Copy link
Collaborator

Which issue this PR addresses:

Unblocks ARO-16992

What this PR does / why we need it:

  • In order to get Terraform support for the new stable API, we need to test the API swagger and examples with a tool called armstrong, which requires the examples to be formatted in a certain way. In the case of the identity structure, the UserAssignedIdentities key is expected to match a resource ID format because it will always be a resource ID.
  • Both this way and the way before should technically both be valid examples, but thought I'd raise the PR in case anyone runs into this in the future. I don't think there's a need to update the current API version's PR upstream with these changes, since those are already approved and the examples are still valid per the swagger.

Test plan for issue:

  • N/A, just a change to examples.

Is there any documentation that needs to be updated for this PR?

How do you know this will function as expected in production?

Copy link
Contributor

@kimorris27 kimorris27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you forget to commit the change to the preview API? I see that the generated examples changed, but I don't see the code changes.

@cadenmarchese
Copy link
Collaborator Author

@kimorris27 thanks, should be fixed now!

Copy link
Collaborator

@ehvs ehvs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Retriggered e2e for CSP

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chainsaw Pull requests or issues owned by Team Chainsaw ready-for-review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants