Skip to content
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 swagger-authoring-descriptions.md #1

Merged
merged 1 commit into from
Oct 24, 2016
Merged

Update swagger-authoring-descriptions.md #1

merged 1 commit into from
Oct 24, 2016

Conversation

tamram
Copy link

@tamram tamram commented Oct 22, 2016

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes.
  • Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

  • I have read the contribution guidelines.
  • My spec meets the review criteria:
    • The spec conforms to the Swagger 2.0 specification.
    • Validation errors from the Linter extension for VS Code have all been fixed for this spec. (Note: for large, previously checked in specs, there will likely be many errors shown. Please contact our team so we can set a timeframe for fixing these errors if your PR is not going to address them).
    • The spec follows the patterns described in the Swagger good patterns document unless the service API makes this impossible.

Looks great! Hope you'll forgive the copy-editing suggestions.
#7 in the list could be "Include links to other content when necessary," and point to how/where to find those. I don't know whether these descriptions support links, so I'll leave that to you to include if it's worthwhile.

You might also note that it's helpful to indicate in the description for a request header/query parameter whether it is required or optional.

I'm not sure what "the Linter" is, although I heard you say it the other day, so that might be good to define here.

Looks great! Hope you'll forgive the copy-editing suggestions.

#7 in the list could be "Include links to other content when necessary," and point to how/where to find those. I don't know whether these descriptions support links, so I'll leave that to you to include if it's worthwhile. 

You might also note that it's helpful to indicate in the description for a request header/query parameter whether it is required or optional.

I'm not sure what "the Linter" is, although I heard you say it the other day, so that might be good to define here.
@erickson-doug erickson-doug merged commit 7fa77ca into erickson-doug:douge-docs Oct 24, 2016
erickson-doug pushed a commit that referenced this pull request Nov 3, 2016
ACS swagger - quick edit pass
erickson-doug pushed a commit that referenced this pull request Nov 13, 2016
erickson-doug pushed a commit that referenced this pull request Nov 13, 2016
Review of documentation comments complete.
erickson-doug pushed a commit that referenced this pull request Nov 13, 2016
Updates to DNS swagger descriptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants