Add Visual Search API swagger #2872

shakao · 2018-04-13T16:50:22Z

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.

AutorestCI · 2018-04-13T16:50:46Z

Automation for azure-sdk-for-go

Nothing to generate for azure-sdk-for-go

AutorestCI · 2018-04-13T16:50:52Z

Automation for azure-sdk-for-python

Nothing to generate for azure-sdk-for-python

AutorestCI · 2018-04-13T16:50:55Z

Automation for azure-libraries-for-java

Nothing to generate for azure-libraries-for-java

AutorestCI · 2018-04-13T16:50:58Z

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

sergey-shandar · 2018-04-13T17:56:45Z

...n/cognitiveservices/data-plane/VisualSearch/v1.0/examples/SuccessfulVisualSearchRequest.json

+        "image": "multipart-form-data",
+        "knowledgeRequest": {
+            "imageInfo": {
+                imageInsightsToken: "{Image Insights Token}",


That's not a valid JSON.

shakao · 2018-04-13T22:00:12Z

@swhite-msft The full swagger spec for the Image Visual Search API!

swhite-msft · 2018-04-13T22:16:36Z

@shakao I don't think you want to merge this to master. I think you want it in the release-build-cognitive-search release branch.

sudhansu88 · 2018-04-13T22:52:44Z

@swhite-msft : We have checked in all Specs to master only. What branch is this " release-build-cognitive-search" ?

sudhansu88 · 2018-04-16T17:03:19Z

All well ??
@sergey-shandar : Could you please merge ?

sergey-shandar · 2018-04-16T17:56:56Z

specification/cognitiveservices/data-plane/VisualSearch/v1.0/VisualSearch.json

+            "in": "formData",
+            "description": "A JSON object containing information about the image. The image and imageInsightsToken fields are mutually exclusive – the body of the request must include only one of them.",
+            "required": false,
+            "type": "string"


It looks like the type has to be KnowledgeRequest instead of string.

We don't have the ability to specify objects in the body of a POST request using multipart form-data with Swagger 2.0, so it's encoded as a string for now. I've updated the example to match.

sergey-shandar · 2018-04-16T20:02:43Z

...n/cognitiveservices/data-plane/VisualSearch/v1.0/examples/SuccessfulVisualSearchRequest.json

+                                            "accentColor":"956236"
+                                        },
+                                        {
+                                            "webSearchUrl":"https:\/\/www.bing.com\/images\/search?view=detailv2&FORM=OIIRPO


image._type is missing.

sergey-shandar · 2018-04-16T20:05:14Z

...n/cognitiveservices/data-plane/VisualSearch/v1.0/examples/SuccessfulVisualSearchRequest.json

+                                            "accentColor":"956236"
+                                        },
+                                        {
+                                            "webSearchUrl":"https:\/\/www.bing.com\/images\/search?view=detailv2&FORM=OIIRPO


tags[*]._type is expected, according to the swagger.

azuresdkciprbot · 2018-04-17T00:41:42Z

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/VisualSearch/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.

sudhansu88 · 2018-04-17T16:50:16Z

@sergey-shandar : We are waiting for your sign off. Please let us know if the spec is ready to be merged. We will update Release branch Folks to pick final signed off version of spec and merge in Release branch instead of master.

sergey-shandar · 2018-04-17T20:39:40Z

@sudhansu88 The examples are still broken https://travis-ci.org/Azure/azure-rest-api-specs/jobs/367436243#L770

shakao · 2018-04-17T21:15:39Z

@sergey-shandar the first failure is because it's expecting a type "file", and the example placeholder is a string, which i based off the existing Custom Vision API example. i don't think there's a way to include a file upload in the example json?

azuresdkciprbot · 2018-04-17T21:28:13Z

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/VisualSearch/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.

sergey-shandar · 2018-04-17T21:51:35Z

@shakao yes, it's a known bug. Please ignore the first one and have a look the response.

Add Visual Search API swagger

efe57c0

azuresdkci assigned sergey-shandar Apr 13, 2018

azuresdkci requested a review from sergey-shandar April 13, 2018 16:51

sergey-shandar suggested changes Apr 13, 2018

View reviewed changes

shakao added 2 commits April 13, 2018 11:46

Update example JSON and schema

dfbd544

Add back documenation for KnowledgeRequest JSON object

410a997

sergey-shandar suggested changes Apr 16, 2018

View reviewed changes

Remove type requirement, update knowledgeRequest string

2ba065b

Remove unnecessary example JSON

723bf2a

sergey-shandar approved these changes Apr 17, 2018

View reviewed changes

sergey-shandar merged commit 2e0bad1 into Azure:master Apr 17, 2018

This was referenced Apr 18, 2018

Visual Search API: add image visual search SDK and tests Azure/azure-sdk-for-net#4245

Merged

Visual Search API: documentation updates #2927

Merged

Visual Search Api: update documentation, structure for filter request… Azure/azure-sdk-for-net#4264

Merged

shakao mentioned this pull request Jun 1, 2018

[Visual Search API] Update parameters, operationId, descriptions #3173

Closed

10 tasks

shakao mentioned this pull request Aug 14, 2018

[Visual Search] Additional documentation, add discriminator types, up… #3637

Merged

10 tasks

Add Visual Search API swagger #2872

Add Visual Search API swagger #2872

Uh oh!

Conversation

shakao commented Apr 13, 2018 • 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!

AutorestCI commented Apr 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

AutorestCI commented Apr 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Apr 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-libraries-for-java

Uh oh!

AutorestCI commented Apr 13, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

sergey-shandar Apr 13, 2018

Choose a reason for hiding this comment

Uh oh!

shakao Apr 13, 2018

Choose a reason for hiding this comment

Uh oh!

shakao commented Apr 13, 2018

Uh oh!

swhite-msft commented Apr 13, 2018

Uh oh!

sudhansu88 commented Apr 13, 2018

Uh oh!

sudhansu88 commented Apr 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sergey-shandar Apr 16, 2018

Choose a reason for hiding this comment

Uh oh!

shakao Apr 17, 2018

Choose a reason for hiding this comment

Uh oh!

sergey-shandar Apr 16, 2018 • 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!

shakao Apr 17, 2018

Choose a reason for hiding this comment

Uh oh!

sergey-shandar Apr 16, 2018

Choose a reason for hiding this comment

Uh oh!

shakao Apr 17, 2018

Choose a reason for hiding this comment

Uh oh!

azuresdkciprbot commented Apr 17, 2018

Uh oh!

sudhansu88 commented Apr 17, 2018

Uh oh!

sergey-shandar commented Apr 17, 2018

Uh oh!

shakao commented Apr 17, 2018

Uh oh!

azuresdkciprbot commented Apr 17, 2018

Uh oh!

sergey-shandar commented Apr 17, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

shakao commented Apr 13, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Apr 13, 2018 •

edited

Loading

AutorestCI commented Apr 13, 2018 •

edited

Loading

AutorestCI commented Apr 13, 2018 •

edited

Loading

AutorestCI commented Apr 13, 2018 •

edited

Loading

sudhansu88 commented Apr 16, 2018 •

edited

Loading

sergey-shandar Apr 16, 2018 •

edited

Loading