You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-5Lines changed: 8 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,13 +136,17 @@ To fix this error include an OpenAPI `.json` file path in the list of the defaul
136
136
137
137
**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.
138
138
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**:
140
140
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:
142
146
- 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
147
- Your API is using the service group folder [#6201](https://github.com/Azure/azure-sdk-tools/issues/6201)
144
148
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.
146
150
147
151
**When this error can be suppressed**: If the missing API path is deprecated then you can suppress this error. Follow this [suppresion guide].
148
152
@@ -193,5 +197,4 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio
0 commit comments