Skip to content

Search: Adding some missing descriptions to the 2016-09-01 spec#1086

Merged
anudeepsharma merged 1 commit into
Azure:masterfrom
bitsforthought:missing-descriptions
Apr 3, 2017
Merged

Search: Adding some missing descriptions to the 2016-09-01 spec#1086
anudeepsharma merged 1 commit into
Azure:masterfrom
bitsforthought:missing-descriptions

Conversation

@bitsforthought
Copy link
Copy Markdown
Member

@bitsforthought bitsforthought commented Mar 30, 2017

NOTE: This Swagger spec fails validation with the current version of the linter. This is a known issue: #1085

We are trying to ship an incremental bugfix/feature update to our .NET SDK. We do not have the bandwidth right now to do a full pass over this Swagger spec, so please keep that in mind as you review it.

FYI @chaosrealm @Yahnoosh @vishrutshah


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

@@ -1285,7 +1288,11 @@
"type": "string"
},
"name": {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also put regex rules here with min/max length

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@anudeepsharma I have some (IMO) well-grounded objections to regex constraints. Rather than repeat them, I'll direct you to this discussion on an earlier PR.

Regarding min/max constraints, I believe they are valuable for documentation purposes where applicable. These limits are documented in the (hand written) REST API reference, which we now link to from the Swagger spec. However, I would still refrain from adding them to the Swagger until AutoRest supports disabling client-side validation.

Copy link
Copy Markdown
Contributor

@anudeepsharma anudeepsharma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting for regex and min/max length. In case you are not doing, let me know, I will merge the PR. Changes look fine to me otherwise.

Also - https://travis-ci.org/Azure/azure-rest-api-specs/jobs/216953241 is failing. In case you can make build better, please do it (don't make breaking changes though).

@Yahnoosh
Copy link
Copy Markdown
Contributor

:shipit:

@bitsforthought
Copy link
Copy Markdown
Member Author

@anudeepsharma Regarding the Travis CI build failing, please see my comment at the top of this PR:

NOTE: This Swagger spec fails validation with the current version of the linter. This is a known issue: #1085

@bitsforthought
Copy link
Copy Markdown
Member Author

@anudeepsharma Opened an issue on AutoRest to track disabling client-side validation: Azure/autorest#2100

Copy link
Copy Markdown
Contributor

@anudeepsharma anudeepsharma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@anudeepsharma anudeepsharma merged commit acc98f8 into Azure:master Apr 3, 2017
@bitsforthought bitsforthought deleted the missing-descriptions branch April 3, 2017 18:53
@AutorestCI
Copy link
Copy Markdown

No modification for Ruby

@AutorestCI
Copy link
Copy Markdown

No modification for NodeJS

@AutorestCI
Copy link
Copy Markdown

No modification for Python

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.

5 participants