security-definitions-structure-validation.md has incorrect description
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Open docs/security-definitions-structure-validation.md at the referenced line and compare its description with the validation example in the issue. Run autorest --validation --azure-validator readme.md with the provided securityDefinitions snippet; done means the description and validator expectation match without the incompatible-values error.
Written by the indexing model from the issue text.
Description
https://github.com/Azure/azure-openapi-validator/blame/master/docs/security-definitions-structure-validation.md#L11 should have a period at the end.
Running autorest --validation --azure-validator readme.md with
...
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
}
...
gives
Error: '$.securityDefinitions.azure_auth.description' has incompatible values (---
Azure Active Directory OAuth2 Flow.
, ---
Azure Active Directory OAuth2 Flow
).
Changing
"description": "Azure Active Directory OAuth2 Flow"
to
"description": "Azure Active Directory OAuth2 Flow."
solves the issue
- Dominant language
- TypeScript
- Stars
- 53
- Forks
- 57
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/azure-openapi-validator
-
Azure/azure-openapi-validator#849 · 1 assignee ·
-
Azure/azure-openapi-validator#835 · 1 assignee ·
-
Azure/azure-openapi-validator#812 · 3 comments · 1 assignee ·
-
Azure/azure-openapi-validator#809 · 2 comments · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
Azure/azure-openapi-validator#806 · 1 comment ·
All issues in Azure/azure-openapi-validator
Similar issues
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 91/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Automattic/studio#4908 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100