-
Notifications
You must be signed in to change notification settings - Fork 21
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.
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
Update Style Guide to cover securityDefintions #55
Comments
The ARM linter already has a rule for securityDefintions: Unfortunately, the link in the documentation that supposedly describes the required structure is broken. But I think it probably should be pointing here. And here's the code that actually implements the rule: It looks like it wants very specific values for each of the fields in the security definition, which is fine for ARM but we'll need something more flexible as a general rule for Azure. |
https://github.com/Azure/autorest/blob/main/docs/generate/authentication.md includes a proposal of syntax that could be used as guidelines for service teams, and be compatible with autorest at the same time |
Some basic validity and style elements we could/should check are:
|
Here is a more specific set of rules:
|
The Style Guide should be updated with guidelines for documenting the security schemes supported/required by the API.
And we should add some Spectral rules to enforce these guidelines.
The text was updated successfully, but these errors were encountered: