Skip to content

Update README.md: fix typos #130

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

Merged
konrad-jamrozik merged 1 commit into from
Jul 28, 2023
Merged

Update README.md: fix typos #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,13 +134,13 @@ The API path \`${0}\` is not present in any OpenAPI `.json` files enumerated in

To fix this error include an OpenAPI `.json` file path in the list of the default API version tag paths (in the [relevant `Tag:` section][AutoRest tags]) that includes the missing API path.

**IMPORTANT**: The error may point to a previous API version. **This does not mean this is a false positive**! It means that the the previous API version has an API path that is missing from the default API version.
**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.

**Common scenario**: Often the API path is missing from the default API version due to casing mismatch; e.g. the path in new API version has `resourceGroups` in it while the previous one has `resourcegroups`. See examples below.
**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.

**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).

For an example detailed analysyes of an occurrence of such error, see these GitHub comments:
For example detailed analyses of occurrences of such errors, see these GitHub comments:
- [PR 23941 comment](https://github.com/Azure/azure-rest-api-specs/pull/23941#issuecomment-1585095669)
- [PR 24939 comment](https://github.com/Azure/azure-rest-api-specs/pull/24939#issuecomment-1656434544)

Expand Down