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

Add new version0526 public #19401

Merged
merged 5 commits into from
Jun 13, 2022
Merged

Conversation

yunho-microsoft
Copy link
Contributor

@yunho-microsoft yunho-microsoft commented Jun 9, 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 language 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 appy 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 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, @yunho-microsoft 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. [email protected]

    1 similar comment
    @openapi-workflow-bot
    Copy link

    Hi, @yunho-microsoft 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 9, 2022

    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:
    Rule Message
    R4041 - XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.FluidRelay/stable/2022-05-26/fluidrelay.json#L653
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: Microsoft.FluidRelay/stable/2022-05-26/fluidrelay.json#L643
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get keys for a Fluid Relay server
    Location: Microsoft.FluidRelay/stable/2022-05-26/fluidrelay.json#L355
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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 succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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 Jun 9, 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-fluidrelay - 1.0.0b1
    ️✔️azure-sdk-for-go - preview/fluidrelay/mgmt/2021-06-15-preview/fluidrelay - v65.0.0
    ️✔️azure-sdk-for-go - preview/fluidrelay/mgmt/2021-03-12-preview/fluidrelay - v65.0.0
    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9a6b574. 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]  global `--global`, `--local` are deprecated. Use `--location=global` instead.
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.11.0 -> 8.12.1
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.12.1>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-fluidrelay [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation FluidRelayServersOperations.list_keys
      info	[Changelog]   - Added operation group FluidRelayContainersOperations
      info	[Changelog]   - Model FluidRelayEndpoints has a new parameter service_endpoints
      info	[Changelog]   - Model FluidRelayServer has a new parameter encryption
      info	[Changelog]   - Model FluidRelayServer has a new parameter storagesku
      info	[Changelog]   - Model FluidRelayServerUpdate has a new parameter encryption
      info	[Changelog]   - Model FluidRelayServerUpdate has a new parameter location
      info	[Changelog]   - Model Identity has a new parameter user_assigned_identities
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Operation FluidRelayServersOperations.create_or_update has a new parameter fluid_relay_server_name
      info	[Changelog]   - Operation FluidRelayServersOperations.create_or_update no longer has parameter name
      info	[Changelog]   - Operation FluidRelayServersOperations.delete has a new parameter fluid_relay_server_name
      info	[Changelog]   - Operation FluidRelayServersOperations.delete no longer has parameter name
      info	[Changelog]   - Operation FluidRelayServersOperations.get has a new parameter fluid_relay_server_name
      info	[Changelog]   - Operation FluidRelayServersOperations.get no longer has parameter name
      info	[Changelog]   - Operation FluidRelayServersOperations.get_keys has a new parameter fluid_relay_server_name
      info	[Changelog]   - Operation FluidRelayServersOperations.get_keys no longer has parameter name
      info	[Changelog]   - Operation FluidRelayServersOperations.regenerate_key has a new parameter fluid_relay_server_name
      info	[Changelog]   - Operation FluidRelayServersOperations.regenerate_key no longer has parameter name
      info	[Changelog]   - Operation FluidRelayServersOperations.update has a new parameter fluid_relay_server_name
      info	[Changelog]   - Operation FluidRelayServersOperations.update no longer has parameter name
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9a6b574. 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] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
      cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    • ️✔️azure-resourcemanager-fluidrelay [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9a6b574. 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/fluidrelay/mgmt/2021-06-15-preview/fluidrelay [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
      info	[Changelog]
    • ️✔️preview/fluidrelay/mgmt/2021-03-12-preview/fluidrelay [View full logs
      info	[Changelog] This is a new package
      info	[Changelog]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9a6b574. 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]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  [email protected]: 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] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh]  @octokit/[email protected] 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
    • ️✔️@azure/arm-fluidrelay [View full logs]  [Release SDK Changes]
      info	[Changelog]
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9a6b574. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.FluidRelay [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot openapi-workflow-bot bot added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 9, 2022
    @openapi-workflow-bot
    Copy link

    Hi, @yunho-microsoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    1 similar comment
    @openapi-workflow-bot
    Copy link

    Hi, @yunho-microsoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    Copy link

    @raosuhas raosuhas left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    :shipit:

    @raosuhas raosuhas added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 10, 2022
    @openapi-workflow-bot openapi-workflow-bot bot removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 10, 2022
    gerrytan pushed a commit to gerrytan/azure-rest-api-specs that referenced this pull request Sep 6, 2024
    gerrytan added a commit that referenced this pull request Sep 20, 2024
    …o Terraform HCL (#30455)
    
    * New RP: Microsoft.AzureTerraform (ver=2023-07-01-preview)
    
    * prettier
    
    * remove x-ms-discriminator-value
    
    * readme.md: add `openapi-subtype`
    
    * Fix LintDiff failure
    
    * Result configuration type change from object to string
    
    * Remove properties: `subscriptionId` and `environment`
    
    * Change `errors` from list of string to list of `ErrorResponse`
    
    * Add operations endpoint
    
    * Update
    
    * Update
    
    * AzureTerraform RP: Sync the MS version with the private version
    
    * Terraform: Change `exportEerraform` endpoint to LRO (#18782)
    
    * terraform: Modify the `exportTerraform` RT to be LRO
    
    * Update
    
    * prettier
    
    * spell
    
    * CI validation
    
    * More CI issue fixes
    
    * typo
    
    * Add readme.go.md
    
    * typo
    
    * prettier
    
    * suppression
    
    * Update suppression
    
    * AzureTerrform: Remove the parallelism property (#18909)
    
    * exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults (#19178)
    
    * exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults
    
    * rename
    
    * rename
    
    * rename
    
    * Specify LRO model (#19401)
    
    * Add up the `resourceId` in `OperationStatus` model (#19450)
    
    * Add `uri` format (#19455)
    
    * Add format url
    
    * update
    
    * TypeSpec for Microsoft.AzureTerraform (#19390)
    
    * TypeSpec for Microsoft.AzureTerraform
    
    * Sorted swagger file, and added typespec generated with tsp-client
    
    * revert export.json in prep of merging
    
    * Sorted export.json for easy diff on future typespec -> swagger
    
    * Rerun swagger -> typespec conversion after merging latest RPSaaSMaster,
    updated namespace
    
    * tsp compile for TypeSpec -> swagger
    
    * Refactored typescript to minimise swagger diff
    
    * Spread ErrorResponse into OperationStatus model
    
    * Fixed enums, use doc decorator
    
    * Update exportTerraform path desc
    
    * Update doc for ExportResource model
    
    * LintDiff fix: remove unnecessary auth
    
    * Add resourceId prop to OperationStatus model, fixed char casing so they're consistent throughout
    
    * Made resourceId read only
    
    * Check `Swagger BreakingChange`: minimise diff on x-ms-enum
    
    * TypeSpec Validation fix: rename dir and add missing @doc
    
    * Upgrade/rp tsp 0.60 (#19551) -- applying only for specification/terraform
    
    * Revert accidental changes to cSpell.json while merging
    
    * Added tf files used for armstrong testing
    
    ---------
    
    Co-authored-by: magodo <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants