Add version 2023-10-01-preview for Purview.Workflow #25893
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wuweiran
requested review from
JeffreyRichter
and removed request for
a team
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| purviewWorkflow.json | 2023-10-01-preview(d9cab54) | 2022-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 17 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-2023-10-01-preview | package-2023-10-01-preview(d9cab54) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L89 |
||
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Workflow_CreateOrReplace' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema' Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L118 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L123 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L166 |
||
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L194 |
||
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L194 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L199 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L206 |
||
| Error response should contain a x-ms-error-code header. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L229 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowRunModel'. Consider using the plural form of 'WorkflowRun' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L360 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowRunModel'. Consider using the plural form of 'WorkflowRun' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L396 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowTaskModel'. Consider using the plural form of 'WorkflowTask' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L519 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApprovalModel'. Consider using the plural form of 'Approval' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L552 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ApprovalModel'. Consider using the plural form of 'Approval' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L594 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowTaskModel'. Consider using the plural form of 'WorkflowTask' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L636 |
||
| Schema should have a description or title. Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1228 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Azure.Analytics.Purview.Workflow/preview/2023-10-01-preview/purviewWorkflow.json#L1259 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️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
|
Generated ApiView
|
This was referenced Sep 21, 2023
|
Hi @wuweiran! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
JeffreyRichter
approved these changes
Oct 10, 2023
JeffreyRichter
added
the
APIStewardshipBoard-SignedOff
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Oct 11, 2023
This was referenced Oct 16, 2023
3 tasks
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
* Add version 2023-10-01-preview for Purview.Workflow * Fix * Fix * Fix * Fix * Fix * Add description about max page size --------- Co-authored-by: Weiran Wu <weiranwu@microsoft.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
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.
Is this review for (select one):
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.
/workflows/{workflowId}/validate,/workflowtasks,/workflowrunsViewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment 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.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links