[DataFactory] GitHub bring your own app swagger update for ADF/Synapse Dataplane only #14689
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
|
Hi, @jmcallister-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version has a new optional property 'gitHubClientSecret' that was not found in the old version. New: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5047:7 Old: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5033:7 |
|
The new version has a new optional property 'gitHubClientSecret' that was not found in the old version. New: Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json#L90:7 Old: Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json#L76:7 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
Only 10 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
| "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2019-06-01-preview", "details":"The schema 'NotebookCellOutputItem-text' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json#/components/schemas/NotebookCellOutputItem-text" |
|
| "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2019-06-01-preview", "details":"The schema 'SynapseSparkJobActivityTypeProperties-argsItem' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json#/components/schemas/SynapseSparkJobActivityTypeProperties-argsItem" |
|
| 💬 AutorestCore/Exception | "readme":"datafactory/resource-manager/readme.md", "tag":"package-2018-06", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"datafactory/resource-manager/readme.md", "tag":"package-2018-06", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
"readme":"datafactory/resource-manager/readme.md", "tag":"package-2018-06", "details":"Error: Semantic validation failed. There was some errors" |
| 💬 AutorestCore/Exception | "readme":"datafactory/resource-manager/readme.md", "tag":"package-2018-06", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
| 💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2019-06-01-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2019-06-01-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌[Staging] SpellCheck: 4 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (byoa), please fix the error or add words to ./custom-words.txt path: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5022:10 |
|
Unknown word (byoa), please fix the error or add words to ./custom-words.txt path: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5026:10 |
|
Unknown word (byoa), please fix the error or add words to ./custom-words.txt path: Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json#L78:10 |
|
Unknown word (byoa), please fix the error or add words to ./custom-words.txt path: Microsoft.Synapse/preview/2019-06-01-preview/gitintegration.json#L82:10 |
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
jmcallister-msft
changed the title
This was referenced Jun 5, 2021
jmcallister-msft
changed the title
26 tasks
|
ARM PR can be found here: #14690 Broke it into two PR's at request of ARM review team. |
lmazuel
reviewed
Jun 7, 2021
...cation/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json
Outdated
Show resolved
Hide resolved
lmazuel
approved these changes
Jun 7, 2021
|
Hi, @jmcallister-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
|
Hi, @jmcallister-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
|
Pending breaking change approval |
This was referenced Jul 13, 2021
|
@jmcallister-msft There's a spellCheck failure caused by this PR. https://github.com/Azure/azure-rest-api-specs/pull/14689/checks?check_run_id=2768748057 Please fix it. |
|
@leni-msft How can we disable this spellcheck for "byoa." It stands for bring your own app and is the approved property name by our PM team. Is there a allow-list that we can update with this term? |
|
@jmcallister-msft yes, there's custom-words.txt to whitelist new words. BTW, it has been fixed in #14589 |
11 tasks
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
…e Dataplane only (Azure#14689) * GitHub bring your own app swagger changes for ADF/Synapse * fix different githubclientsecret description lint error * Separate dataplane changes to support GitHub BYOA in ADF/Synapse * remove unnecessary discriminator
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
June 7th, 2021
June, 2021
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.