Skip to content
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.

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

Adding summary field #11052

Merged
merged 1 commit into from
Oct 9, 2020
Merged

Adding summary field #11052

merged 1 commit into from
Oct 9, 2020

Conversation

dukum
Copy link
Member

@dukum dukum commented Oct 6, 2020

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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
    • Adding a new service
  • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 6, 2020

[Staging] Swagger Validation Report

BreakingChange: 1 Errors, 0 Warnings [Detail] [Expand]
Rule Message
1041 - AddedPropertyInResponse The new version has a new property 'summary' in response that was not found in the old version.
New: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1424:7
Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1409:7
️✔️LintDiff [Detail]
 Validation passes for LintDiff. 
️✔️Avocado [Detail]
 Validation passes for Avocado. 
️✔️ModelValidation [Detail]
 Validation passes for ModelValidation. 
️✔️SemanticValidation [Detail]
 Validation passes for SemanticValidation. 
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Oct 6, 2020

azure-resource-manager-schemas - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from bd03593 with merge commit c6aebe6. Schema Automation 13.0.17.20200918.2
    [regionmove][after_scripts|node] configure: WARNING: secure clearing/zeroing of memory is not supported by the selected crypto backend
    [regionmove][after_scripts|node] configure: WARNING: secure clearing/zeroing of memory is not supported by the selected crypto backend
    [regionmove][after_scripts|node] configure: WARNING: secure clearing/zeroing of memory is not supported by the selected crypto backend
  • ️✔️regionmove [View full logs]  [Release Schema Changes]
      [after_scripts|node] PostProcessor finished successfully.
      [after_scripts|node]   5779 passing (1m)
      AzureResourceSchema has no registered package commands.
      Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Fri, 09 Oct 2020 19:17:49 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"0781:662B:60DC196:72CF5BF:5F80B75D","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    azure-sdk-for-python-track2 - Release

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from bd03593 with merge commit c6aebe6. SDK Automation 13.0.17.20200918.2
      Failed to close the generation pull request at https://github.com/AzureSDKAutomation/azure-sdk-for-python/pull/2312: HttpError: Reference does not exist, {"name":"HttpError","status":422,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-length":"122","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Fri, 09 Oct 2020 19:11:36 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"422 Unprocessable Entity","strict-transport-security":"max-age=31536000; includeSubdomains; preload","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; format=json","x-github-request-id":"0745:424A:2792B2:41173A:5F80B5E7","x-ratelimit-limit":"5000","x-ratelimit-remaining":"4384","x-ratelimit-reset":"1602273469","x-ratelimit-used":"616","x-xss-protection":"1; mode=block"},"request":{"method":"DELETE","url":"https://api.github.com/repos/AzureSDKAutomation/azure-sdk-for-python/git/refs/heads/sdkAutomation/track2_azure-mgmt-resourcemover@11052","headers":{"accept":"application/vnd.github.v3+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"token [REDACTED]","content-length":0},"request":{"validate":{"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest/reference/git#delete-a-reference"}
      Failed to close the generation pull request at https://github.com/AzureSDKAutomation/azure-sdk-for-python/pull/2311: HttpError: Reference does not exist, {"name":"HttpError","status":422,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-length":"122","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Fri, 09 Oct 2020 19:11:36 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"422 Unprocessable Entity","strict-transport-security":"max-age=31536000; includeSubdomains; preload","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; format=json","x-github-request-id":"0741:4E9A:A7BF9:1B2577:5F80B5E8","x-ratelimit-limit":"5000","x-ratelimit-remaining":"4381","x-ratelimit-reset":"1602273469","x-ratelimit-used":"619","x-xss-protection":"1; mode=block"},"request":{"method":"DELETE","url":"https://api.github.com/repos/AzureSDKAutomation/azure-sdk-for-python/git/refs/heads/sdkAutomation/azure-mgmt-resourcemover@11052","headers":{"accept":"application/vnd.github.v3+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"token [REDACTED]","content-length":0},"request":{"validate":{"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest/reference/git#delete-a-reference"}
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'MoveResourceProperties-sourceResourceSettings' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'MoveResourceProperties-moveStatus' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'MoveResourceProperties-errors' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'SubnetReference' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'LoadBalancerBackendAddressPoolReference' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'LoadBalancerNatRuleReference' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'SqlServerResourceSettings' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'ResourceGroupResourceSettings' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceProperties-sourceResourceSettings' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceProperties-moveStatus' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceProperties-errors' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceFilter' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceFilterProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'MoveResourceErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'CloudError' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/SchemaMissingType): The schema 'CloudErrorBody' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
      [AutoRest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      [track2_azure-mgmt-resourcemover][breaking_change_report_pypi] WARNING:__main__:Version 1.0.1b1 seems to be too old to build a report (probably not Autorest based)
      [track2_azure-mgmt-resourcemover][ChangeLog] WARNING: Failed to generate ChangeLog.
    • ⚠️azure-mgmt-resourcemover [View full logs]  [Release SDK Changes]
      [build_conf_init]   Cache entry deserialization failed, entry ignored
      [build_conf_init]   Cache entry deserialization failed, entry ignored
      [build_conf] INFO:packaging_tools:Building template azure-mgmt-resourcemover
      [build_conf] INFO:packaging_tools.conf:Skipping default conf since the file exists
      [build_conf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
      [build_conf] INFO:packaging_tools:Template done azure-mgmt-resourcemover
      [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
      [build_package]   warnings.warn(msg)
      [build_package] /z/venv/lib/python3.6/site-packages/setuptools/dist.py:397: UserWarning: Normalizing '0.1.0-preview' to '0.1.0rc0'
      [build_package]   normalized_version,
      [build_package] warning: no files found matching '*.py' under directory 'tests'
      [build_package] warning: no files found matching '*.yaml' under directory 'tests'
      [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
      [build_package]   warnings.warn(msg)
      [build_package] /z/venv/lib/python3.6/site-packages/setuptools/dist.py:397: UserWarning: Normalizing '0.1.0-preview' to '0.1.0rc0'
      [build_package]   normalized_version,
      [build_package] warning: no files found matching '*.py' under directory 'tests'
      [build_package] warning: no files found matching '*.yaml' under directory 'tests'
      Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Fri, 09 Oct 2020 19:13:02 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"0740:527B:88A4B:154E64:5F80B63E","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}
      [breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      [breaking_change_report_pypi] WARNING:__main__:Version 1.0.1b1 seems to be too old to build a report (probably not Autorest based)
      Not exact 2 reports found:
      code_reports/latest/report.json
      Not generating changelog.
      [ChangeLog] WARNING: Failed to generate ChangeLog.

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    Azure CLI Extension Generation - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    azure-sdk-for-java - Release

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from bd03593 with merge commit c6aebe6. SDK Automation 13.0.17.20200918.2
      Failed to find any diff after autorest so no changed packages was found.

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    azure-sdk-for-net - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    azure-sdk-for-go - Release

    ️✔️ succeeded [Logs] [Expand Details]
    • ️✔️ Generate from bd03593 with merge commit c6aebe6. SDK Automation 13.0.17.20200918.2
    • ️✔️preview/resourcemover/mgmt/2019-10-01-preview [View full logs]  [Release SDK Changes]
      Unable to get details about the head commit. This is probably because the head commit is in a fork that we don't have permission to read from. HttpError: Not Found {"name":"HttpError","status":404,"headers":{"access-control-allow-origin":"*","access-control-expose-headers":"ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset","connection":"close","content-encoding":"gzip","content-security-policy":"default-src 'none'","content-type":"application/json; charset=utf-8","date":"Fri, 09 Oct 2020 19:14:37 GMT","referrer-policy":"origin-when-cross-origin, strict-origin-when-cross-origin","server":"GitHub.com","status":"404 Not Found","strict-transport-security":"max-age=31536000; includeSubdomains; preload","transfer-encoding":"chunked","vary":"Accept-Encoding, Accept, X-Requested-With","x-content-type-options":"nosniff","x-frame-options":"deny","x-github-media-type":"github.v3; param=machine-man-preview; format=json","x-github-request-id":"0401:13330:3551881:3E95EF6:5F80B69D","x-xss-protection":"1; mode=block"},"request":{"method":"POST","url":"https://api.github.com/app/installations//access_tokens","headers":{"accept":"application/vnd.github.machine-man-preview+json","user-agent":"octokit.js/16.43.1 Node.js/13.14.0 (Linux 5.4; x64)","authorization":"bearer [REDACTED]","content-type":"application/json; charset=utf-8"},"body":"{}","request":{"validate":{"commit_sha":{"alias":"ref","deprecated":true,"type":"string"},"owner":{"required":true,"type":"string"},"ref":{"required":true,"type":"string"},"repo":{"required":true,"type":"string"},"sha":{"alias":"ref","deprecated":true,"type":"string"}}}},"documentation_url":"https://docs.github.com/rest"}

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    Trenton Generation - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Oct 6, 2020

    azure-sdk-for-js - Release

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from bd03593 with merge commit c6aebe6. SDK Automation 13.0.17.20200918.2
      Failed to find any diff after autorest so no changed packages was found.

    @dukum
    Copy link
    Member Author

    dukum commented Oct 8, 2020

    Explanation for the breaking change:

    Rule Message Reason
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'summary' in response that was not found in the old version.
    New: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1424:7
    Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1409:7
    No existing users of the api wil be impacted. We have just enhanced the response of the current api to contain new information..

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants