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 x-ms-ids for Automanage #17596

Merged
merged 4 commits into from
Feb 10, 2022

Conversation

agalerrotaru
Copy link
Contributor

@agalerrotaru agalerrotaru commented Feb 1, 2022

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

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. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required 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

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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.

@openapi-workflow-bot
Copy link

Hi, @agalerrotaru 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

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

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Feb 1, 2022
    @ghost
    Copy link

    ghost commented Feb 1, 2022

    Thank you for your contribution agalerrotaru! We will review the pull request and get back to you soon.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 1, 2022

    Swagger Validation Report

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

    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 1, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-python-track2 - track2_azure-mgmt-automanage - 1.0.0b2
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter account_id
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter compliance
    +	Model ConfigurationProfileAssignmentProperties no longer has parameter configuration_profile_preference_id
    +	Model Operation no longer has parameter status_code
    +	Removed operation ConfigurationProfileAssignmentsOperations.begin_create_or_update
    +	Removed operation group AccountsOperations
    +	Removed operation group ConfigurationProfilePreferencesOperations
    ️✔️azure-sdk-for-go - preview/automanage/mgmt/2021-04-30-preview/automanage - v61.4.0
    ️✔️azure-sdk-for-go - preview/automanage/mgmt/2020-06-30-preview/automanage - v61.4.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 45e82fa. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.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/automanage/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
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:427:8 ($.definitions.OperationListResult.properties.value)
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:316:8 ($.definitions.ErrorDetail.properties.additionalInfo)
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/common-types/resource-management/v2/types.json:304:8 ($.definitions.ErrorDetail.properties.details)
      cmderr	[Autorest] ERROR: Schema violation: Additional properties not allowed: x-ms-identifiers
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/automanage/resource-manager/Microsoft.Automanage/preview/2021-04-30-preview/automanage.json:1479:4 ($.definitions.Overrides)
      cmderr	[Autorest] FATAL: swagger-document/individual/schema-validator - FAILED
      cmderr	[Autorest] FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
      cmderr	[Autorest] Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 45e82fa. 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
      cmderr	[automation_generate.sh] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.4.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.4.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.4.1` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-automanage [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation ConfigurationProfileAssignmentsOperations.create_or_update
      info	[Changelog]   - Added operation group BestPracticesOperations
      info	[Changelog]   - Added operation group BestPracticesVersionsOperations
      info	[Changelog]   - Added operation group ConfigurationProfilesOperations
      info	[Changelog]   - Added operation group ConfigurationProfilesVersionsOperations
      info	[Changelog]   - Added operation group ReportsOperations
      info	[Changelog]   - Added operation group ServicePrincipalsOperations
      info	[Changelog]   - Model ConfigurationProfileAssignment has a new parameter system_data
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties has a new parameter profile_overrides
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties has a new parameter status
      info	[Changelog]   - Model Operation has a new parameter action_type
      info	[Changelog]   - Model Operation has a new parameter origin
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter account_id
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter compliance
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter configuration_profile_preference_id
      info	[Changelog]   - Model ConfigurationProfileAssignmentProperties no longer has parameter provisioning_status
      info	[Changelog]   - Model Operation no longer has parameter status_code
      info	[Changelog]   - Removed operation ConfigurationProfileAssignmentsOperations.begin_create_or_update
      info	[Changelog]   - Removed operation group AccountsOperations
      info	[Changelog]   - Removed operation group ConfigurationProfilePreferencesOperations
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 45e82fa. SDK Automation 14.0.0
      command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️preview/automanage/mgmt/2021-04-30-preview/automanage [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `ServicePrincipalsClient.Get(context.Context) (ServicePrincipal, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.GetPreparer(context.Context) (*http.Request, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.GetResponder(*http.Response) (ServicePrincipal, error)`
      info	[Changelog] - New function `*ServicePrincipal.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `ServicePrincipal.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `ServicePrincipalProperties.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscriptionSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `NewServicePrincipalsClientWithBaseURI(string, string) ServicePrincipalsClient`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscriptionPreparer(context.Context) (*http.Request, error)`
      info	[Changelog] - New function `NewServicePrincipalsClient(string) ServicePrincipalsClient`
      info	[Changelog] - New function `ServicePrincipalsClient.GetSender(*http.Request) (*http.Response, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscriptionResponder(*http.Response) (ServicePrincipalListResult, error)`
      info	[Changelog] - New function `ServicePrincipalsClient.ListBySubscription(context.Context) (ServicePrincipalListResult, error)`
      info	[Changelog] - New struct `ServicePrincipal`
      info	[Changelog] - New struct `ServicePrincipalListResult`
      info	[Changelog] - New struct `ServicePrincipalProperties`
      info	[Changelog] - New struct `ServicePrincipalsClient`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 21 additive change(s).
    • ️✔️preview/automanage/mgmt/2020-06-30-preview/automanage [View full logs
      info	[Changelog] ### Other Changes
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 45e82fa. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh]  read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh] WARN deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh]  @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  notice created a lockfile as package-lock.json. You should commit this file.
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️track2_@azure/arm-automanage [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    Posted by Swagger Pipeline | How to fix these errors?

    @ikanni ikanni self-requested a review February 8, 2022 20:31
    @agalerrotaru agalerrotaru reopened this Feb 9, 2022
    @agalerrotaru
    Copy link
    Contributor Author

    /azp run

    @azure-pipelines
    Copy link

    Commenter does not have sufficient privileges for PR 17596 in repo Azure/azure-rest-api-specs

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    customer-reported Issues that are reported by GitHub users external to the Azure organization.
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants