add doc for typescript md #10187

qiaozha · 2020-07-17T06:28:46Z

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

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
- Adding a new service
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 API 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 version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

Please follow the link to find more details on PR review process.

openapi-pipeline-app · 2020-07-17T06:28:51Z

[Staging] Swagger Validation Report

️️✔️BreakingChange [Detail]

 There are no breaking changes.

️️✔️LintDiff [Detail]

 Validation passes for LintDiff.

️️✔️Avocado [Detail]

 Validation passes for Avocado.

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

azure-pipelines · 2020-07-17T06:29:04Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-07-17T06:30:26Z

azure-sdk-for-go - 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-07-17T06:30:31Z

azure-sdk-for-python - 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-07-17T06:30:36Z

azure-sdk-for-js - 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-07-17T06:30:36Z

azure-sdk-for-net - 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-07-17T06:30:38Z

Azure CLI Extension Generation - 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-07-17T06:30:43Z

Trenton Generation - 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-07-17T06:30:44Z

azure-sdk-for-java - 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

qiaozha · 2020-07-17T06:32:10Z

@josefree @akning-ms This PR is try to add document for typescript sdk readme. Can you help review it? Thanks

azuresdkci · 2020-07-17T06:58:41Z

Can one of the admins verify this patch?

akning-ms · 2020-07-20T09:04:21Z

documentation/code-gen/configure-typescript-sdk.md

+title: xxxxConfigurationClient
+description: xxxx Configuration Client
+openapi-type: arm
+tag: package-xxxx-xx-xx


Should we add some name rule for tag to make it consistent? and give some guide for when we will use this tag. actually, linter will also use this tag

I am fine to add some tag name convention for the consistency consideration. But should we discuss what kind of convention is needed in a more general way? For example. what the tag name would be in the scenarios of multi-package, in the scenarios of preview/stable version, in the scenarios of multi-api etc ? Also I noticed that we use YYYY-mm to distinguish different versions previously, what if the service team has two api-versions such as 2020-05-01 and 2020-05-16 in one month?

You can refer to changlong's PR for python

Okay. I will change it

@akning-ms I have updated the tag description like #10123 . Could you please review again? Thanks

azure-pipelines · 2020-07-27T08:27:52Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-07-27T08:29:25Z

azure-sdk-for-python-track2 - 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

nickzhums · 2020-07-28T03:53:31Z

documentation/code-gen/configure-typescript-sdk.md

@@ -0,0 +1,235 @@
+# Readme Configuration Guide for Typescript SDK


I would elaborate this name a bit for clarification

Azure SDK for Javascript (Node.js and browser) = TypeScript SDK

(same for all other places)

We may want to be explicit about this to not confuse people with the deprecated node.js SDK repo

azure-pipelines · 2020-07-28T04:30:07Z

Azure Pipelines successfully started running 1 pipeline(s).

…into fix_kv_python_readme * 'master' of https://github.com/Azure/azure-rest-api-specs: (154 commits) Key Vault 7.1-preview to stable (GA) (Azure#10239) Fix data plane cosmosdb (Azure#10277) Fix example request for expanding policyEvaluationDetails (Azure#10203) Databricks Swagger Changes for Double Encryption (Azure#9941) add column delimiter for SAP Table/open hub (Azure#10269) add doc for typescript md (Azure#10187) Fix sfrp 2020-01-01-preview (Azure#10268) [Datafactory]Add cloudType and snapshot to ADF public swagger (Azure#10235) Migrate TaskRun to ProxyResource. (Azure#9953) [Datashare]Add sorting query parameters (Azure#10209) [Hub Generated] Review request for Microsoft.Insights to add version preview/2018-06-17-preview (Azure#10173) Update dataController onPremise property (Azure#10263) Changed the Client description to include Gen2 (Azure#10178) Managed Clusters Generate SDK (Azure#10247) Dev monitor microsoft.insights 2020 05 01 preview (Azure#10101) Add Location property to ExportPipeline and ImportPipeline (Azure#10177) Add enableAutomaticUpgrade property to VMExtensions for VMs and VMSS (Azure#10134) Add a new api and add 2020-02-02-preview versions (Azure#9710) Adding AML Workspace ID Property (Azure#10073) Add missing nullable attributes (Azure#10245) ...

* add doc for typescript md * add description of tag * change the description

add doc for typescript md

b3aea27

openapi-assignment-bot bot assigned josefree Jul 17, 2020

qiaozha assigned akning-ms Jul 17, 2020

akning-ms reviewed Jul 20, 2020

View reviewed changes

qiaozha requested a review from RodgeFu July 20, 2020 09:06

akning-ms requested a review from nickzhums July 21, 2020 05:50

qiaozha added 2 commits July 27, 2020 16:26

Merge branch 'master' into add-doc-for-typescipt-md

1886259

add description of tag

185da21

akning-ms approved these changes Jul 28, 2020

View reviewed changes

nickzhums reviewed Jul 28, 2020

View reviewed changes

change the description

aa714be

nickzhums approved these changes Jul 28, 2020

View reviewed changes

qiaozha merged commit 36b7276 into master Jul 28, 2020

qiaozha deleted the add-doc-for-typescipt-md branch July 28, 2020 04:53

00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020

add doc for typescript md (Azure#10187)

54d3ae6

* add doc for typescript md * add description of tag * change the description

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add doc for typescript md #10187

add doc for typescript md #10187

qiaozha commented Jul 17, 2020

openapi-pipeline-app bot commented Jul 17, 2020 •

edited

Loading

azure-pipelines bot commented Jul 17, 2020

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

qiaozha commented Jul 17, 2020 •

edited

Loading

azuresdkci commented Jul 17, 2020

akning-ms Jul 20, 2020 •

edited

Loading

qiaozha Jul 20, 2020

akning-ms Jul 24, 2020

akning-ms Jul 24, 2020

qiaozha Jul 24, 2020

qiaozha Jul 27, 2020 •

edited

Loading

azure-pipelines bot commented Jul 27, 2020

openapi-sdkautomation bot commented Jul 27, 2020 •

edited

Loading

nickzhums Jul 28, 2020 •

edited

Loading

azure-pipelines bot commented Jul 28, 2020

		@@ -0,0 +1,235 @@
		# Readme Configuration Guide for Typescript SDK

add doc for typescript md #10187

add doc for typescript md #10187

Conversation

qiaozha commented Jul 17, 2020

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Jul 17, 2020 • edited Loading

[Staging] Swagger Validation Report

azure-pipelines bot commented Jul 17, 2020

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

azure-sdk-for-go - Release

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

azure-sdk-for-python - Release

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

azure-sdk-for-js - Release

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

azure-sdk-for-net - Release

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

Azure CLI Extension Generation - Release

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

Trenton Generation - Release

openapi-sdkautomation bot commented Jul 17, 2020 • edited Loading

azure-sdk-for-java - Release

qiaozha commented Jul 17, 2020 • edited Loading

azuresdkci commented Jul 17, 2020

akning-ms Jul 20, 2020 • edited Loading

Choose a reason for hiding this comment

qiaozha Jul 20, 2020

Choose a reason for hiding this comment

akning-ms Jul 24, 2020

Choose a reason for hiding this comment

akning-ms Jul 24, 2020

Choose a reason for hiding this comment

qiaozha Jul 24, 2020

Choose a reason for hiding this comment

qiaozha Jul 27, 2020 • edited Loading

Choose a reason for hiding this comment

azure-pipelines bot commented Jul 27, 2020

openapi-sdkautomation bot commented Jul 27, 2020 • edited Loading

azure-sdk-for-python-track2 - Release

nickzhums Jul 28, 2020 • edited Loading

Choose a reason for hiding this comment

azure-pipelines bot commented Jul 28, 2020

openapi-pipeline-app bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 17, 2020 •

edited

Loading

qiaozha commented Jul 17, 2020 •

edited

Loading

akning-ms Jul 20, 2020 •

edited

Loading

qiaozha Jul 27, 2020 •

edited

Loading

openapi-sdkautomation bot commented Jul 27, 2020 •

edited

Loading

nickzhums Jul 28, 2020 •

edited

Loading