Skip to content

fix typo in Synapse #13994

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.

Sign up for GitHub

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

Jump to bottom
Merged
ruowan merged 1 commit into from
Apr 19, 2021
Merged

fix typo in Synapse #13994

ruowan merged 1 commit into from
Apr 19, 2021

Conversation

@tfitzmac
Copy link
Contributor

@tfitzmac tfitzmac commented Apr 16, 2021

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.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, fix typo in description
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

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.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service

  • 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.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@tfitzmac tfitzmac requested a review from idear1203 as a code owner April 16, 2021 21:53
@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented Apr 16, 2021

Hi, @tfitzmac Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Apr 16, 2021

    [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.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 16, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    ❌ R2026 - AvoidAnonymousTypes 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: synapse/common/v1/privateEndpointConnection.json#L326
    ❌ R2026 - AvoidAnonymousTypes 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: synapse/common/v1/privateEndpointConnection.json#L326
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'BigDataPools_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/bigDataPool.json#L25
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'IpFirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/firewallRule.json#L203
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'IntegrationRuntimes_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/integrationRuntime.json#L85
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'Keys_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/keys.json#L75
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'Library_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/library.json#L25
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'PrivateEndpointConnections_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/privateEndpointConnections.json#L46
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'PrivateLinkResources_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/privateLinkResources.json#L75
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'PrivateLinkHubPrivateLinkResources_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Synapse/preview/2021-04-01-preview/privateLinkResources.json#L175
    ️️✔️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 BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "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
    ⚠️ PreCheck/DuplicateSchema "readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "details":"Duplicate Schema named PrivateEndpointConnectionForPrivateLinkHubBasic -- properties.id.$ref: undefined => "#/components/schemas/schemas:1290",
    properties.id.description: "identifier" =>,
    properties.id.readOnly: true =>,
    properties.properties.description: "Properties of private endpoint connection for private link hub" =>,
    properties.properties.x-ms-client-flatten: true => "
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "details":"Schema 'ReplicationLink' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from ReplicationLink"
    ⚠️ PreNamer/DeduplicateName "readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "details":"Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated'"
    ⚠️ PreNamer/DeduplicateName "readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "details":"Deduplicating schema name: 'PrivateEndpointConnectionForPrivateLinkHubBasic' -> 'PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated'"
    ⚠️ PreCheck/DuplicateSchema "readme":"synapse/resource-manager/readme.md",
    "tag":"package-2021-03",
    "details":"Duplicate Schema named PrivateEndpointConnectionForPrivateLinkHubBasic -- properties.id.$ref: undefined => "#/components/schemas/schemas:1208",
    properties.id.description: "identifier" =>,
    properties.id.readOnly: true =>,
    properties.properties.description: "Properties of private endpoint connection for private link hub" =>,
    properties.properties.x-ms-client-flatten: true => "
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"synapse/resource-manager/readme.md",
    "tag":"package-2021-03",
    "details":"Schema 'ReplicationLink' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from ReplicationLink"
    ⚠️ PreNamer/DeduplicateName "readme":"synapse/resource-manager/readme.md",
    "tag":"package-2021-03",
    "details":"Deduplicating schema name: 'SecurityAlertPolicyName' -> 'SecurityAlertPolicyNameAutoGenerated'"
    ⚠️ PreNamer/DeduplicateName "readme":"synapse/resource-manager/readme.md",
    "tag":"package-2021-03",
    "details":"Deduplicating schema name: 'PrivateEndpointConnectionForPrivateLinkHubBasic' -> 'PrivateEndpointConnectionForPrivateLinkHubBasicAutoGenerated'"
    💬 AutorestCore/Exception "readme":"synapse/resource-manager/readme.md",
    "tag":"package-preview-2021-04",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    💬 AutorestCore/Exception "readme":"synapse/resource-manager/readme.md",
    "tag":"package-2021-03",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 16, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️❌ azure-sdk-for-go failed [Detail]
    • ❌Failed [Logs]Release - Generate from 9622c4f. SDK Automation 14.0.0 
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
cmderr	[main.go] [ERROR] expecting 4 matches for line '# Change History', but only get the following matches: []
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go
warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9622c4f. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/synapse/resource-manager/readme.md
    • ️✔️@azure/arm-synapse [View full logs]  [Release SDK Changes] 
      cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/synapseManagementClient.js → ./dist/arm-synapse.js...
cmderr	[npmPack] created ./dist/arm-synapse.js in 1.4s
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9622c4f. Schema Automation 14.0.0 
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️synapse [View full logs]  [Release Schema Changes]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9622c4f. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-synapse [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation PrivateEndpointConnectionsPrivateLinkHubOperations.get
info	[Changelog]   - Added operation group DataConnectionsOperations
info	[Changelog]   - Added operation group DatabasesOperations
info	[Changelog]   - Added operation group KustoPoolsOperations
info	[Changelog]   - Added operation group KustoOperations
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9622c4f. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-synapse [View full logs]  [Release SDK Changes] 
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation PrivateEndpointConnectionsPrivateLinkHubOperations.get
info	[Changelog]   - Added operation group DatabasesOperations
info	[Changelog]   - Added operation group KustoPoolsOperations
info	[Changelog]   - Added operation group KustoOperationsOperations
info	[Changelog]   - Added operation group DataConnectionsOperations
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9622c4f. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/synapse/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.Synapse [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9622c4f. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-04-19 08:24:01 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-synapse;1.0.0-beta.1;1.0.0-beta.2"
cmderr	[generate.py] 2021-04-19 08:24:01 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
cmderr	[generate.py] 2021-04-19 08:24:01 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.23 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/synapse/azure-resourcemanager-synapse --java.namespace=com.azure.resourcemanager.synapse   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/synapse/resource-manager/readme.md
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-synapse
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [POM][Skip] pom already has module azure-resourcemanager-synapse
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [POM][Skip] pom already has module sdk/synapse
cmderr	[generate.py] 2021-04-19 08:25:28 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-synapse [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-04-19 08:29:48 DEBUG Got artifact_id: azure-resourcemanager-synapse
cmderr	[Inst] 2021-04-19 08:29:48 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-04-19 08:29:48 DEBUG Got artifact: azure-resourcemanager-synapse-1.0.0-beta.2-sources.jar
cmderr	[Inst] 2021-04-19 08:29:48 DEBUG Got artifact: azure-resourcemanager-synapse-1.0.0-beta.2.jar
cmderr	[Inst] 2021-04-19 08:29:48 DEBUG Match jar package: azure-resourcemanager-synapse-1.0.0-beta.2.jar
cmderr	[Inst] 2021-04-19 08:29:48 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13994/azure-sdk-for-java/azure-resourcemanager-synapse/azure-resourcemanager-synapse-1.0.0-beta.2.jar\" -o azure-resourcemanager-synapse-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-synapse -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-synapse-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️❌[Staging] ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=208847&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory"
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Apr 16, 2021
    Closed
    This was referenced Apr 16, 2021
    Closed
    Closed
    This was referenced Apr 16, 2021
    Closed
    Closed
    Closed
    @ruowan ruowan merged commit 9622c4f into Azure:master Apr 19, 2021
    This was referenced Apr 19, 2021
    Merged
    Closed
    Closed
    Closed
    Closed
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @ruowan ruowan ruowan approved these changes

    +1 more reviewer

    @idear1203 idear1203 idear1203 approved these changes

    Reviewers whose approvals may not affect merge requirements

    Assignees

    @ruowan ruowan

    Labels

    CI-BreakingChange-Go CI-BreakingChange-Python

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @tfitzmac @idear1203 @ruowan