Skip to content

[Hub Generated] Publish private branch 'datafactory/binluwang/swaggeredit'#20187

Merged
leniatgh merged 1 commit into
mainfrom
published/Azure/azure-rest-api-specs-pr/datafactory/binluwang/swaggeredit
Aug 11, 2022
Merged

[Hub Generated] Publish private branch 'datafactory/binluwang/swaggeredit'#20187
leniatgh merged 1 commit into
mainfrom
published/Azure/azure-rest-api-specs-pr/datafactory/binluwang/swaggeredit

Conversation

@Frey-Wang
Copy link
Copy Markdown
Member

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for 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, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@Frey-Wang
Copy link
Copy Markdown
Member Author

The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/8118

@openapi-workflow-bot
Copy link
Copy Markdown

Hi, @Frey-Wang 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Aug 11, 2022

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.6)] new version base version
    datafactory.json 2018-06-01(c3e7ffa) 2018-06-01(main)
    Rule Message
    1008 - ModifiedOperationId The operation id has been changed from 'managedPrivateEndpoints_CreateOrUpdate' to 'ManagedPrivateEndpoints_CreateOrUpdate'. This will impact generated code.
    New: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L3966:7
    Old: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L3966:7
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2018-06 package-2018-06(c3e7ffa) package-2018-06(main)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4872
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6077
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6202
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6661
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6665
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6697
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6822
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6916
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6920
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L6936
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.DataFactory/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L36
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4558
    R4037 - MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4599
    R4037 - MissingTypeObject The schema 'SubResourceDebugResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4625
    R4037 - MissingTypeObject The schema 'IntegrationRuntimeReference' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4756
    R4037 - MissingTypeObject The schema 'IntegrationRuntimeReference' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4756
    R4037 - MissingTypeObject The schema 'IntegrationRuntimeReference' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4756
    R4037 - MissingTypeObject The schema 'IntegrationRuntimeResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4780
    R4037 - MissingTypeObject The schema 'IntegrationRuntimeDebugResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4797
    R4037 - MissingTypeObject The schema 'IntegrationRuntimeStatusResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L4814
    R4037 - MissingTypeObject The schema 'FactoryRepoUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5307
    R4037 - MissingTypeObject The schema 'GitHubAccessTokenRequest' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5320
    R4037 - MissingTypeObject The schema 'GitHubAccessTokenResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5345
    R4037 - MissingTypeObject The schema 'UserAccessPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5354
    R4037 - MissingTypeObject The schema 'AccessPolicyResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5379
    R4037 - MissingTypeObject The schema 'FactoryProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5396
    R4037 - MissingTypeObject The schema 'EncryptionConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5463
    R4037 - MissingTypeObject The schema 'CMKIdentityDefinition' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5488
    R4037 - MissingTypeObject The schema 'PipelineReference' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5556
    R4037 - MissingTypeObject The schema 'PipelineReference' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.DataFactory/stable/2018-06-01/datafactory.json#L5556
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 94 Errors, 0 Warnings failed [Detail] Service API Readiness Test failed. Check pipeline artifact for detail report.

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

    Rule Message
    OBJECT_ADDITIONAL_PROPERTIES "Additional properties not allowed: factoryStatistics"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: NoRegisteredProviderFound,
    errorMessage: No registered resource provider found for location 'locationid2rejpa' and API version '2018-06-01' for type 'locations/configureFactoryRepo'. The supported api-versions are '2018-06-01,
    2018-07-01-preview,
    2017-09-01-preview'. The supported locations are 'eastus,
    eastus2,
    westus2,
    westus,
    centralus,
    southcentralus,
    japaneast,
    australiaeast,
    switzerlandnorth,
    germanywestcentral,
    canadacentral,
    centralindia,
    brazilsouth,
    francecentral,
    koreacentral,
    westeurope,
    northeurope,
    uksouth,
    westcentralus,
    southeastasia,
    eastasia,
    northcentralus,
    southafricanorth,
    australiasoutheast,
    southindia,
    canadaeast,
    ukwest,
    japanwest,
    norwayeast,
    uaenorth,
    westus3,
    jioindiawest,
    switzerlandwest,
    francesouth,
    eastus2euap'."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: BadRequest,
    errorMessage: GitHubClientId is invalid"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: OutboundNetworkDependenciesDiscoveryIsUnsupported,
    errorMessage: The integration runtime type of 'integratiomll5n7' doesn't support the discovery of outbound network dependencies. Currently,
    only Azure-SSIS integration runtime supports this operation."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: Resource integrationRuntime not found."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: UnsupportedVersionForSharableIR,
    errorMessage: null"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    INVALID_TYPE "Expected type string but found type null"
    OBJECT_ADDITIONAL_PROPERTIES "Additional properties not allowed: serviceRegion"
    OBJECT_ADDITIONAL_PROPERTIES "Additional properties not allowed: newerVersions"
    RUNTIME_ERROR "statusCode: 405,
    errorCode: undefined,
    errorMessage: undefined"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 405"
    INVALID_CONTENT_TYPE "Invalid Content-Type (application/octet-stream). These are supported: application/json"
    INVALID_RESPONSE_BODY "Body is required in response but not provided"
    RUNTIME_ERROR "statusCode: 405,
    errorCode: undefined,
    errorMessage: undefined"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 405"
    INVALID_CONTENT_TYPE "Invalid Content-Type (application/octet-stream). These are supported: application/json"
    INVALID_RESPONSE_BODY "Body is required in response but not provided"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: BadRequest,
    errorMessage: The document creation or update failed because of invalid reference 'examplepipeline'."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    RUNTIME_ERROR "statusCode: 404,
    errorCode: NotFound,
    errorMessage: The document could not be retrieved because it does not exist."
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 404"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: BadRequest,
    errorMessage: Entity triggernam2oah5g not found"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    RUNTIME_ERROR "statusCode: 400,
    errorCode: BadRequest,
    errorMessage: Entity triggernam2oah5g not found"
    RUNTIME_ERROR "errorCode: AssertionError,
    errorMessage: expected response code to be 2XX but found 400"
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 2 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/c3e7ffa82cc6d5d7b760db0c6b9172088fcfea4a/specification/datafactory/resource-manager/readme.md#tag-package-2018-06">datafactory/resource-manager/readme.md#package-2018-06
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ Modeler/MissingType "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"The schema 'SynapseSparkJobActivityTypeProperties-argsItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json#/components/schemas/SynapseSparkJobActivityTypeProperties-argsItem"
    ⚠️ Modeler/MissingType "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"The schema 'SynapseSparkJobActivityTypeProperties-filesItem' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json#/components/schemas/SynapseSparkJobActivityTypeProperties-filesItem"


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Schema 'DataFlowSource' has a property 'dataset' that is already declared the parent schema 'Transformation' but isn't significantly different. The property has been removed from DataFlowSource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Schema 'DataFlowSource' has a property 'linkedService' that is already declared the parent schema 'Transformation' but isn't significantly different. The property has been removed from DataFlowSource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Schema 'DataFlowSource' has a property 'flowlet' that is already declared the parent schema 'Transformation' but isn't significantly different. The property has been removed from DataFlowSource"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Schema 'DataFlowSink' has a property 'dataset' that is already declared the parent schema 'Transformation' but isn't significantly different. The property has been removed from DataFlowSink"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Schema 'DataFlowSink' has a property 'linkedService' that is already declared the parent schema 'Transformation' but isn't significantly different. The property has been removed from DataFlowSink"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Schema 'DataFlowSink' has a property 'flowlet' that is already declared the parent schema 'Transformation' but isn't significantly different. The property has been removed from DataFlowSink"
    ⚠️ UnkownSecurityScheme "readme":"datafactory/resource-manager/readme.md",
    "tag":"package-2018-06",
    "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Aug 11, 2022

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Aug 11, 2022

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-datafactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-datafactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-datafactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @openapi-workflow-bot
    Copy link
    Copy Markdown

    Hi @Frey-Wang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @leniatgh leniatgh added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 11, 2022
    @leniatgh leniatgh merged commit 2421768 into main Aug 11, 2022
    @leniatgh leniatgh deleted the published/Azure/azure-rest-api-specs-pr/datafactory/binluwang/swaggeredit branch August 11, 2022 08:04
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go Data Factory resource-manager

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants