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

Fixing spellcheck and updating readme files #17071

Merged

Conversation

krishnasriSomepalli
Copy link
Contributor

@krishnasriSomepalli krishnasriSomepalli commented Dec 14, 2021

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?
  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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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, @krishnasriSomepalli 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 14, 2021

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

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 14, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go-track2 - armconfluent - 0.1.1
    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-confluent - 2.0.0b1
    ️✔️azure-sdk-for-go - confluent/mgmt/2021-12-01/confluent - Approved - v60.1.0
    ️✔️azure-sdk-for-go - confluent/mgmt/2020-03-01/confluent - Approved - v60.1.0
    ️✔️azure-sdk-for-go - preview/confluent/mgmt/2021-09-01-preview/confluent - Approved - v60.1.0
    ️✔️azure-sdk-for-go - preview/confluent/mgmt/2021-03-01-preview/confluent - Approved - v60.1.0
    ⚠️azure-sdk-for-go - preview/confluent/mgmt/2020-03-01-preview/confluent - Approved - v60.1.0
    +	Field `Properties` of struct `AgreementResource` has been removed
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-5.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/confluent/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
    • Microsoft.Azure.Management.Confluent [View full logs]  [Preview SDK Changes]
      cmderr	[msbuild] Could not execute because the application was not found or a compatible .NET SDK is not installed.
      cmderr	[msbuild] Possible reasons for this include:
      cmderr	[msbuild]   * You intended to execute a .NET program:
      cmderr	[msbuild]       The application 'msbuild' does not exist.
      cmderr	[msbuild]   * You intended to execute a .NET SDK command:
      cmderr	[msbuild]       A compatible installed .NET SDK for global.json version [6.0.100] from [/home/vsts/work/1/s/azure-sdk-for-net/global.json] was not found.
      cmderr	[msbuild]       Install the [6.0.100] .NET SDK or update [/home/vsts/work/1/s/azure-sdk-for-net/global.json] with an installed .NET SDK:
      error	Script return with result [failed] code [145] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. 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.3.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.3.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.3.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-confluent [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. 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] 2021-12-14 05:03:59 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-confluent;1.0.0-beta.3;1.0.0-beta.4"
      cmderr	[generate.py] 2021-12-14 05:03:59 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.4"
      cmderr	[generate.py] 2021-12-14 05:03:59 INFO autorest --version=3.6.6 --use=@autorest/java@4.0.42 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/confluent/azure-resourcemanager-confluent --java.namespace=com.azure.resourcemanager.confluent   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --generate-samples --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/confluent/resource-manager/readme.md
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-confluent
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [POM][Skip] pom already has module azure-resourcemanager-confluent
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [POM][Skip] pom already has module sdk/confluent
      cmderr	[generate.py] 2021-12-14 05:04:30 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-confluent [View full logs]  [Preview SDK Changes]
      cmderr	[Inst] 2021-12-14 05:06:17 DEBUG Got artifact_id: azure-resourcemanager-confluent
      cmderr	[Inst] 2021-12-14 05:06:17 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-12-14 05:06:17 DEBUG Got artifact: azure-resourcemanager-confluent-1.0.0-beta.4-javadoc.jar
      cmderr	[Inst] 2021-12-14 05:06:17 DEBUG Got artifact: azure-resourcemanager-confluent-1.0.0-beta.4.jar
      cmderr	[Inst] 2021-12-14 05:06:17 DEBUG Match jar package: azure-resourcemanager-confluent-1.0.0-beta.4.jar
      cmderr	[Inst] 2021-12-14 05:06:17 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/17071/azure-sdk-for-java/azure-resourcemanager-confluent/azure-resourcemanager-confluent-1.0.0-beta.4.jar\" -o azure-resourcemanager-confluent-1.0.0-beta.4.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-confluent -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-confluent-1.0.0-beta.4.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. 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
    • ️✔️confluent/mgmt/2021-12-01/confluent [View full logs]  [Preview SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️confluent/mgmt/2020-03-01/confluent [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `OperationListResult.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `OfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `OrganizationResourcePropertiesOfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 3 additive change(s).
      info	[Changelog]
    • ️✔️preview/confluent/mgmt/2021-09-01-preview/confluent [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `OfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/confluent/mgmt/2021-03-01-preview/confluent [View full logs
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `OfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/confluent/mgmt/2020-03-01-preview/confluent [View full logsBreaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `Properties` of struct `AgreementResource` has been removed
      info	[Changelog]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*AgreementResource.UnmarshalJSON([]byte) error`
      info	[Changelog] - New function `OrganizationResourcePropertiesOfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `OfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New anonymous field `*AgreementProperties` in struct `AgreementResource`
      info	[Changelog] - New field `IsDataAction` in struct `OperationResult`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 5 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. 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
    • ️✔️armconfluent [View full logs]  [Preview SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. 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]  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] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh]  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-confluent [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from b6dd78f9433009d5a36202d3969fb023df5f1868. 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
      cmderr	[generateScript.sh] (node:2489) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2020-03-01-preview/Microsoft.Confluent.json'
      cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
      cmderr	[generateScript.sh] (node:2489) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
      cmderr	[generateScript.sh] (node:2489) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
    • ️✔️confluent [View full logs]  [Preview Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @chunyu3 chunyu3 merged commit f2b41af into dev-confluent-Microsoft.Confluent-2021-12-01 Dec 16, 2021
    changlong-liu pushed a commit that referenced this pull request Mar 28, 2022
    … stable/2021-12-01 (#17070)
    
    * Adds base for updating Microsoft.Confluent from version preview/2021-09-01-preview to version 2021-12-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fixing spellcheck and updating readme files (#17071)
    
    * Update confluent.json (#18254)
    
    Fixing linting errors
    
    * Update confluent.json for LintDiff fixes (#18261)
    visingl pushed a commit that referenced this pull request Mar 30, 2022
    … stable/2021-12-01 (#17070)
    
    * Adds base for updating Microsoft.Confluent from version preview/2021-09-01-preview to version 2021-12-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fixing spellcheck and updating readme files (#17071)
    
    * Update confluent.json (#18254)
    
    Fixing linting errors
    
    * Update confluent.json for LintDiff fixes (#18261)
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    … stable/2021-12-01 (Azure#17070)
    
    * Adds base for updating Microsoft.Confluent from version preview/2021-09-01-preview to version 2021-12-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Fixing spellcheck and updating readme files (Azure#17071)
    
    * Update confluent.json (Azure#18254)
    
    Fixing linting errors
    
    * Update confluent.json for LintDiff fixes (Azure#18261)
    @JackTn JackTn deleted the confluent-2021-12-01 branch June 16, 2022 00:48
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants