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

updated readme with new preview version #14527

Merged
merged 1 commit into from
May 24, 2021
Merged

updated readme with new preview version #14527

merged 1 commit into from
May 24, 2021

Conversation

alluri02
Copy link
Contributor

@alluri02 alluri02 commented May 24, 2021

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

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • 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
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change 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 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, @alluri02 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.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 24, 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.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] 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 May 24, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    azure-sdk-for-python-track2 - track2_azure-mgmt-confluent - 1.0.0
    +	Parameter email_address of model UserDetail is now required
    +	Parameter id of model OfferDetail is now required
    +	Parameter offer_detail of model OrganizationResource is now required
    +	Parameter plan_id of model OfferDetail is now required
    +	Parameter plan_name of model OfferDetail is now required
    +	Parameter publisher_id of model OfferDetail is now required
    +	Parameter term_unit of model OfferDetail is now required
    +	Parameter user_detail of model OrganizationResource is now required
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from 58af5ba. 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]  [Release SDK Changes]
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Tests/ConfluentTest.cs(57,38): error CS0246: The type or namespace name 'OrganizationResourcePropertiesOfferDetail' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Microsoft.Azure.Management.Confluent.Tests.csproj]
      cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Tests/ConfluentTest.cs(58,37): error CS0246: The type or namespace name 'OrganizationResourcePropertiesUserDetail' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Microsoft.Azure.Management.Confluent.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Tests/ConfluentTest.cs(57,38): error CS0246: The type or namespace name 'OrganizationResourcePropertiesOfferDetail' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Microsoft.Azure.Management.Confluent.Tests.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Tests/ConfluentTest.cs(58,37): error CS0246: The type or namespace name 'OrganizationResourcePropertiesUserDetail' could not be found (are you missing a using directive or an assembly reference?) [/home/vsts/work/1/s/azure-sdk-for-net/sdk/confluent/Microsoft.Azure.Management.Confluent/tests/Microsoft.Azure.Management.Confluent.Tests.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 58af5ba. 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
    • ️✔️track2_azure-mgmt-confluent [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model OrganizationResource has a new parameter system_data
      info	[Changelog]   - Model ConfluentAgreementResource has a new parameter system_data
      info	[Changelog]   - Added operation group ValidationsOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Parameter user_detail of model OrganizationResource is now required
      info	[Changelog]   - Parameter offer_detail of model OrganizationResource is now required
      info	[Changelog]   - Parameter email_address of model UserDetail is now required
      info	[Changelog]   - Parameter term_unit of model OfferDetail is now required
      info	[Changelog]   - Parameter publisher_id of model OfferDetail is now required
      info	[Changelog]   - Parameter plan_name of model OfferDetail is now required
      info	[Changelog]   - Parameter id of model OfferDetail is now required
      info	[Changelog]   - Parameter plan_id of model OfferDetail is now required
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 58af5ba. 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-05-24 06:11:26 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-confluent;1.0.0-beta.2;1.0.0-beta.3"
      cmderr	[generate.py] 2021-05-24 06:11:26 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.3"
      cmderr	[generate.py] 2021-05-24 06:11:26 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.28 --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 --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-05-24 06:11:56 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-confluent
      cmderr	[generate.py] 2021-05-24 06:11:56 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-05-24 06:11:56 INFO [POM][Skip] pom already has module azure-resourcemanager-confluent
      cmderr	[generate.py] 2021-05-24 06:11:56 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-05-24 06:11:56 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-05-24 06:11:56 INFO [POM][Skip] pom already has module sdk/confluent
      cmderr	[generate.py] 2021-05-24 06:11:56 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-confluent [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG Got artifact_id: azure-resourcemanager-confluent
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG Got artifact: azure-resourcemanager-confluent-1.0.0-beta.3-sources.jar
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG Got artifact: azure-resourcemanager-confluent-1.0.0-beta.3-javadoc.jar
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG Got artifact: azure-resourcemanager-confluent-1.0.0-beta.3.jar
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG Match jar package: azure-resourcemanager-confluent-1.0.0-beta.3.jar
      cmderr	[Inst] 2021-05-24 06:15:04 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14527/azure-sdk-for-java/azure-resourcemanager-confluent/azure-resourcemanager-confluent-1.0.0-beta.3.jar\" -o azure-resourcemanager-confluent-1.0.0-beta.3.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.3.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 58af5ba. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️confluent/mgmt/2020-03-01/confluent [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `OfferDetail.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `OperationListResult.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-03-01-preview/confluent [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Const `CreatedByTypeKey` has been removed
      info	[Changelog] - Const `ProvisionStateAccepted` has been removed
      info	[Changelog] - Const `ProvisionStateDeleting` has been removed
      info	[Changelog] - Const `CreatedByTypeManagedIdentity` has been removed
      info	[Changelog] - Const `CreatedByTypeUser` has been removed
      info	[Changelog] - Const `ProvisionStateCanceled` has been removed
      info	[Changelog] - Const `ProvisionStateFailed` has been removed
      info	[Changelog] - Const `ProvisionStateUpdating` has been removed
      info	[Changelog] - Const `CreatedByTypeApplication` has been removed
      info	[Changelog] - Const `ProvisionStateNotSpecified` has been removed
      info	[Changelog] - Const `ProvisionStateCreating` has been removed
      info	[Changelog] - Const `ProvisionStateSucceeded` has been removed
      info	[Changelog] - Const `ProvisionStateDeleted` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `NotSpecified`
      info	[Changelog] - New const `Succeeded`
      info	[Changelog] - New const `Canceled`
      info	[Changelog] - New const `Accepted`
      info	[Changelog] - New const `Failed`
      info	[Changelog] - New const `Creating`
      info	[Changelog] - New const `Deleted`
      info	[Changelog] - New const `Deleting`
      info	[Changelog] - New const `ManagedIdentity`
      info	[Changelog] - New const `Key`
      info	[Changelog] - New const `Application`
      info	[Changelog] - New const `User`
      info	[Changelog] - New const `Updating`
      info	[Changelog]
      info	[Changelog] Total 13 breaking change(s), 13 additive change(s).
      info	[Changelog]
    • ️✔️preview/confluent/mgmt/2020-03-01-preview/confluent [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Field `Properties` of struct `AgreementResource` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New function `*AgreementResource.UnmarshalJSON([]byte) error`
      info	[Changelog] - New field `IsDataAction` in struct `OperationResult`
      info	[Changelog] - New anonymous field `*AgreementProperties` in struct `AgreementResource`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 3 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 58af5ba. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/confluent/resource-manager/readme.md
    • ️✔️@azure/arm-confluent [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/confluentManagementClient.js → ./dist/arm-confluent.js...
      cmderr	[npmPack] created ./dist/arm-confluent.js in 196ms
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 58af5ba. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/confluent/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /MarketplaceAgreements/get/MarketplaceAgreements_List
      cmderr	[Autorest]     - name: /Organization/put/Organization_Create
      cmderr	[Autorest]     - name: /Organization/get/Organization_Get
      cmderr	[Autorest]     - name: /Organization/get/Organization_ListByResourceGroup
      cmderr	[Autorest]     - name: /Organization/get/Organization_ListBySubscription
      cmderr	[Autorest]     - name: /Organization/patch/Confluent_Update
      cmderr	[Autorest]     - name: /Validations/post/Validations_ValidateOrganizations
      cmderr	[Autorest]     - name: /Organization/delete/Confluent_Delete
      cmderr	[Autorest] --------------------------------------------------------
    • ️✔️confluent [View full logs]  [Release Azure CLI Changes]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 58af5ba. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      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:2496) 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:2496) 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:2496) [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.
      warn	No file changes detected after generation
    • ️✔️confluent [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @JackTn JackTn deleted the alluri02-patch-1 branch June 16, 2022 00:47
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants