Skip to content

Commit 00f44b5

Browse files
author
Konrad Jamrozik
authored
Update README.md: more missing API paths common scenarios, update link to suppressions (#132)
1 parent ca72700 commit 00f44b5

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,17 @@ To fix this error include an OpenAPI `.json` file path in the list of the defaul
136136

137137
**IMPORTANT**: The error may point to a previous API version. **This does not mean this is a false positive**! It means that the previous API version has an API path that is missing from the default API version.
138138

139-
**Common valid scenario**: Often the API path is missing from the default API version due to casing mismatch; e.g. the path in the new API version has `resourceGroups` in it while the previous one has `resourcegroups`. See examples below.
139+
**Common scenarios where Avocado fails your PR correctly**:
140140

141-
**Known invalid scenarios**: Avocado may incorrectly report failures in following two scenarios:
141+
- Often the API path is missing from the default API version due to casing mismatch; e.g. the path in the new API version has `resourceGroups` in it while the previous one has `resourcegroups`. See examples below.
142+
- If Avocado reports missing a path that you have **intentionally deprecated** or **intentionally removed** but the API version is publicly released (GA, generaly available, not in preview) first you need to get
143+
Breaking Change Board approval. Follow the breaking change process from step 1 in [this diagram](https://aka.ms/pr-diagram). If you already got such approval in a previous PR, follow the [suppression guide]. Mention the scenario you identified.
144+
145+
**Known scenarios where Avocado reports false positive**: Avocado may incorrectly report failures in following two scenarios:
142146
- Your API is deprecated/obsolete [#6627](https://github.com/Azure/azure-sdk-tools/issues/6627) (example case in [PR 24771](https://github.com/Azure/azure-rest-api-specs/pull/24771#issuecomment-1660776189))
143147
- Your API is using the service group folder [#6201](https://github.com/Azure/azure-sdk-tools/issues/6201)
144148

145-
If you are dealing with one of these scenarios, please follow the [suppression guide]. Mention the scenario you identified.
149+
If you are dealing with one of these scenarios, follow the [suppression guide]. Mention the scenario you identified.
146150

147151
**When this error can be suppressed**: If the missing API path is deprecated then you can suppress this error. Follow this [suppresion guide].
148152

@@ -193,5 +197,4 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
193197

194198
[AutoRest config]: http://azure.github.io/autorest/user/configuration.html
195199
[AutoRest tags]: https://azure.github.io/autorest/generate/#adding-tags-when-generating
196-
197-
[suppression guide]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process
200+
[suppression guide]: https://aka.ms/azsdk/pr-suppressions

0 commit comments

Comments
 (0)