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.

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

[Microsoft.StorageSync] Fix readme.md file so that tag information includes full API version 2022-06-01 #20262

Closed
wants to merge 1 commit into from
Closed

[Microsoft.StorageSync] Fix readme.md file so that tag information includes full API version 2022-06-01 #20262

wants to merge 1 commit into from

Conversation

anpint
Copy link
Member

@anpint anpint commented Aug 16, 2022 •
edited
Loading

Autogenerated updates for the readme.md file for our specification introduced the new API version without the day component (the just has references to 2022-06). This PR fixes the readme file so that it references the full API version.

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

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
      Fixing readme file
  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.
    N/A for this PR
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    N/A for this PR
  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, @anpint 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 Aug 16, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-06-01 package-2022-06-01(b7155d3) default(dev-storagesync-Microsoft.StorageSync-2022-06-01-A01)
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/b7155d3e35a402ae8c9b6b239b5a324ac10d2c02/specification/storagesync/resource-manager/readme.md#tag-package-2022-06-01">storagesync/resource-manager/readme.md#package-2022-06-01
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"storagesync/resource-manager/readme.md",
    "tag":"package-2022-06-01",
    "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.
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking


    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-storagesync - 1.0.0
    +	Model StorageSyncApiError no longer has parameter inner_error
    ️✔️azure-sdk-for-js - @azure/arm-storagesync - 10.0.0
    +	Interface StorageSyncApiError no longer has parameter innerError
    ️❌ azure-sdk-for-net failed [Detail]
    • ❌Failed [Logs] Generate from a83be959b195685c5a51f3b07405c17fdff34ac6. 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=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/storagesync/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] No usable version of the libssl was found
cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
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] Generate from a83be959b195685c5a51f3b07405c17fdff34ac6. 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.
    • ️✔️track2_azure-mgmt-storagesync [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Added operation group MicrosoftStorageSyncOperationsMixin
info	[Changelog]   - Model CloudEndpoint has a new parameter change_enumeration_status
info	[Changelog]   - Model CloudEndpoint has a new parameter system_data
info	[Changelog]   - Model CloudEndpointCreateParameters has a new parameter system_data
info	[Changelog]   - Model OperationResourceMetricSpecification has a new parameter supported_aggregation_types
info	[Changelog]   - Model PrivateEndpointConnection has a new parameter system_data
info	[Changelog]   - Model PrivateLinkResource has a new parameter system_data
info	[Changelog]   - Model ProxyResource has a new parameter system_data
info	[Changelog]   - Model RegisteredServer has a new parameter system_data
info	[Changelog]   - Model RegisteredServerCreateParameters has a new parameter system_data
info	[Changelog]   - Model Resource has a new parameter system_data
info	[Changelog]   - Model ServerEndpoint has a new parameter initial_upload_policy
info	[Changelog]   - Model ServerEndpoint has a new parameter system_data
info	[Changelog]   - Model ServerEndpointBackgroundDataDownloadActivity has a new parameter started_timestamp
info	[Changelog]   - Model ServerEndpointCloudTieringStatus has a new parameter low_disk_mode
info	[Changelog]   - Model ServerEndpointCreateParameters has a new parameter initial_upload_policy
info	[Changelog]   - Model ServerEndpointCreateParameters has a new parameter system_data
info	[Changelog]   - Model ServerEndpointSyncActivityStatus has a new parameter session_minutes_remaining
info	[Changelog]   - Model StorageSyncApiError has a new parameter innererror
info	[Changelog]   - Model StorageSyncService has a new parameter system_data
info	[Changelog]   - Model SyncGroup has a new parameter system_data
info	[Changelog]   - Model SyncGroupCreateParameters has a new parameter system_data
info	[Changelog]   - Model TrackedResource has a new parameter system_data
info	[Changelog]   - Model Workflow has a new parameter system_data
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model StorageSyncApiError no longer has parameter inner_error
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from a83be959b195685c5a51f3b07405c17fdff34ac6. SDK Automation 14.0.0 
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️armstoragesync [View full logs]  [Preview SDK Changes] 
      info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New const `CloudTieringLowDiskModeStateEnabled`
info	[Changelog] - New const `CloudTieringLowDiskModeStateDisabled`
info	[Changelog] - New function `PossibleCloudTieringLowDiskModeStateValues() []CloudTieringLowDiskModeState`
info	[Changelog] - New struct `CloudTieringLowDiskMode`
info	[Changelog] - New field `LowDiskMode` in struct `ServerEndpointCloudTieringStatus`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 6 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from a83be959b195685c5a51f3b07405c17fdff34ac6. 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
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-storagesync [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added Interface CloudEndpoint
info	[Changelog]   - Added Interface CloudEndpointCreateParameters
info	[Changelog]   - Added Interface CloudTieringLowDiskMode
info	[Changelog]   - Added Interface PrivateEndpointConnection
info	[Changelog]   - Added Interface PrivateLinkResource
info	[Changelog]   - Added Interface ProxyResource
info	[Changelog]   - Added Interface RegisteredServer
info	[Changelog]   - Added Interface RegisteredServerCreateParameters
info	[Changelog]   - Added Interface ServerEndpoint
info	[Changelog]   - Added Interface ServerEndpointCreateParameters
info	[Changelog]   - Added Interface StorageSyncService
info	[Changelog]   - Added Interface SyncGroup
info	[Changelog]   - Added Interface SyncGroupCreateParameters
info	[Changelog]   - Added Interface SystemData
info	[Changelog]   - Added Interface TrackedResource
info	[Changelog]   - Added Interface Workflow
info	[Changelog]   - Added Type Alias CloudTieringLowDiskModeState
info	[Changelog]   - Added Type Alias CreatedByType
info	[Changelog]   - Interface OperationResourceMetricSpecification has a new optional parameter supportedAggregationTypes
info	[Changelog]   - Interface Resource has a new optional parameter systemData
info	[Changelog]   - Interface ServerEndpointCloudTieringStatus has a new optional parameter lowDiskMode
info	[Changelog]   - Interface StorageSyncApiError has a new optional parameter innererror
info	[Changelog]   - Added Enum KnownCloudTieringLowDiskModeState
info	[Changelog]   - Added Enum KnownCreatedByType
info	[Changelog]
info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface StorageSyncApiError no longer has parameter innerError
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from a83be959b195685c5a51f3b07405c17fdff34ac6. 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] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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
    • ️✔️storagesync [View full logs]  [Preview Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from a83be959b195685c5a51f3b07405c17fdff34ac6. 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.StorageSync [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 16, 2022 •
    edited
    Loading

    Generated ApiView

    Language Package Name ApiView Link
    Python track2_azure-mgmt-storagesync 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-storagesync 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-storagesync Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @ghost ghost added the StorageSync label Aug 16, 2022
    This was referenced Aug 16, 2022
    Closed
    Draft
    Closed
    This was referenced Aug 16, 2022
    Closed
    Closed
    Closed
    @anpint anpint mentioned this pull request Aug 16, 2022
    Merged
    25 tasks
    @ghost
    Copy link

    ghost commented Sep 4, 2022

    Hi, @anpint. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @anpint anpint closed this Sep 7, 2022
    @anpint anpint deleted the anpint-storagesync20220601-fixReadme branch September 7, 2022 18:34
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ankushbindlish2 ankushbindlish2 Awaiting requested review from ankushbindlish2

    Assignees
    No one assigned
    Labels
    CI-BreakingChange-JavaScript resource-manager StorageSync
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    1 participant
    @anpint