Visual Search API: documentation updates

[shakao]

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]

Automation for azure-sdk-for-node

Unable to detect any generation context from this PR.

[AutorestCI]

Automation for azure-libraries-for-java

Unable to detect any generation context from this PR.

[azuresdkciprbot]

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/VisualSearch/readme.md

⚠️0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

[azuresdkciprbot]

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/VisualSearch/readme.md

⚠️0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

[AutorestCI]

Automation for azure-sdk-for-python

Unable to detect any generation context from this PR.

[AutorestCI]

Automation for azure-sdk-for-go

Unable to detect any generation context from this PR.

[azuresdkciprbot]

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/VisualSearch/readme.md

⚠️0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

[azuresdkciprbot]

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/VisualSearch/readme.md

⚠️0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

[annatisch]

Thanks @shakao - could you take a look at the model validation error for Visual Search:

{ code: 'REQUEST_VALIDATION_ERROR',
  id: 'OAV109',
  message: 'Found errors in validating the request for x-ms-example "Successful visual search" in operation "Images_VisualSearch".',
  innerErrors: 
   [ { code: 'INVALID_REQUEST_PARAMETER',
       errors: 
        [ { code: 'ONE_OF_MISSING',
            params: [],
            message: 'Data does not match any schemas from \'oneOf\'',
            path: [],
            description: 'Required if you upload an image instead of passing an image insights token. The Content-Disposition\'s filename parameter must be set to "image" and the contents of the form data must be the image binary. The image and imageInsightsToken fields are mutually exclusive – the body of the request must include only one of them.',
            inner: 
             [ { code: 'INVALID_TYPE',
                 params: [ 'file', 'string' ],
                 message: 'Expected type file but found type string',
                 path: [] },
               { code: 'INVALID_TYPE',
                 params: [ 'null', 'string' ],
                 message: 'Expected type null but found type string',
                 path: [] } ] } ],
       in: 'formData',
       message: 'Invalid parameter (image): Value failed JSON Schema validation',
       name: 'image',
       path: [ 'paths', '/images/visualsearch', 'post', 'parameters', '9' ] } ] }

[azuresdkciprbot]

AutoRest linter results for ARM Related Validation Errors/Warnings

These errors are reported by the ARM team's validation tools, reachout to ARM RP API Review directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/VisualSearch/readme.md

⚠️0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

[azuresdkciprbot]

AutoRest linter results for SDK Related Validation Errors/Warnings

These errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns.

File: specification/cognitiveservices/data-plane/VisualSearch/readme.md

⚠️0 new Warnings.(0 total)

❌0 new Errors.(0 total)

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

[shakao]

@annatisch from the last PR i think this is a known bug where the request format is "file", but we can't include a file in the sample json

[annatisch]

@shakao - do you have any more documentation updates or shall I merge it?

[shakao]

@annatisch nope, done with the updates--thanks for double-checking!