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.

Sign up for GitHub

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

Jump to bottom

Outdated documentation #21354

Closed
nikidandwani opened this issue Oct 31, 2022 · 5 comments
Closed

Outdated documentation #21354

nikidandwani opened this issue Oct 31, 2022 · 5 comments
Assignees
@navba-MSFT
Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. documentation question The issue doesn't require a change to the product in order to be resolved. Most issues start as that

Comments

@nikidandwani
Copy link

Hi team,
runtimeSubnetId was the old way of doing it and now it is no longer needed.
It is very confusing to still see it being used or required in API specification documentation below
Microsoft.App/managedEnvironments - Bicep, ARM template & Terraform AzAPI reference | Microsoft Learn
Could you remove the property or at least update the description that is more relevant and in line with the latest product?

azure-rest-api-specs/specification/app/resource-manager/Microsoft.App/preview/2022-06-01-preview/ManagedEnvironments.json

Line 811 in 5fc05d0

"runtimeSubnetId": {

@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Oct 31, 2022
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Nov 1, 2022
@navba-MSFT navba-MSFT self-assigned this Nov 2, 2022
@navba-MSFT
Copy link
Contributor

@nikidandwani Thanks for reaching out to us and reporting this issue. We are looking into this issue and we will provide an update.

navba-MSFT added a commit that referenced this issue Nov 2, 2022
@navba-MSFT
{AzureContainerApps} fixes #21354
e81e07b 
fixes #21354

runtimeSubnetId was the old way of doing it and now it is no longer needed.

This PR updates the description of this property. More Info here:

microsoft/azure-container-apps#374
MicrosoftDocs/azure-docs#100319
@navba-MSFT navba-MSFT mentioned this issue Nov 2, 2022
Closed
11 tasks
@navba-MSFT navba-MSFT added documentation needs-author-feedback Workflow: More information is needed from author to address the issue. labels Nov 2, 2022
@navba-MSFT
Copy link
Contributor

@nikidandwani The above PR is currently under review. In the meantime, please feel free to ask any follow-up questions.

@nikidandwani
Copy link
Author

Thanks for the update and quick response @navba-MSFT . I see that the documentation is updated with "this field is deprecated and no longer needed..."
is it not possible to remove this field completely from the API specs? it is still confusing to see why it is still mentioned.

@ghost ghost added needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team and removed needs-author-feedback Workflow: More information is needed from author to address the issue. labels Nov 2, 2022
@navba-MSFT
Copy link
Contributor

navba-MSFT commented Nov 9, 2022 •
edited
Loading

@nikidandwani Apologies for the late reply. Removing property from an already shipped API is a breaking change which will most likely not be approved. So to avoid any confusion the quick workaround here is to fix the documentation mentioning that this is deprecated.

navba-MSFT added a commit that referenced this issue Nov 11, 2022
@navba-MSFT
{AzureContainerApps} fixes #21354
6ee1bfd 
runtimeSubnetId was the old way of doing it and now it is no longer needed.
It is very confusing to still see it being used or required in API specification documentation below:

https://learn.microsoft.com/en-us/azure/templates/microsoft.app/managedenvironments?pivots=deployment-language-bicep#vnetconfiguration

This PR updates the description mentioning it is deprecated.
@navba-MSFT navba-MSFT mentioned this issue Nov 11, 2022
Merged
11 tasks
leni-msft pushed a commit that referenced this issue Nov 28, 2022
@navba-MSFT
{AzureContainerApps} fixes #21354 (#21520)
e07bd8a 
* {AzureContainerApps} fixes #21354

runtimeSubnetId was the old way of doing it and now it is no longer needed.
It is very confusing to still see it being used or required in API specification documentation below:

https://learn.microsoft.com/en-us/azure/templates/microsoft.app/managedenvironments?pivots=deployment-language-bicep#vnetconfiguration

This PR updates the description mentioning it is deprecated.

* Update ManagedEnvironments.json

* Update ManagedEnvironments.json

* Update ManagedEnvironments.json

* Update ManagedEnvironments.json
@navba-MSFT navba-MSFT removed the needs-team-attention Workflow: This issue needs attention from Azure service team or SDK team label Nov 28, 2022
@navba-MSFT
Copy link
Contributor

PR is now merged. Closing this issue.

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

@navba-MSFT navba-MSFT

Labels
customer-reported Issues that are reported by GitHub users external to the Azure organization. documentation question The issue doesn't require a change to the product in order to be resolved. Most issues start as that
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

{AzureContainerApps} fixes Azure/azure-rest-api-specs#21354 Azure/azure-rest-api-specs
3 participants
@JackTn @nikidandwani @navba-MSFT