From 2c3775308883f79017274dd101c480e8b6813593 Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Tue, 15 Mar 2022 08:37:37 +0000 Subject: [PATCH] CodeGen from PR 18226 in Azure/azure-rest-api-specs update readme (#18226) * update readme * Update readme.python.md * Update readme.python.md * Update readme.python.md --- common/config/rush/pnpm-lock.yaml | 16 ++++++------ sdk/orbital/arm-orbital/CHANGELOG.md | 19 ++++++++------ sdk/orbital/arm-orbital/LICENSE | 2 +- sdk/orbital/arm-orbital/_meta.json | 7 +++--- sdk/orbital/arm-orbital/api-extractor.json | 25 ++++++++++++++----- sdk/orbital/arm-orbital/package.json | 6 ++--- .../arm-orbital/review/arm-orbital.api.md | 24 +++++++++--------- sdk/orbital/arm-orbital/src/azureOrbital.ts | 2 +- sdk/orbital/arm-orbital/src/models/index.ts | 10 ++++---- .../src/operations/availableGroundStations.ts | 12 ++++----- .../availableGroundStations.ts | 4 +-- sdk/orbital/arm-orbital/tsconfig.json | 16 +++++++++--- sdk/orbital/ci.mgmt.yml | 7 +++--- 13 files changed, 88 insertions(+), 62 deletions(-) diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index b39ba0ca29b6..aab6a6272559 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -12024,23 +12024,23 @@ packages: dev: false file:projects/arm-orbital.tgz: - resolution: {integrity: sha512-5ajxeCALue/563hheg9FetoTWxlwqvZMqBJ/q48iUXiCs5BeIwCp/+kq0rP3eYA6TZ/LoevVabq7SBhp2rihcw==, tarball: file:projects/arm-orbital.tgz} + resolution: {integrity: sha512-oF8HsFjTgUDCr7VV1jQS8bKs74EIQZ6kGAolCp+of25z4Iy9dFv49+LM7SAWMQEDQuvET6ljnEfGbeRvRbhjtw==, tarball: file:projects/arm-orbital.tgz} name: '@rush-temp/arm-orbital' version: 0.0.0 dependencies: '@azure-tools/test-recorder': 1.0.2 '@azure/identity': 2.0.4 '@microsoft/api-extractor': 7.19.4 - '@rollup/plugin-commonjs': 21.0.1_rollup@2.67.1 - '@rollup/plugin-json': 4.1.0_rollup@2.67.1 - '@rollup/plugin-multi-entry': 3.0.1_rollup@2.67.1 - '@rollup/plugin-node-resolve': 8.4.0_rollup@2.67.1 + '@rollup/plugin-commonjs': 11.0.2_rollup@1.32.1 + '@rollup/plugin-json': 4.1.0_rollup@1.32.1 + '@rollup/plugin-multi-entry': 3.0.1_rollup@1.32.1 + '@rollup/plugin-node-resolve': 8.4.0_rollup@1.32.1 cross-env: 7.0.3 mkdirp: 1.0.4 mocha: 7.2.0 rimraf: 3.0.2 - rollup: 2.67.1 - rollup-plugin-sourcemaps: 0.4.2_rollup@2.67.1 + rollup: 1.32.1 + rollup-plugin-sourcemaps: 0.4.2_rollup@1.32.1 tslib: 2.3.1 typescript: 4.2.4 uglify-js: 3.15.1 @@ -12457,7 +12457,7 @@ packages: dev: false file:projects/arm-rediscache.tgz: - resolution: {integrity: sha512-lRPMNQ6X2zNGHkn4+nUXsiXRde6JISO5YjFzhycdJL/3NCg9F4m94x+VbYyNtbvW5a7oVbGmyu4lW+I8qlqszQ==, tarball: file:projects/arm-rediscache.tgz} + resolution: {integrity: sha512-L96UyCle2mXUwU1QCXkofA0Yl4jBo8ElH3wdfGQBGHvDnDGkb1wNzcyuMsNncmPePr3fWsM50xCYuaMASfy0Ag==, tarball: file:projects/arm-rediscache.tgz} name: '@rush-temp/arm-rediscache' version: 0.0.0 dependencies: diff --git a/sdk/orbital/arm-orbital/CHANGELOG.md b/sdk/orbital/arm-orbital/CHANGELOG.md index 2ccdf9e73b64..69100de59a62 100644 --- a/sdk/orbital/arm-orbital/CHANGELOG.md +++ b/sdk/orbital/arm-orbital/CHANGELOG.md @@ -1,15 +1,18 @@ # Release History + +## 1.0.0-beta.3 (2022-03-15) + +**Features** -## 1.0.0-beta.3 (Unreleased) - -### Features Added - -### Breaking Changes - -### Bugs Fixed + - Added Type Alias CapabilityType + - Added Enum KnownCapabilityType -### Other Changes +**Breaking Changes** + - Operation AvailableGroundStations.listByCapability has a new signature + - Removed Enum KnownEnum6 + + ## 1.0.0-beta.2 (2021-12-27) The package of @azure/arm-orbital is using our next generation design principles since version 1.0.0-beta.2, which contains breaking changes. diff --git a/sdk/orbital/arm-orbital/LICENSE b/sdk/orbital/arm-orbital/LICENSE index ccb63b166732..5d1d36e0af80 100644 --- a/sdk/orbital/arm-orbital/LICENSE +++ b/sdk/orbital/arm-orbital/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2021 Microsoft +Copyright (c) 2022 Microsoft Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/sdk/orbital/arm-orbital/_meta.json b/sdk/orbital/arm-orbital/_meta.json index 21527487968d..c13b26f28c38 100644 --- a/sdk/orbital/arm-orbital/_meta.json +++ b/sdk/orbital/arm-orbital/_meta.json @@ -1,7 +1,8 @@ { - "commit": "c77c6c634dc3644d65d3e35df5d73a9c34d3c956", + "commit": "0b841bdf4d0e965db93c2045eddc4966b18bcfda", "readme": "specification/orbital/resource-manager/readme.md", - "autorest_command": "autorest --version=3.1.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\mydev\\azure-sdk-for-js ../azure-rest-api-specs/specification/orbital/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20211217.1", + "autorest_command": "autorest --version=3.7.3 --typescript --modelerfour.lenient-model-deduplication --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/orbital/resource-manager/readme.md --use=@autorest/typescript@6.0.0-alpha.16.20220105.1", "repository_url": "https://github.com/Azure/azure-rest-api-specs.git", - "use": "@autorest/typescript@6.0.0-alpha.16.20211217.1" + "release_tool": "@azure-tools/js-sdk-release-tools@2.1.2", + "use": "@autorest/typescript@6.0.0-alpha.16.20220105.1" } \ No newline at end of file diff --git a/sdk/orbital/arm-orbital/api-extractor.json b/sdk/orbital/arm-orbital/api-extractor.json index e7c7265ecef6..645634361e11 100644 --- a/sdk/orbital/arm-orbital/api-extractor.json +++ b/sdk/orbital/arm-orbital/api-extractor.json @@ -1,18 +1,31 @@ { "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", "mainEntryPointFilePath": "./dist-esm/src/index.d.ts", - "docModel": { "enabled": true }, - "apiReport": { "enabled": true, "reportFolder": "./review" }, + "docModel": { + "enabled": true + }, + "apiReport": { + "enabled": true, + "reportFolder": "./review" + }, "dtsRollup": { "enabled": true, "untrimmedFilePath": "", "publicTrimmedFilePath": "./types/arm-orbital.d.ts" }, "messages": { - "tsdocMessageReporting": { "default": { "logLevel": "none" } }, + "tsdocMessageReporting": { + "default": { + "logLevel": "none" + } + }, "extractorMessageReporting": { - "ae-missing-release-tag": { "logLevel": "none" }, - "ae-unresolved-link": { "logLevel": "none" } + "ae-missing-release-tag": { + "logLevel": "none" + }, + "ae-unresolved-link": { + "logLevel": "none" + } } } -} +} \ No newline at end of file diff --git a/sdk/orbital/arm-orbital/package.json b/sdk/orbital/arm-orbital/package.json index 9649b7b29b0d..b626beb5a86b 100644 --- a/sdk/orbital/arm-orbital/package.json +++ b/sdk/orbital/arm-orbital/package.json @@ -29,12 +29,12 @@ "types": "./types/arm-orbital.d.ts", "devDependencies": { "@microsoft/api-extractor": "^7.18.11", - "@rollup/plugin-commonjs": "^21.0.1", + "@rollup/plugin-commonjs": "11.0.2", "@rollup/plugin-json": "^4.0.0", "@rollup/plugin-multi-entry": "^3.0.0", "@rollup/plugin-node-resolve": "^8.0.0", "mkdirp": "^1.0.4", - "rollup": "^2.0.0", + "rollup": "^1.16.3", "rollup-plugin-sourcemaps": "^0.4.2", "typescript": "~4.2.0", "uglify-js": "^3.4.9", @@ -99,4 +99,4 @@ }, "sideEffects": false, "autoPublish": true -} +} \ No newline at end of file diff --git a/sdk/orbital/arm-orbital/review/arm-orbital.api.md b/sdk/orbital/arm-orbital/review/arm-orbital.api.md index 653bbd902fe0..38ba10b5775f 100644 --- a/sdk/orbital/arm-orbital/review/arm-orbital.api.md +++ b/sdk/orbital/arm-orbital/review/arm-orbital.api.md @@ -62,7 +62,7 @@ export interface AvailableGroundStationListResult { // @public export interface AvailableGroundStations { get(groundStationName: string, options?: AvailableGroundStationsGetOptionalParams): Promise; - listByCapability(capability: Enum6, options?: AvailableGroundStationsListByCapabilityOptionalParams): PagedAsyncIterableIterator; + listByCapability(capability: CapabilityType, options?: AvailableGroundStationsListByCapabilityOptionalParams): PagedAsyncIterableIterator; } // @public @@ -117,6 +117,9 @@ export interface AzureOrbitalOptionalParams extends coreClient.ServiceClientOpti // @public export type Capability = string; +// @public +export type CapabilityType = string; + // @public export interface CloudError { error?: CloudErrorBody; @@ -316,9 +319,6 @@ export interface EndPoint { protocol: Protocol; } -// @public -export type Enum6 = string; - // @public export enum KnownActionType { // (undocumented) @@ -333,6 +333,14 @@ export enum KnownCapability { EarthObservation = "EarthObservation" } +// @public +export enum KnownCapabilityType { + // (undocumented) + Communication = "Communication", + // (undocumented) + EarthObservation = "EarthObservation" +} + // @public export enum KnownCreatedByType { // (undocumented) @@ -353,14 +361,6 @@ export enum KnownDirection { Uplink = "uplink" } -// @public -export enum KnownEnum6 { - // (undocumented) - Communication = "Communication", - // (undocumented) - EarthObservation = "EarthObservation" -} - // @public export enum KnownOrigin { // (undocumented) diff --git a/sdk/orbital/arm-orbital/src/azureOrbital.ts b/sdk/orbital/arm-orbital/src/azureOrbital.ts index f23108ff9021..77d3da28182d 100644 --- a/sdk/orbital/arm-orbital/src/azureOrbital.ts +++ b/sdk/orbital/arm-orbital/src/azureOrbital.ts @@ -56,7 +56,7 @@ export class AzureOrbital extends coreClient.ServiceClient { credential: credentials }; - const packageDetails = `azsdk-js-arm-orbital/1.0.0-beta.2`; + const packageDetails = `azsdk-js-arm-orbital/1.0.0-beta.3`; const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}` diff --git a/sdk/orbital/arm-orbital/src/models/index.ts b/sdk/orbital/arm-orbital/src/models/index.ts index d4525a2a2bfc..b0415fe9b369 100644 --- a/sdk/orbital/arm-orbital/src/models/index.ts +++ b/sdk/orbital/arm-orbital/src/models/index.ts @@ -605,21 +605,21 @@ export enum KnownProtocol { */ export type Protocol = string; -/** Known values of {@link Enum6} that the service accepts. */ -export enum KnownEnum6 { +/** Known values of {@link CapabilityType} that the service accepts. */ +export enum KnownCapabilityType { EarthObservation = "EarthObservation", Communication = "Communication" } /** - * Defines values for Enum6. \ - * {@link KnownEnum6} can be used interchangeably with Enum6, + * Defines values for CapabilityType. \ + * {@link KnownCapabilityType} can be used interchangeably with CapabilityType, * this enum contains the known values that the service supports. * ### Known values supported by the service * **EarthObservation** \ * **Communication** */ -export type Enum6 = string; +export type CapabilityType = string; /** Known values of {@link Capability} that the service accepts. */ export enum KnownCapability { diff --git a/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts b/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts index 5df25eab882a..eb7443943d06 100644 --- a/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts +++ b/sdk/orbital/arm-orbital/src/operations/availableGroundStations.ts @@ -14,7 +14,7 @@ import * as Parameters from "../models/parameters"; import { AzureOrbital } from "../azureOrbital"; import { AvailableGroundStation, - Enum6, + CapabilityType, AvailableGroundStationsListByCapabilityNextOptionalParams, AvailableGroundStationsListByCapabilityOptionalParams, AvailableGroundStationsListByCapabilityResponse, @@ -42,7 +42,7 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { * @param options The options parameters. */ public listByCapability( - capability: Enum6, + capability: CapabilityType, options?: AvailableGroundStationsListByCapabilityOptionalParams ): PagedAsyncIterableIterator { const iter = this.listByCapabilityPagingAll(capability, options); @@ -60,7 +60,7 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { } private async *listByCapabilityPagingPage( - capability: Enum6, + capability: CapabilityType, options?: AvailableGroundStationsListByCapabilityOptionalParams ): AsyncIterableIterator { let result = await this._listByCapability(capability, options); @@ -78,7 +78,7 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { } private async *listByCapabilityPagingAll( - capability: Enum6, + capability: CapabilityType, options?: AvailableGroundStationsListByCapabilityOptionalParams ): AsyncIterableIterator { for await (const page of this.listByCapabilityPagingPage( @@ -95,7 +95,7 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { * @param options The options parameters. */ private _listByCapability( - capability: Enum6, + capability: CapabilityType, options?: AvailableGroundStationsListByCapabilityOptionalParams ): Promise { return this.client.sendOperationRequest( @@ -126,7 +126,7 @@ export class AvailableGroundStationsImpl implements AvailableGroundStations { * @param options The options parameters. */ private _listByCapabilityNext( - capability: Enum6, + capability: CapabilityType, nextLink: string, options?: AvailableGroundStationsListByCapabilityNextOptionalParams ): Promise { diff --git a/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts b/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts index fa3f0e81b313..69c1cbc19329 100644 --- a/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts +++ b/sdk/orbital/arm-orbital/src/operationsInterfaces/availableGroundStations.ts @@ -9,7 +9,7 @@ import { PagedAsyncIterableIterator } from "@azure/core-paging"; import { AvailableGroundStation, - Enum6, + CapabilityType, AvailableGroundStationsListByCapabilityOptionalParams, AvailableGroundStationsGetOptionalParams, AvailableGroundStationsGetResponse @@ -24,7 +24,7 @@ export interface AvailableGroundStations { * @param options The options parameters. */ listByCapability( - capability: Enum6, + capability: CapabilityType, options?: AvailableGroundStationsListByCapabilityOptionalParams ): PagedAsyncIterableIterator; /** diff --git a/sdk/orbital/arm-orbital/tsconfig.json b/sdk/orbital/arm-orbital/tsconfig.json index 6e3251194117..3e6ae96443f3 100644 --- a/sdk/orbital/arm-orbital/tsconfig.json +++ b/sdk/orbital/arm-orbital/tsconfig.json @@ -9,11 +9,19 @@ "esModuleInterop": true, "allowSyntheticDefaultImports": true, "forceConsistentCasingInFileNames": true, - "lib": ["es6", "dom"], + "lib": [ + "es6", + "dom" + ], "declaration": true, "outDir": "./dist-esm", "importHelpers": true }, - "include": ["./src/**/*.ts", "./test/**/*.ts"], - "exclude": ["node_modules"] -} + "include": [ + "./src/**/*.ts", + "./test/**/*.ts" + ], + "exclude": [ + "node_modules" + ] +} \ No newline at end of file diff --git a/sdk/orbital/ci.mgmt.yml b/sdk/orbital/ci.mgmt.yml index d6392f4b4e25..c52bc3980c22 100644 --- a/sdk/orbital/ci.mgmt.yml +++ b/sdk/orbital/ci.mgmt.yml @@ -1,5 +1,5 @@ # NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file. - + trigger: branches: include: @@ -10,6 +10,7 @@ trigger: include: - sdk/orbital/ci.mgmt.yml - sdk/orbital/arm-orbital/ + - sdk/orbital/arm-orbital pr: branches: include: @@ -23,11 +24,11 @@ pr: include: - sdk/orbital/ci.mgmt.yml - sdk/orbital/arm-orbital/ - + - sdk/orbital/arm-orbital extends: template: /eng/pipelines/templates/stages/archetype-sdk-client.yml parameters: ServiceDirectory: orbital Artifacts: - name: azure-arm-orbital - safeName: azurearmorbital \ No newline at end of file + safeName: azurearmorbital