azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Update documentation for Custom Vision v3.2 Training API
Data Plane API - Pull Request
Update documentation for Custom Vision v3.2 Training API
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
- Link to API Spec engagement record issue:
Is this review for (select one):
- [ ] a private preview
- [ ] a public preview
- [ ] GA release
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
- Design Document:
- Previous API Spec Doc:
- Updated paths:
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the Swagger-Suppression-Process to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
Guidelines & Specifications
Helpful Links
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 55 Errors, 0 Warnings failed [Detail]
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| Training.json | v3.2(800ae45) | v3.2(main) |
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L252:9 Old: Training/stable/v3.2/Training.json#L270:9 |
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L804:9 Old: Training/stable/v3.2/Training.json#L856:9 |
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L1207:9 Old: Training/stable/v3.2/Training.json#L1279:9 |
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L1559:9 Old: Training/stable/v3.2/Training.json#L1650:9 |
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L2096:9 Old: Training/stable/v3.2/Training.json#L2211:9 |
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L2142:9 Old: Training/stable/v3.2/Training.json#L2258:9 |
|
The old version did not support 'application/json' as a response body format. New: Training/stable/v3.2/Training.json#L2565:9 Old: Training/stable/v3.2/Training.json#L2700:9 |
|
The operation id has been changed from 'GetDomains' to 'Domains_List'. This will impact generated code. New: Training/stable/v3.2/Training.json#L14:7 Old: Training/stable/v3.2/Training.json#L14:7 |
|
The operation id has been changed from 'GetDomain' to 'Domains_Get'. This will impact generated code. New: Training/stable/v3.2/Training.json#L49:7 Old: Training/stable/v3.2/Training.json#L52:7 |
|
The operation id has been changed from 'GetProjects' to 'Projects_List'. This will impact generated code. New: Training/stable/v3.2/Training.json#L91:7 Old: Training/stable/v3.2/Training.json#L97:7 |
|
The operation id has been changed from 'CreateProject' to 'Projects_Create'. This will impact generated code. New: Training/stable/v3.2/Training.json#L124:7 Old: Training/stable/v3.2/Training.json#L133:7 |
|
The operation id has been changed from 'GetProject' to 'Projects_Get'. This will impact generated code. New: Training/stable/v3.2/Training.json#L208:7 Old: Training/stable/v3.2/Training.json#L220:7 |
|
The operation id has been changed from 'DeleteProject' to 'Projects_Delete'. This will impact generated code. New: Training/stable/v3.2/Training.json#L248:7 Old: Training/stable/v3.2/Training.json#L263:7 |
|
The operation id has been changed from 'UpdateProject' to 'Projects_Update'. This will impact generated code. New: Training/stable/v3.2/Training.json#L283:7 Old: Training/stable/v3.2/Training.json#L299:7 |
|
The operation id has been changed from 'ExportProject' to 'Projects_Export'. This will impact generated code. New: Training/stable/v3.2/Training.json#L339:7 Old: Training/stable/v3.2/Training.json#L358:7 |
|
The operation id has been changed from 'CreateImagesFromData' to 'Images_CreateFromData'. This will impact generated code. New: Training/stable/v3.2/Training.json#L381:7 Old: Training/stable/v3.2/Training.json#L403:7 |
|
The operation id has been changed from 'DeleteImages' to 'Images_Delete'. This will impact generated code. New: Training/stable/v3.2/Training.json#L446:7 Old: Training/stable/v3.2/Training.json#L472:7 |
|
The operation id has been changed from 'GetImageRegionProposals' to 'Images_GetRegionProposals'. This will impact generated code. New: Training/stable/v3.2/Training.json#L517:7 Old: Training/stable/v3.2/Training.json#L546:7 |
|
The operation id has been changed from 'CreateImagesFromFiles' to 'Images_CreateFromFiles'. This will impact generated code. New: Training/stable/v3.2/Training.json#L566:7 Old: Training/stable/v3.2/Training.json#L599:7 |
|
The operation id has been changed from 'GetImagesByIds' to 'Images_ListByIds'. This will impact generated code. New: Training/stable/v3.2/Training.json#L622:7 Old: Training/stable/v3.2/Training.json#L659:7 |
|
The operation id has been changed from 'CreateImagesFromPredictions' to 'Images_CreateFromPredictions'. This will impact generated code. New: Training/stable/v3.2/Training.json#L690:7 Old: Training/stable/v3.2/Training.json#L731:7 |
|
The operation id has been changed from 'CreateImageRegions' to 'Images_CreateRegions'. This will impact generated code. New: Training/stable/v3.2/Training.json#L746:7 Old: Training/stable/v3.2/Training.json#L791:7 |
|
The operation id has been changed from 'DeleteImageRegions' to 'Images_DeleteRegions'. This will impact generated code. New: Training/stable/v3.2/Training.json#L800:7 Old: Training/stable/v3.2/Training.json#L849:7 |
|
The operation id has been changed from 'QuerySuggestedImages' to 'Images_ListSuggested'. This will impact generated code. New: Training/stable/v3.2/Training.json#L852:7 Old: Training/stable/v3.2/Training.json#L902:7 |
|
The operation id has been changed from 'QuerySuggestedImageCount' to 'Images_GetSuggestedCount'. This will impact generated code. New: Training/stable/v3.2/Training.json#L917:7 Old: Training/stable/v3.2/Training.json#L971:7 |
|
The operation id has been changed from 'GetTaggedImages' to 'Images_ListTagged'. This will impact generated code. New: Training/stable/v3.2/Training.json#L986:7 Old: Training/stable/v3.2/Training.json#L1044:7 |
|
The operation id has been changed from 'GetTaggedImageCount' to 'Images_GetTaggedCount'. This will impact generated code. New: Training/stable/v3.2/Training.json#L1085:7 Old: Training/stable/v3.2/Training.json#L1147:7 |
|
The operation id has been changed from 'CreateImageTags' to 'Images_CreateTags'. This will impact generated code. New: Training/stable/v3.2/Training.json#L1149:7 Old: Training/stable/v3.2/Training.json#L1215:7 |
|
The operation id has been changed from 'DeleteImageTags' to 'Images_DeleteTags'. This will impact generated code. New: Training/stable/v3.2/Training.json#L1203:7 Old: Training/stable/v3.2/Training.json#L1272:7 |
|
The operation id has been changed from 'GetUntaggedImages' to 'Images_ListUntagged'. This will impact generated code. New: Training/stable/v3.2/Training.json#L1270:7 Old: Training/stable/v3.2/Training.json#L1340:7 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 0 Errors, 2 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| release_3_2 | release_3_2(800ae45) | release_3_2(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: GetInOperationName | 'GET' operation 'Projects_Export' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Training/stable/v3.2/Training.json#L341 |
|
| :warning: DeleteInOperationName | 'DELETE' operation 'Iterations_Unpublish' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Training/stable/v3.2/Training.json#L2094 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L156 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L173 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Training/stable/v3.2/Training.json#L446 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Training/stable/v3.2/Training.json#L963 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L1028 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L1297 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L1744 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L1758 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L1907 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L2470 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L2763 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L3988 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Training/stable/v3.2/Training.json#L4405 |
|
The host parameter must be called 'endpoint'. Location: Training/stable/v3.2/Training.json#L4946 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: Training/stable/v3.2/Training.json#L4946 |
| :warning: VersionConvention | API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Training/stable/v3.2/Training.json#L4 |
| :warning: VersionPolicy | Version segment 'v3.2' in basePath violates Azure versioning policy. Location: Training/stable/v3.2/Training.json#L8 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Training/stable/v3.2/Training.json#L23 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Training/stable/v3.2/Training.json#L34 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: Training/stable/v3.2/Training.json#L36 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Training/stable/v3.2/Training.json#L58 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Training/stable/v3.2/Training.json#L59 |
| :warning: Nullable | Avoid the use of x-nullable. Location: Training/stable/v3.2/Training.json#L66 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Training/stable/v3.2/Training.json#L76 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: Training/stable/v3.2/Training.json#L78 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Training/stable/v3.2/Training.json#L100 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Training/stable/v3.2/Training.json#L111 |
| :warning: ErrorResponse | Error response schema should contain an object property named error.Location: Training/stable/v3.2/Training.json#L113 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: Training/stable/v3.2/Training.json#L133 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: Training/stable/v3.2/Training.json#L193 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | v3.2 | https://apiview.dev/Assemblies/Review/1f292fb0d6e7425f9a532ce54f108f6a?revisionId=44ba794f152140e2981bf9e97b4d5e5f |
Hi @mikekistler , could you please approve breaking changes for this PR as well? I just fixed the lint errors.
