Skip to content
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.

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

Update CognitiveService ComputerVision Swagger for new extensions #3090

Merged
merged 1 commit into from
May 23, 2018

Conversation

cthrash
Copy link
Contributor

@cthrash cthrash commented May 16, 2018

  • Add support for new language argument
  • Added multipart/form-data for endpoints which support it
  • Fix enum for proper C# codegen
  • Replace fancy quotes with plain single quotes for Java compile
  • Changes to make --azure-validator run more cleanly, details:

Errors Fixed

  • XmsExamplesRequired/D5001/Documentation (7)
  • XmsPathsMustOverloadPaths/R2058/SDKViolation (7)

Errors Ignored

  • SecurityDefinitionsStructure/R2054/SDKViolation (1) - API Key scheme for Cognitive Services
  • APIVersionPattern/R3012/ARMViolation (1) - Keeping with the Cognitive Services numbering scheme
  • OperationsAPIImplementation/R3023/ARMViolation (1) - Not sure what this is

Warnings Fixed

  • XmsEnumValidation/R2018/SDKViolation (1)
  • DescriptionAndTitleMissing/R4000/SDKViolation (1)

Warnings Ignored

  • DescriptionAndTitleMissing/R4000/SDKViolation (35) - description is contained in #ref
  • EnumInsteadOfBoolean/R3018/ARMViolation (5) - fix would be a breaking change
  • ListInOperationName/R1003/SDKViolation (1) - fix would be a breaking change
  • LongRunningOperationsWithLongRunningExtension/R2007/SDKViolation (2) - endpoint will not ultimately yield a 200, as this extension would require
  • NonApplicationJsonType/R2004/ARMViolation (15) - fix would be breaking change
  • PageableOperation/R2029/SDKViolation (1) - not actually pageable
  • ParameterNotDefinedInGlobalParameters/R2015/SDKViolation (1) - All our own parameters specify x-ms-parameter-location
  • PostOperationIdContainsUrlVerb/R2066/SDKViolation (7) - fix would be breaking change

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

* Merged PR 17875: Add new languages

Add new languages

Also tidy up the enum definition so that AutoRest generates C# that actually compiles

* Merged PR 17942: Replace fancy quotes with plain single quotes

Make javac compile without complaint even without setting the codepage to utf-8 by dropping the gratuitous typographic quotes.

* Merged PR 17956: Rename url argument for overloaded endpoint to imageUrl

This name will become the name of the argument in Python.  Since you can used named arguments in Python, give them less ambiguous names.

* Changes to make --azure-validator run more cleanly

Errors Fixed
* XmsExamplesRequired/D5001/Documentation (7)
* XmsPathsMustOverloadPaths/R2058/SDKViolation (7)

Errors Ignored
* SecurityDefinitionsStructure/R2054/SDKViolation (1) - API Key scheme for Cognitive Services
* APIVersionPattern/R3012/ARMViolation (1) - Keeping with the Cognitive Services numbering scheme
* OperationsAPIImplementation/R3023/ARMViolation (1) - Not sure what this is

Warnings Fixed
* XmsEnumValidation/R2018/SDKViolation (1)
* DescriptionAndTitleMissing/R4000/SDKViolation (1)

Warnings Ignored
* DescriptionAndTitleMissing/R4000/SDKViolation (35) - description is contained in #ref
* EnumInsteadOfBoolean/R3018/ARMViolation (5) - fix would be a breaking change
* ListInOperationName/R1003/SDKViolation (1) - fix would be a breaking change
* LongRunningOperationsWithLongRunningExtension/R2007/SDKViolation (2) - endpoint will not ultimately yield a 200, as this extension would require
* NonApplicationJsonType/R2004/ARMViolation (15) - fix would be breaking change
* PageableOperation/R2029/SDKViolation (1) - not actually pageable
* ParameterNotDefinedInGlobalParameters/R2015/SDKViolation (1) - All our own parameters specify x-ms-parameter-location
* PostOperationIdContainsUrlVerb/R2066/SDKViolation (7) - fix would be breaking change
@AutorestCI
Copy link

AutorestCI commented May 16, 2018

Automation for azure-libraries-for-java

The initial PR has been merged into your service PR:
AutorestCI/azure-libraries-for-java#190

@AutorestCI
Copy link

AutorestCI commented May 16, 2018

Automation for azure-sdk-for-node

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-node#2901

@AutorestCI
Copy link

AutorestCI commented May 17, 2018

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2614

@AutorestCI
Copy link

AutorestCI commented May 17, 2018

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#1897

@cthrash
Copy link
Contributor Author

cthrash commented May 18, 2018

I think the breaking-change script is picking up the fact the overload specification was change to placate --azure-validator. So whereas we previously had:

#/paths/analyze?overload=url
#/paths/analyze?overload=stream

we now have:

#/paths/analyze
#/paths/analyze?overload=stream

The rule in question is XmsPathsMustOverloadPaths/R2058/SDKViolation. Let me know if there's correct/better way to fix this.

@sergey-shandar
Copy link
Contributor

LGTM but the Ruby generator is still failing. I restarted the job.

@sergey-shandar sergey-shandar merged commit 0bc2413 into Azure:master May 23, 2018
konrad-jamrozik pushed a commit to dhung-msft/azure-rest-api-specs that referenced this pull request Dec 4, 2023
…tch-6

[Internal testing] testing openapi-alps PR 510778 - Test 11/14/2023 / 2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants