Skip to content

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

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
anudeepsharma merged 1 commit into from
Apr 3, 2017
Merged

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

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
21 changes: 18 additions & 3 deletions search/2016-09-01/swagger/searchservice.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1153,6 +1153,9 @@
},
"name": {
"type": "string",
"externalDocs":{
"url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference"
},
"description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters."
}
},
Expand Down Expand Up @@ -1285,7 +1288,11 @@
"type": "string"
},
"name": {
Copy link
Copy Markdown
Contributor

@anudeepsharma anudeepsharma Mar 31, 2017

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

@anudeepsharma anudeepsharma Mar 31, 2017

Choose a reason for hiding this comment

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

example - https://github.com/Azure/azure-rest-api-specs/blob/master/arm-batch/2017-01-01/swagger/BatchManagement.json#L64

Copy link
Copy Markdown
Member Author

@bitsforthought bitsforthought Mar 31, 2017

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.

"type": "string"
"type": "string",
"externalDocs":{
"url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference"
},
"description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters."
}
},
"required": [
Expand Down Expand Up @@ -1803,7 +1810,11 @@
"type": "string"
},
"name": {
"type": "string"
"type": "string",
"externalDocs":{
"url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference"
},
"description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters."
}
},
"required": [
Expand Down Expand Up @@ -2760,7 +2771,11 @@
"type": "string"
},
"name": {
"type": "string"
"type": "string",
"externalDocs":{
"url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference"
},
"description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters."
}
},
"required": [
Expand Down