Updating the descriptions for various parameters, paths and definitions #8831

asarkar84 · 2020-03-25T05:06:52Z

Latest improvements:

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

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

Updated the field description

azure-pipelines · 2020-03-25T05:07:07Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-03-25T05:08:30Z

azure-cli-extensions - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

openapi-sdkautomation · 2020-03-25T05:08:32Z

azure-sdk-for-go - Release

⚠️ warning [Logs] [Expand Details]

⚠️ Generate from b5f29b3 with merge commit d8c4e5f. SDK Automation 13.0.17.20200326.3
⚠️preview/billing/mgmt/2017-02-27-preview [Logs]
```
No file is changed.
```
⚠️preview/billing/mgmt/2017-04-24-preview [Logs]
```
No file is changed.
```
⚠️preview/billing/mgmt/2018-03-01-preview [Logs]
```
No file is changed.
```
⚠️preview/billing/mgmt/2018-11-01-preview [Logs]
```
No file is changed.
```

openapi-sdkautomation · 2020-03-25T05:08:35Z

azure-sdk-for-java - Release

⚠️ warning [Logs] [Expand Details]

⚠️ Generate from b5f29b3 with merge commit d8c4e5f. SDK Automation 13.0.17.20200326.3
️✔️sdk/billing/mgmt-v2017_02_27_preview [Logs] [Release SDK Changes]
️✔️sdk/billing/mgmt-v2017_04_24_preview [Logs] [Release SDK Changes]
️✔️sdk/billing/mgmt-v2018_03_01_preview [Logs] [Release SDK Changes]

⚠️sdk/billing/mgmt-v2018_11_01_preview [Logs] [Release SDK Changes]

[mvn] [ERROR] COMPILATION ERROR : 
[mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/billing/mgmt-v2018_11_01_preview/src/main/java/com/microsoft/azure/management/billing/v2018_11_01_preview/implementation/PriceSheetsInner.java:[130,39] method getPostOrDeleteResultWithHeadersAsync in class com.microsoft.azure.AzureClient cannot be applied to given types;
[mvn]   required: rx.Observable>,java.lang.reflect.Type,java.lang.Class
[mvn]   found: rx.Observable>,com.microsoft.azure.LongRunningOperationOptions,java.lang.reflect.Type,java.lang.Class
[mvn]   reason: cannot infer type-variable(s) T,THeader
[mvn]     (actual and formal argument lists differ in length)
[mvn] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.1:compile (default-compile) on project azure-mgmt-billing: Compilation failure
[mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/billing/mgmt-v2018_11_01_preview/src/main/java/com/microsoft/azure/management/billing/v2018_11_01_preview/implementation/PriceSheetsInner.java:[130,39] method getPostOrDeleteResultWithHeadersAsync in class com.microsoft.azure.AzureClient cannot be applied to given types;
[mvn] [ERROR]   required: rx.Observable>,java.lang.reflect.Type,java.lang.Class
[mvn] [ERROR]   found: rx.Observable>,com.microsoft.azure.LongRunningOperationOptions,java.lang.reflect.Type,java.lang.Class
[mvn] [ERROR]   reason: cannot infer type-variable(s) T,THeader
[mvn] [ERROR]     (actual and formal argument lists differ in length)
[mvn] [ERROR] -> [Help 1]
[mvn] [ERROR] 
[mvn] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[mvn] [ERROR] Re-run Maven using the -X switch to enable full debug logging.
[mvn] [ERROR] 
[mvn] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[mvn] [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

⚠️sdk/billing/mgmt-v2019_10_01_preview [Logs] [Release SDK Changes]

[mvn] [ERROR] COMPILATION ERROR : 
[mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/billing/mgmt-v2019_10_01_preview/src/main/java/com/microsoft/azure/management/billing/v2019_10_01_preview/implementation/PriceSheetsInner.java:[146,39] method getPostOrDeleteResultWithHeadersAsync in class com.microsoft.azure.AzureClient cannot be applied to given types;
[mvn]   required: rx.Observable>,java.lang.reflect.Type,java.lang.Class
[mvn]   found: rx.Observable>,com.microsoft.azure.LongRunningOperationOptions,java.lang.reflect.Type,java.lang.Class
[mvn]   reason: cannot infer type-variable(s) T,THeader
[mvn]     (actual and formal argument lists differ in length)
[mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/billing/mgmt-v2019_10_01_preview/src/main/java/com/microsoft/azure/management/billing/v2019_10_01_preview/implementation/PriceSheetsInner.java:[303,39] method getPostOrDeleteResultWithHeadersAsync in class com.microsoft.azure.AzureClient cannot be applied to given types;
[mvn]   required: rx.Observable>,java.lang.reflect.Type,java.lang.Class
[mvn]   found: rx.Observable>,com.microsoft.azure.LongRunningOperationOptions,java.lang.reflect.Type,java.lang.Class
[mvn]   reason: cannot infer type-variable(s) T,THeader
[mvn]     (actual and formal argument lists differ in length)
[mvn] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.1:compile (default-compile) on project azure-mgmt-billing: Compilation failure: Compilation failure: 
[mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/billing/mgmt-v2019_10_01_preview/src/main/java/com/microsoft/azure/management/billing/v2019_10_01_preview/implementation/PriceSheetsInner.java:[146,39] method getPostOrDeleteResultWithHeadersAsync in class com.microsoft.azure.AzureClient cannot be applied to given types;
[mvn] [ERROR]   required: rx.Observable>,java.lang.reflect.Type,java.lang.Class
[mvn] [ERROR]   found: rx.Observable>,com.microsoft.azure.LongRunningOperationOptions,java.lang.reflect.Type,java.lang.Class
[mvn] [ERROR]   reason: cannot infer type-variable(s) T,THeader
[mvn] [ERROR]     (actual and formal argument lists differ in length)
[mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/billing/mgmt-v2019_10_01_preview/src/main/java/com/microsoft/azure/management/billing/v2019_10_01_preview/implementation/PriceSheetsInner.java:[303,39] method getPostOrDeleteResultWithHeadersAsync in class com.microsoft.azure.AzureClient cannot be applied to given types;
[mvn] [ERROR]   required: rx.Observable>,java.lang.reflect.Type,java.lang.Class
[mvn] [ERROR]   found: rx.Observable>,com.microsoft.azure.LongRunningOperationOptions,java.lang.reflect.Type,java.lang.Class
[mvn] [ERROR]   reason: cannot infer type-variable(s) T,THeader
[mvn] [ERROR]     (actual and formal argument lists differ in length)
[mvn] [ERROR] -> [Help 1]
[mvn] [ERROR] 
[mvn] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[mvn] [ERROR] Re-run Maven using the -X switch to enable full debug logging.
[mvn] [ERROR] 
[mvn] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[mvn] [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

openapi-sdkautomation · 2020-03-25T05:08:46Z

azure-sdk-for-js - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from b5f29b3 with merge commit d8c4e5f. SDK Automation 13.0.17.20200326.3

️✔️@azure/arm-billing [Logs] [Release SDK Changes]

azure-arm-billing-2.2.0.tgz

[npmPack] npm WARN lifecycle @azure/[email protected]~prepack: cannot run in wd @azure/[email protected] npm install && npm run build (wd=/z/work/azure-sdk-for-js/sdk/billing/arm-billing)

openapi-sdkautomation · 2020-03-25T05:08:48Z

azure-sdk-for-net - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from b5f29b3 with merge commit d8c4e5f. SDK Automation 13.0.17.20200326.3
️✔️Microsoft.Azure.Management.Billing [Logs] [Release SDK Changes]
- Microsoft.Azure.Management.Billing.3.0.0-preview.nupkg
- Microsoft.Azure.Management.Billing.3.0.0-preview.snupkg

openapi-sdkautomation · 2020-03-25T05:08:53Z

azure-sdk-for-python - Release

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from b5f29b3 with merge commit d8c4e5f. SDK Automation 13.0.17.20200326.3

️✔️azure-mgmt-billing [Logs] [Release SDK Changes]

[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
[breaking_change_setup] Cannot uninstall requirement azure-nspkg, not installed
[breaking_change_setup] Command '['/usr/local/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
[ChangeLog] Traceback (most recent call last):
[ChangeLog]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
[ChangeLog]     "__main__", mod_spec)
[ChangeLog]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
[ChangeLog]     exec(code, run_globals)
[ChangeLog]   File "/z/work/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 200, in 
[ChangeLog]     change_log = build_change_log(old_report, new_report)
[ChangeLog]   File "/z/work/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 147, in build_change_log
[ChangeLog]     change_log.operation(diff_line)
[ChangeLog]   File "/z/work/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 38, in operation
[ChangeLog]     _, operation_name, *remaining_path = path
[ChangeLog] ValueError: not enough values to unpack (expected at least 2, got 1)
[ChangeLog] Size of delta 99.369% size of original (original: 86402 chars, delta: 85857 chars)

azuresdkci · 2020-03-25T05:09:06Z

Can one of the admins verify this patch?

njuCZ · 2020-03-25T06:46:45Z

@asarkar84 please fix the CI error.

Unknown word : agreeement, eligiblity, desscription, maketplace
Description must not match the name of the node it is supposed to describe. Node name:'city' Description:'City.'
at specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json:5938
R3011 - DescriptionMustNotBeNodeName
Description must not match the name of the node it is supposed to describe. Node name:'region'
Description:'Region.'
at specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-
preview/billing.json:5942

azure-pipelines · 2020-03-26T02:02:37Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-03-26T02:10:56Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-03-26T02:16:09Z

Azure Pipelines successfully started running 1 pipeline(s).

asarkar84 · 2020-03-26T02:25:13Z

@asarkar84 please fix the CI error.

Unknown word : agreeement, eligiblity, desscription, maketplace

Description must not match the name of the node it is supposed to describe. Node name:'city' Description:'City.'
at specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json:5938
R3011 - DescriptionMustNotBeNodeName
Description must not match the name of the node it is supposed to describe. Node name:'region'
Description:'Region.'
at specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-
preview/billing.json:5942

@njuCZ I have fixed the errors. Please take a look now.

azure-pipelines · 2020-03-26T20:09:06Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-03-26T23:28:42Z

Azure Pipelines successfully started running 1 pipeline(s).

asarkar84 · 2020-03-30T17:43:24Z

@njuCZ Please review this PR and merge if it this looks good to you.

…ns (Azure#8831) * Updated descriptions * Updated the field description Updated the field description * Updated descriptons * Fixed errors * Fixed the build errors * Updated description for instructions apis * Updated description for instructions api path

asarkar84 added 2 commits March 24, 2020 14:38

Updated descriptions

d1172b3

Updated the field description

df473c0

Updated the field description

asarkar84 requested a review from wilcobmsft as a code owner March 25, 2020 05:06

openapi-assignment-bot bot assigned njuCZ Mar 25, 2020

Updated descriptons

77bc655

Fixed errors

e6665bb

Fixed the build errors

742445a

Updated description for instructions apis

79b55dc

Updated description for instructions api path

b5f29b3

njuCZ approved these changes Mar 31, 2020

View reviewed changes

njuCZ merged commit d8c4e5f into Azure:master Mar 31, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating the descriptions for various parameters, paths and definitions #8831

Updating the descriptions for various parameters, paths and definitions #8831

asarkar84 commented Mar 25, 2020 •

edited

Loading

azure-pipelines bot commented Mar 25, 2020

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

azuresdkci commented Mar 25, 2020

njuCZ commented Mar 25, 2020 •

edited

Loading

azure-pipelines bot commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

asarkar84 commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

asarkar84 commented Mar 30, 2020

Updating the descriptions for various parameters, paths and definitions #8831

Updating the descriptions for various parameters, paths and definitions #8831

Conversation

asarkar84 commented Mar 25, 2020 • edited Loading

Latest improvements:

Contribution checklist:

ARM API Review Checklist

azure-pipelines bot commented Mar 25, 2020

openapi-sdkautomation bot commented Mar 25, 2020 • edited Loading

azure-cli-extensions - Release

openapi-sdkautomation bot commented Mar 25, 2020 • edited Loading

azure-sdk-for-go - Release

openapi-sdkautomation bot commented Mar 25, 2020 • edited Loading

azure-sdk-for-java - Release

openapi-sdkautomation bot commented Mar 25, 2020 • edited Loading

azure-sdk-for-js - Release

openapi-sdkautomation bot commented Mar 25, 2020 • edited Loading

azure-sdk-for-net - Release

openapi-sdkautomation bot commented Mar 25, 2020 • edited Loading

azure-sdk-for-python - Release

azuresdkci commented Mar 25, 2020

njuCZ commented Mar 25, 2020 • edited Loading

azure-pipelines bot commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

asarkar84 commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

azure-pipelines bot commented Mar 26, 2020

asarkar84 commented Mar 30, 2020

asarkar84 commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

openapi-sdkautomation bot commented Mar 25, 2020 •

edited

Loading

njuCZ commented Mar 25, 2020 •

edited

Loading