add readme.java.md and modify readme files #18492

Noelin · 2022-03-31T03:54:11Z

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:

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
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:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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 · 2022-03-31T03:54:13Z

Hi, @Noelin 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-workflow-bot · 2022-03-31T03:54:14Z

[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 · 2022-03-31T03:54:15Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.12.3 , classic-openapi-validator v1.2.4 )
- fluidrelay/resource-manager/readme.md tag:default
Linted configuring files (Based on target branch, openapi-validator v1.12.3 , classic-openapi-validator v1.2.4 )
- fluidrelay/resource-manager/readme.md tag:default

️️✔️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 succeeded [Detail] [Expand]

There is no credential detected.

️️✔️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 · 2022-03-31T03:54:15Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

️✔️azure-sdk-for-go - preview/fluidrelay/mgmt/2021-06-15-preview/fluidrelay - v63.3.0
️✔️azure-sdk-for-go - preview/fluidrelay/mgmt/2021-03-12-preview/fluidrelay - v63.3.0
❌azure-sdk-for-python-track2 - track2_azure-mgmt-fluidrelay - Approved - 1.0.0b1

+	Operation FluidRelayServersOperations.create_or_update has a new parameter fluid_relay_server_name
+	Operation FluidRelayServersOperations.create_or_update no longer has parameter name
+	Operation FluidRelayServersOperations.delete has a new parameter fluid_relay_server_name
+	Operation FluidRelayServersOperations.delete no longer has parameter name
+	Operation FluidRelayServersOperations.get has a new parameter fluid_relay_server_name
+	Operation FluidRelayServersOperations.get no longer has parameter name
+	Operation FluidRelayServersOperations.get_keys has a new parameter fluid_relay_server_name
+	Operation FluidRelayServersOperations.get_keys no longer has parameter name
+	Operation FluidRelayServersOperations.regenerate_key has a new parameter fluid_relay_server_name
+	Operation FluidRelayServersOperations.regenerate_key no longer has parameter name
+	Operation FluidRelayServersOperations.update has a new parameter fluid_relay_server_name
+	Operation FluidRelayServersOperations.update no longer has parameter name

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 9a65970. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.FluidRelay [View full logs] [Release SDK Changes]
- Azure.ResourceManager.FluidRelay.1.0.0-alpha.20220525.1.nupkg
- Azure.ResourceManager.FluidRelay.1.0.0-alpha.20220525.1.symbols.nupkg
```
info	[Changelog]
```

️️✔️ azure-powershell succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 9a65970. 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]
- Az.FluidRelay.0.1.0.nupkg

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 9a65970. 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.5.5 -> 8.10.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.10.0>
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 group FluidRelayContainersOperations
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 9a65970. 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: 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: 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 9a65970. 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 9a65970. 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] npm WARN deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] deprecated [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]  @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh] WARN deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @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]

azure-arm-fluidrelay-1.0.0.tgz

info	[Changelog]
error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

_{Posted by Swagger Pipeline | How to fix these errors?}

Noelin · 2022-03-31T16:52:14Z

@qiaozha,
Do you know how to fix this issue for python and js?

Noelin · 2022-04-01T07:19:06Z

@qiaozha
Is there any update?

qiaozha · 2022-04-02T04:09:24Z

/azp run

azure-pipelines · 2022-04-02T04:09:33Z

Azure Pipelines successfully started running 1 pipeline(s).

qiaozha · 2022-04-06T00:13:26Z

@ruowan Can you take a look at the credscan failure ? Thanks

qiaozha · 2022-04-06T00:17:04Z

@msyyc Can you help take a look at the Python SDK breaking change ? Thanks

qiaozha · 2022-04-07T02:47:13Z

specification/fluidrelay/resource-manager/readme.typescript.md

-  package-name: "fluidrelay"
-  output-folder: "$(typescript-sdks-folder)/packages/fluidrelay"
+  package-name: "@azure/arm-fluidrelay"
+  output-folder: "$(typescript-sdks-folder)/packages/fluidrelay/arm-fluidrelay"


Suggested change

output-folder: "$(typescript-sdks-folder)/packages/fluidrelay/arm-fluidrelay"

output-folder: "$(typescript-sdks-folder)/sdk/fluidrelay/arm-fluidrelay"

@qiaozha
Just make a change.
Could you take a look when you have time?

ghost · 2022-05-15T16:02:40Z

Hi, @Noelin. 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.

Noelin · 2022-05-24T17:21:09Z

@qiaozha
Could you approve the PR?

* add readme.java.md and modify readme files * update typescript sdk output-folder path

add readme.java.md and modify readme files

5acbddd

Noelin requested a review from qiaozha as a code owner March 31, 2022 03:54

openapi-assignment-bot bot assigned qiaozha Mar 31, 2022

openapi-sdkautomation bot mentioned this pull request Mar 31, 2022

[AutoPR azure-resourcemanager-fluidrelay] add readme.java.md and modify readme files AzureSDKAutomation/azure-sdk-for-java#13674

Draft

openapi-sdkautomation bot mentioned this pull request Apr 2, 2022

[AutoPR track2_azure-mgmt-fluidrelay] add readme.java.md and modify readme files AzureSDKAutomation/azure-sdk-for-python#9880

Draft

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Apr 2, 2022

msyyc added the Approved-SdkBreakingChange-Python label Apr 7, 2022

qiaozha reviewed Apr 7, 2022

View reviewed changes

update typescript sdk output-folder path

3f5a9a3

ghost added the no-recent-activity label May 15, 2022

ghost removed the no-recent-activity label May 24, 2022

qiaozha approved these changes May 25, 2022

View reviewed changes

qiaozha merged commit 9a65970 into Azure:main May 25, 2022

azure-sdk mentioned this pull request May 25, 2022

[ReleasePR track2_azure-mgmt-fluidrelay] remove - repo: azure-sdk-for-go-track2 config Azure/azure-sdk-for-python#24277

Closed

gargankit-microsoft pushed a commit that referenced this pull request May 26, 2022

add readme.java.md and modify readme files (#18492)

a6eb0d6

* add readme.java.md and modify readme files * update typescript sdk output-folder path

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add readme.java.md and modify readme files #18492

add readme.java.md and modify readme files #18492

Noelin commented Mar 31, 2022 •

edited

Loading

openapi-workflow-bot bot commented Mar 31, 2022

openapi-workflow-bot bot commented Mar 31, 2022

openapi-pipeline-app bot commented Mar 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Mar 31, 2022 •

edited

Loading

Breaking Changes Tracking

Noelin commented Mar 31, 2022 •

edited

Loading

Noelin commented Apr 1, 2022

qiaozha commented Apr 2, 2022

azure-pipelines bot commented Apr 2, 2022

qiaozha commented Apr 6, 2022

qiaozha commented Apr 6, 2022 •

edited

Loading

qiaozha Apr 7, 2022

Noelin Apr 26, 2022

ghost commented May 15, 2022

Noelin commented May 24, 2022

	output-folder: "$(typescript-sdks-folder)/packages/fluidrelay/arm-fluidrelay"
	output-folder: "$(typescript-sdks-folder)/sdk/fluidrelay/arm-fluidrelay"

add readme.java.md and modify readme files #18492

add readme.java.md and modify readme files #18492

Conversation

Noelin commented Mar 31, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 31, 2022

openapi-workflow-bot bot commented Mar 31, 2022

openapi-pipeline-app bot commented Mar 31, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Mar 31, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

Noelin commented Mar 31, 2022 • edited Loading

Noelin commented Apr 1, 2022

qiaozha commented Apr 2, 2022

azure-pipelines bot commented Apr 2, 2022

qiaozha commented Apr 6, 2022

qiaozha commented Apr 6, 2022 • edited Loading

qiaozha Apr 7, 2022

Choose a reason for hiding this comment

Noelin Apr 26, 2022

Choose a reason for hiding this comment

ghost commented May 15, 2022

Noelin commented May 24, 2022

Noelin commented Mar 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Mar 31, 2022 •

edited

Loading

openapi-pipeline-app bot commented Mar 31, 2022 •

edited

Loading

Noelin commented Mar 31, 2022 •

edited

Loading

qiaozha commented Apr 6, 2022 •

edited

Loading