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

Update readme.typescript.md #3117

Open
wants to merge 785 commits into
base: main
Choose a base branch
from
Open

Update readme.typescript.md #3117

wants to merge 785 commits into from

Conversation

dw511214992
Copy link

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?
    • 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 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 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:

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.

ArcturusZhang and others added 30 commits March 10, 2022 15:02
* Update readme.md

* Update readme.md
* Update readme.md

* Update iotspaces.json
@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented May 11, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented May 11, 2022

Swagger Generation Artifacts

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

Breaking Changes Tracking

️✔️azure-sdk-for-python-dataplane - azure-iot-deviceupdate - first release
️⚠️ azure-sdk-for-js-dataplane warning [Detail]
  • ⚠️Warning [Logs] Generate from 9398017. 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]  deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
    cmderr	[automation_init.sh]  [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]  deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
    cmderr	[automation_init.sh]  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-rest/iot-device-update [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-sdk-for-python-dataplane warning [Detail]
  • ⚠️Warning [Logs] Generate from 9398017. 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
  • ️✔️azure-iot-deviceupdate [View full logs]  [Preview SDK Changes]
    info	[Changelog] data-plan skip changelog generation temporarily
️⚠️ azure-sdk-for-java-dataplane warning [Detail]
  • ⚠️Warning [Logs] Generate from 9398017. 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: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
    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-iot-deviceupdate [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-net-dataplane warning [Detail]
  • ⚠️Warning [Logs] Generate from 9398017. 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/Invoke-GeneratAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    warn	No file changes detected after generation
  • ️✔️deviceupdate [View full logs
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented May 11, 2022

@azure-sdk
Copy link
Collaborator

API change check for azure-iot-deviceupdate

API changes have been detected in azure-iot-deviceupdate. You can review API changes here

@azure-sdk
Copy link
Collaborator

API change check for Azure.IoT.DeviceUpdate

API changes have been detected in Azure.IoT.DeviceUpdate. You can review API changes here

@azure-sdk
Copy link
Collaborator

API change check for @azure-rest/iot-device-update

API changes have been detected in @azure-rest/iot-device-update. You can review API changes here

API changes

+ export default function createClient(endpoint: string, credentials: TokenCredential, options?: ClientOptions): DeviceUpdateClient;
-     startDateTime: string;
+     startDateTime: Date | string;
- export default function DeviceUpdate(endpoint: string, credentials: TokenCredential, options?: ClientOptions): DeviceUpdateRestClient;
+ export declare type DeviceUpdateClient = Client & {
+     path: Routes;
+ };
- export declare type DeviceUpdateRestClient = Client & {
-     path: Routes;
- };

@azure-sdk
Copy link
Collaborator

API change check for com.azure:azure-iot-deviceupdate

API changes have been detected in com.azure:azure-iot-deviceupdate. You can review API changes here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.