Skip to content

Commit ca72700

Browse files
author
Konrad Jamrozik
authored
Update README.md: add "known invalid scenarios" guidance for MISSING_APIS_IN_DEFAULT_TAG (#131)
1 parent de2681c commit ca72700

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,9 +136,15 @@ 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 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 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.
140140

141-
**When this error can be suppressed**: If the missing API path is deprecated then you can suppress this error. Follow [this suppresion guide](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process).
141+
**Known invalid scenarios**: Avocado may incorrectly report failures in following two scenarios:
142+
- 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))
143+
- Your API is using the service group folder [#6201](https://github.com/Azure/azure-sdk-tools/issues/6201)
144+
145+
If you are dealing with one of these scenarios, please follow the [suppression guide]. Mention the scenario you identified.
146+
147+
**When this error can be suppressed**: If the missing API path is deprecated then you can suppress this error. Follow this [suppresion guide].
142148

143149
For example detailed analyses of occurrences of such errors, see these GitHub comments:
144150
- [PR 23941 comment](https://github.com/Azure/azure-rest-api-specs/pull/23941#issuecomment-1585095669)
@@ -187,3 +193,5 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
187193

188194
[AutoRest config]: http://azure.github.io/autorest/user/configuration.html
189195
[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

0 commit comments

Comments
 (0)