Add Auto Suggest API specification #2635

jwood803 · 2018-03-10T12:27:07Z

Apologies for the WIP pull request, but I'm not exactly sure if I'm on the right track. From my understanding, this is needed to auto-generate the code for the Python Azure SDK.

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.

msftclas · 2018-03-10T12:27:18Z

All CLA requirements met.

AutorestCI · 2018-03-10T12:27:24Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

AutorestCI · 2018-03-10T12:27:32Z

Automation for azure-libraries-for-java

Nothing to generate for azure-libraries-for-java

AutorestCI · 2018-03-10T12:27:33Z

Automation for azure-sdk-for-python

Encountered a Subprocess error: (azure-sdk-for-python)

Command: ['/usr/local/bin/autorest', '/tmp/tmp8gma6yyc/rest/specification/cognitiveservices/data-plane/AutoSuggest/readme.md', '--multiapi', '--python', '--python-mode=update', '--python-sdks-folder=/tmp/tmp8gma6yyc/sdk', '[email protected]/autorest.python@~3.0', '--version=preview']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4262; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest

There is a new version of AutoRest available (2.0.4280).
 > You can install the newer version with with npm install -g autorest@latest

   Loading AutoRest core      '/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4280)
   Loading AutoRest extension '@microsoft.azure/autorest.python' (~3.0->3.0.51)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
ERROR: Referenced file 'file:///tmp/tmp8gma6yyc/rest/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/examples/SuccessfulAutoSuggestRequest.json' not found
    - file:///tmp/tmp8gma6yyc/rest/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json:137:16 ($.paths["/suggestions"].get["x-ms-examples"]["Successful query"]["$ref"])
FATAL: swagger-document/loader - FAILED
FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.

anuchandy · 2018-03-14T16:45:08Z

@jwood803 thank you. Just trying to get some context here, saw that you are from Wintellect, are you in touch with anyone from Microsoft cognitive service team? if so can you can tag him/her in this PR so that service team also can take a look. In case you don't know anyone in cognitive team please let me know, i can find the contact and help you to progress this PR. Again thanks for the contribution!

jwood803 · 2018-03-14T16:48:33Z

Thanks for getting back @anuchandy! I don't know anyone at Microsoft myself, but I'm sure some colleagues of mine do. I can ask them if that works.

Apologies for the noise in this PR. I kind of figured things out as they went. I'm sure I still have some updates here, too. 😄

anuchandy · 2018-03-14T17:40:12Z

@jwood803 no worries, i'm checking with cognitive service team to see whether they can take a look at this PR.

lmazuel · 2018-03-14T23:05:53Z

specification/cognitiveservices/data-plane/AutoSuggest/readme.md

+``` yaml $(python) && $(python-mode) == 'update'
+python:
+  no-namespace-folders: true
+  output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-newssearch/azure/cognitiveservices/search/newssearch


Please change "newssearch" for "autosuggest

lmazuel

Content LGTM, please fix the Python conf. Thanks!

lmazuel · 2018-03-14T23:05:58Z

specification/cognitiveservices/data-plane/AutoSuggest/readme.md

+``` yaml $(python) && $(python-mode) == 'create'
+python:
+  basic-setup-py: true
+  output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-newssearch/azure/cognitiveservices/search/newssearch


Please change "newssearch" for "autosuggest

AutorestCI · 2018-03-14T23:38:21Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

jwood803 · 2018-03-14T23:39:19Z

Thanks a ton for reviewing @lmazuel! I plan on doing the sample, too, so if I notice anything missing I'll make appropriate updates.

lmazuel · 2018-03-15T00:15:11Z

@AutorestCI rebuild azure-sdk-for-python

azuresdkciprbot · 2018-03-19T17:12:45Z

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:

💡 Please review potentially introduced Error(s)/Warning(s): Analysis Report 💡

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

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

lmazuel · 2018-03-20T16:33:05Z

@jwood803 Just to give you update, we need someone from the Autosuggest team to sign-off, but your PR looks good to me

jwood803 · 2018-03-20T16:34:54Z

Thanks a ton, @lmazuel! I think I broke it when fixing the linting errors, but some extra guidance from that team would be very helpful. Thank you again!

jwood803 · 2018-06-14T12:20:38Z

Looks like I've been slacking too much and this has already been implemented. Should this PR be closed?

lmazuel · 2018-06-14T21:25:52Z

Hi @jwood803 that's unfortunate, seems the message was lost at some point and indeed the AutoSuggest team worked on it too :(

Did you integrate your Swagger in your applications? Would you mind double-check that this new Swagger checked-in before yours fits your needs? This would be valuable feedback.

Sorry again your contribution didn't make it faster :(

jwood803 · 2018-06-14T23:49:21Z

No worries, @lmazuel! I should have fixed the issues in this PR a while ago to help it ready for further review. The other PR looks better than mine, too 😄

I would like to implement the samples in the samples repository, but I'm not sure about the workflow before it becomes a Python package in PyPI. I'm guessing after this PR gets merged the Python package gets auto-generated?

lmazuel · 2018-06-15T00:42:07Z

@jwood803 Yes, I need to configure the "setup.py" and do some testing, but indeed you got it :)

jwood803 · 2018-06-15T00:46:32Z

Awesome, @lmazuel, thanks! I'll wait for the package to be generated and I'll hit up some samples! 😃

I'll close this PR, but thank you for all the help! It's much appreciated!

AutorestCI · 2018-06-15T00:48:15Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

jwood803 added 3 commits March 9, 2018 23:05

Add auto suggest readme

e8afe89

Update some of the API json

656731c

Continue to fill in JSON file

655fbf8

jwood803 added 4 commits March 10, 2018 07:28

Add magic string

5ed3fc2

Add Identifiable

a08e1bb

Fix AutoSuggest JSON errors

4ca9d8e

Update readme specification

41dfe9a

AutorestCI mentioned this pull request Mar 10, 2018

[AutoPR cognitiveservices/data-plane/AutoSuggest] [WIP] Add Auto Suggest API specification Azure/azure-sdk-for-python#2147

Closed

azuresdkci assigned anuchandy Mar 13, 2018

lmazuel reviewed Mar 14, 2018

View reviewed changes

lmazuel requested changes Mar 14, 2018

View reviewed changes

lmazuel assigned lmazuel and unassigned anuchandy Mar 14, 2018

Change from news search to auto suggest

803806b

jwood803 changed the title ~~[WIP] Add Auto Suggest API specification~~ Add Auto Suggest API specification Mar 14, 2018

AutorestCI mentioned this pull request Mar 15, 2018

[AutoPR cognitiveservices/data-plane/AutoSuggest] Add Auto Suggest API specification Azure/azure-sdk-for-python#2178

Closed

Update based off linting errors

24b1edc

jwood803 requested a review from a user March 19, 2018 17:34

jwood803 requested a review from tiffanyachen as a code owner March 19, 2018 17:34

jwood803 requested a review from vladbarosan as a code owner March 19, 2018 17:34

lmazuel approved these changes Mar 20, 2018

View reviewed changes

vladbarosan removed their request for review June 15, 2018 00:20

jwood803 closed this Jun 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Auto Suggest API specification #2635

Add Auto Suggest API specification #2635

jwood803 commented Mar 10, 2018 •

edited by azuresdkci

Loading

msftclas commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 10, 2018 •

edited

Loading

anuchandy commented Mar 14, 2018

jwood803 commented Mar 14, 2018

anuchandy commented Mar 14, 2018

lmazuel Mar 14, 2018

lmazuel left a comment

lmazuel Mar 14, 2018

AutorestCI commented Mar 14, 2018 •

edited

Loading

jwood803 commented Mar 14, 2018

lmazuel commented Mar 15, 2018

azuresdkciprbot commented Mar 19, 2018

lmazuel commented Mar 20, 2018

jwood803 commented Mar 20, 2018

jwood803 commented Jun 14, 2018

lmazuel commented Jun 14, 2018

jwood803 commented Jun 14, 2018

lmazuel commented Jun 15, 2018

jwood803 commented Jun 15, 2018

AutorestCI commented Jun 15, 2018 •

edited

Loading

Add Auto Suggest API specification #2635

Add Auto Suggest API specification #2635

Conversation

jwood803 commented Mar 10, 2018 • edited by azuresdkci Loading

PR information

Quality of Swagger

msftclas commented Mar 10, 2018 • edited Loading

AutorestCI commented Mar 10, 2018 • edited Loading

Automation for azure-sdk-for-go

AutorestCI commented Mar 10, 2018 • edited Loading

Automation for azure-libraries-for-java

AutorestCI commented Mar 10, 2018 • edited Loading

Automation for azure-sdk-for-python

anuchandy commented Mar 14, 2018

jwood803 commented Mar 14, 2018

anuchandy commented Mar 14, 2018

lmazuel Mar 14, 2018

Choose a reason for hiding this comment

lmazuel left a comment

Choose a reason for hiding this comment

lmazuel Mar 14, 2018

Choose a reason for hiding this comment

AutorestCI commented Mar 14, 2018 • edited Loading

Automation for azure-sdk-for-node

jwood803 commented Mar 14, 2018

lmazuel commented Mar 15, 2018

azuresdkciprbot commented Mar 19, 2018

lmazuel commented Mar 20, 2018

jwood803 commented Mar 20, 2018

jwood803 commented Jun 14, 2018

lmazuel commented Jun 14, 2018

jwood803 commented Jun 14, 2018

lmazuel commented Jun 15, 2018

jwood803 commented Jun 15, 2018

AutorestCI commented Jun 15, 2018 • edited Loading

Automation for azure-sdk-for-ruby

jwood803 commented Mar 10, 2018 •

edited by azuresdkci

Loading

msftclas commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 10, 2018 •

edited

Loading

AutorestCI commented Mar 14, 2018 •

edited

Loading

AutorestCI commented Jun 15, 2018 •

edited

Loading