Add swagger spec for spell check API #1997

ashku-ms · 2017-11-10T22:53:55Z

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.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

jhendrixMSFT

The examples need to be hooked up to the operations, see this for an example.

jhendrixMSFT · 2017-11-15T18:11:08Z

specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json

+        },
+        "x-ms-examples": {
+          "Successful query": {
+            "$ref": "./examples//SuccessfulSpellModeRequest.json"


Extra forward slash.

jhendrixMSFT · 2017-11-15T18:11:13Z

specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json

+            "$ref": "./examples//SuccessfulSpellModeRequest.json"
+          },
+          "Successful Proof Mode query": {
+            "$ref": "./examples//SuccessfulProofModeRequest.json"


Extra forward slash.

…eters.

lmazuel · 2017-11-20T19:49:48Z

specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json

+{
+  "swagger": "2.0",
+  "info": {
+    "title": "Spell Check API - v7",


(discussed with @amarzavery as well)
Please change to Spell Check API (you can put v7 in the description if you'd like)

lmazuel · 2017-11-20T19:52:40Z

specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json

+    }
+  },
+  "definitions": {
+    "SpellCheck": {


Please change this one to SpellCheckModel (to avoid a conflict with the operation ID)

(checked with @amarzavery)

So "SpellCheck" appears to be the name of a schema in swagger that I only share. Would it be acceptable to change the operation ID instead?

So "SpellCheck" appears to be the name of a schema in swagger that I only share.

Can you explain a bit more on this?

The model name is just a logical name given to the schema so that customers can refer to it when using the SDK. It has no bearing on the REST API. If someone is using the REST API directly then they would not provide the model name but provide a sample based on the schema.

I can foresee that this could be a problem with discriminators. However, we have "x-ms-discriminator-value": "SpellCheck" to your rescue for that model definition.

"The model name is just a logical name given to the schema so that customers can refer to it when using the SDK." -> I intended to say, I do not own this schema. :) I only use it. So I am hesitant to change this.

as we discussed offline, I changed the name of the operationID

lmazuel · 2017-11-20T20:00:25Z

specification/cognitiveservices/data-plane/SpellCheck/V1.0/SpellCheck.json

+          },
+          {
+            "name": "Mode",
+            "in": "formData",


You doc says that mode is query:
https://dev.cognitive.microsoft.com/docs/services/5f7d486e04d2430193e1ca8f760cd7ed/operations/56e73036cf5ff81048ee6727

Could you confirm it's formData?

Yes. We support only "Post" http methods through this SDK and "Mode" can be a post body parameter. It appears like we can specify "Mode" as either a header or as a body parameter. In such cases, we have decided to use it as a "body" parameter for our post method based SDK.

lmazuel

LGTM. Generated and tested in Python already FYI:
https://github.com/Azure/azure-sdk-for-python/tree/master/azure-cognitiveservices-language-spellcheck

ashku-ms · 2017-11-21T23:08:50Z

package.json

  "scripts": {
    "test": "mocha -t 500000"
+  },
+  "dependencies": {


This change was unintentional.

azuresdkciprbot · 2017-11-21T23:09:57Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/cognitiveservices/data-plane/SpellCheck/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

Packages.json change here was unintentionally added to this review

azuresdkciprbot · 2017-11-21T23:14:48Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/cognitiveservices/data-plane/SpellCheck/readme.md
Before the PR: Warning(s): 0 Error(s): 0
After the PR: Warning(s): 0 Error(s): 0

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

AutorestCI · 2017-11-21T23:20:16Z

No modification for AutorestCI/azure-sdk-for-node

AutorestCI · 2017-11-21T23:20:22Z

No modification for AutorestCI/azure-sdk-for-python

AutorestCI · 2017-11-21T23:20:26Z

No modification for AutorestCI/azure-sdk-for-ruby

* Video Swagger API: update example response json to remove special invalid special characters (#2015) * Add Video Search API Swagger * Video Swagger API: update example response json to remove special invalid special characters * take changes from azure-rest-spec-pr, make Microsoft.Subscription tenant level rp (#1984) * Fix bad merge. (#2022) * Add list apis for sql backup LTR policies & vaults (#2006) * Add list LTR vaults & policies * Added pageable * Change output folder for Search SDKs (#2023) * update output folders in readmes * rename with bing in name * App Model for Tumbling window trigger (#2028) * App model for tumbling window trigger * Addressed CR comments * Renamed retry to count in RetryPolicy * swagger definition for 26 RFI connectors (#2016) * Updated OMS data plane C# namespace & output-folder (#2021) * Update Azure Batch enum to use "values" - also some documentation updates (#2008) * Enum fixes * Improve DataDisks documentation * Update NATPool port range documentation * [Compute] Update Sku APIs (#2034) * Initial commit of 2017-12-01 compute.json * Changes for new API version 2017-12-01 compute.json * Add Compute SKU APIs * Add swagger spec for spell check API (#1997) * Add swagger spec for spell check API * Add Examples to spec * Remove redundant forward slash in path. Specify array from body parameters. * Fix oav errors * Remove x-Bing_Apis-SDK * Change spec to reflect what objects we want to expose in the response. * Fix operationId name to avoid conflict with "SpellCheck" schema. * Add X-BingApis-SDK back. * Remove Unintentional change Packages.json change here was unintentionally added to this review

* [Network-2017-11-01] Pull latest from current (#2039) * Video Swagger API: update example response json to remove special invalid special characters (#2015) * Add Video Search API Swagger * Video Swagger API: update example response json to remove special invalid special characters * take changes from azure-rest-spec-pr, make Microsoft.Subscription tenant level rp (#1984) * Fix bad merge. (#2022) * Add list apis for sql backup LTR policies & vaults (#2006) * Add list LTR vaults & policies * Added pageable * Change output folder for Search SDKs (#2023) * update output folders in readmes * rename with bing in name * App Model for Tumbling window trigger (#2028) * App model for tumbling window trigger * Addressed CR comments * Renamed retry to count in RetryPolicy * swagger definition for 26 RFI connectors (#2016) * Updated OMS data plane C# namespace & output-folder (#2021) * Update Azure Batch enum to use "values" - also some documentation updates (#2008) * Enum fixes * Improve DataDisks documentation * Update NATPool port range documentation * [Compute] Update Sku APIs (#2034) * Initial commit of 2017-12-01 compute.json * Changes for new API version 2017-12-01 compute.json * Add Compute SKU APIs * Add swagger spec for spell check API (#1997) * Add swagger spec for spell check API * Add Examples to spec * Remove redundant forward slash in path. Specify array from body parameters. * Fix oav errors * Remove x-Bing_Apis-SDK * Change spec to reflect what objects we want to expose in the response. * Fix operationId name to avoid conflict with "SpellCheck" schema. * Add X-BingApis-SDK back. * Remove Unintentional change Packages.json change here was unintentionally added to this review * Add 2017-11-01 folder in microsoft.network (#2019) * Video Swagger API: update example response json to remove special invalid special characters (#2015) * Add Video Search API Swagger * Video Swagger API: update example response json to remove special invalid special characters * take changes from azure-rest-spec-pr, make Microsoft.Subscription tenant level rp (#1984) * Fix bad merge. (#2022) * Add 2017-11-01 folder in microsoft.network * Add Ip Tags into Swagger (#2145) * add iptags for publicip in 2017-11-01 * read me changes for 2017-11-01 * Add Python conf for Network 2017-11-01 * Complete Python conf for 2017-11-01 * Updated LB InboundNatPool API (#2150) * Revert "[Network-2017-11-01] Pull latest from current (#2039)" This reverts commit a0257f9. * Moving to stable folder to account for refactoring changes in dec 2017

Add swagger spec for spell check API

ddb7c88

azuresdkci assigned jhendrixMSFT Nov 10, 2017

jhendrixMSFT requested changes Nov 13, 2017

View reviewed changes

Add Examples to spec

5409c1d

jhendrixMSFT reviewed Nov 15, 2017

View reviewed changes

ashku-ms added 4 commits November 15, 2017 11:15

Remove redundant forward slash in path. Specify array from body param…

d0e515d

…eters.

Fix oav errors

8bf608f

Remove x-Bing_Apis-SDK

7ef70bd

Change spec to reflect what objects we want to expose in the response.

63a1a7e

lmazuel reviewed Nov 20, 2017

View reviewed changes

lmazuel mentioned this pull request Nov 20, 2017

Initial version of SpellCheck Azure/azure-sdk-for-python#1637

Merged

Fix operationId name to avoid conflict with "SpellCheck" schema.

35a265b

lmazuel approved these changes Nov 21, 2017

View reviewed changes

Add X-BingApis-SDK back.

e75a912

ashku-ms commented Nov 21, 2017

View reviewed changes

package.json Outdated

"scripts": {

"test": "mocha -t 500000"

},

"dependencies": {

Copy link

Contributor Author

ashku-ms Nov 21, 2017

Choose a reason for hiding this comment

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

This change was unintentional.

Remove Unintentional change

9cf0df7

Packages.json change here was unintentionally added to this review

jhendrixMSFT approved these changes Nov 21, 2017

View reviewed changes

jhendrixMSFT merged commit 47ff25e into Azure:current Nov 21, 2017

Add swagger spec for spell check API #1997

Add swagger spec for spell check API #1997

Uh oh!

Conversation

ashku-ms commented Nov 10, 2017 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

jhendrixMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashku-ms Nov 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lmazuel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azuresdkciprbot commented Nov 21, 2017

Uh oh!

azuresdkciprbot commented Nov 21, 2017

Uh oh!

AutorestCI commented Nov 21, 2017

Uh oh!

AutorestCI commented Nov 21, 2017

Uh oh!

AutorestCI commented Nov 21, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ashku-ms commented Nov 10, 2017 •

edited by azuresdkci

Loading

ashku-ms Nov 20, 2017 •

edited

Loading