Skip to content

[AutoPR @azure/arm-selfhelp] Convert Help swagger to Tsp #15365

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 119 additions & 7 deletions sdk/selfhelp/arm-selfhelp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,127 @@
# Release History

## 2.0.0-beta.6 (Unreleased)


## 2.0.0-beta.6 (2025-05-09)
Compared with version 1.0.0

### Features Added

### Breaking Changes

### Bugs Fixed
- Added operation group CheckNameAvailability
- Added operation group DiscoverySolutionNLP
- Added operation group SimplifiedSolutions
- Added operation group Solution
- Added operation group SolutionSelfHelp
- Added operation group Troubleshooters
- Added Interface AutomatedCheckResult
- Added Interface CheckNameAvailabilityCheckAvailabilityOptionalParams
- Added Interface ClassificationService
- Added Interface ContinueRequestBody
- Added Interface DiagnosticsCreateHeaders
- Added Interface DiscoveryNlpRequest
- Added Interface DiscoveryNlpResponse
- Added Interface DiscoverySolutionNLPDiscoverSolutionsBySubscriptionOptionalParams
- Added Interface DiscoverySolutionNLPDiscoverSolutionsOptionalParams
- Added Interface Filter
- Added Interface FilterGroup
- Added Interface MetricsBasedChart
- Added Interface ReplacementMaps
- Added Interface ReplacementMapsSelfHelp
- Added Interface ResponseOption
- Added Interface ResponseValidationProperties
- Added Interface RestartTroubleshooterResponse
- Added Interface SearchResult
- Added Interface Section
- Added Interface SectionSelfHelp
- Added Interface SimplifiedSolutionsCreateHeaders
- Added Interface SimplifiedSolutionsCreateOptionalParams
- Added Interface SimplifiedSolutionsGetOptionalParams
- Added Interface SimplifiedSolutionsResource
- Added Interface SolutionCreateHeaders
- Added Interface SolutionCreateOptionalParams
- Added Interface SolutionGetOptionalParams
- Added Interface SolutionMetadataProperties
- Added Interface SolutionNlpMetadataResource
- Added Interface SolutionPatchRequestBody
- Added Interface SolutionResource
- Added Interface SolutionResourceSelfHelp
- Added Interface SolutionsDiagnostic
- Added Interface SolutionSelfHelpGetOptionalParams
- Added Interface SolutionsTroubleshooters
- Added Interface SolutionUpdateHeaders
- Added Interface SolutionUpdateOptionalParams
- Added Interface SolutionWarmUpOptionalParams
- Added Interface SolutionWarmUpRequestBody
- Added Interface Step
- Added Interface StepInput
- Added Interface TriggerCriterion
- Added Interface TroubleshooterResource
- Added Interface TroubleshooterResponse
- Added Interface TroubleshootersContinueOptionalParams
- Added Interface TroubleshootersCreateOptionalParams
- Added Interface TroubleshootersEndOptionalParams
- Added Interface TroubleshootersGetOptionalParams
- Added Interface TroubleshootersRestartOptionalParams
- Added Interface Video
- Added Interface VideoGroup
- Added Interface VideoGroupVideo
- Added Interface WebResult
- Added Type Alias AggregationType
- Added Type Alias AutomatedCheckResultType
- Added Type Alias CheckNameAvailabilityCheckAvailabilityResponse
- Added Type Alias Confidence
- Added Type Alias DiagnosticProvisioningState
- Added Type Alias DiscoverySolutionNLPDiscoverSolutionsBySubscriptionResponse
- Added Type Alias DiscoverySolutionNLPDiscoverSolutionsResponse
- Added Type Alias ExecutionStatus
- Added Type Alias Name
- Added Type Alias QuestionContentType
- Added Type Alias QuestionType
- Added Type Alias ResultType
- Added Type Alias SimplifiedSolutionsCreateResponse
- Added Type Alias SimplifiedSolutionsGetResponse
- Added Type Alias SolutionCreateResponse
- Added Type Alias SolutionGetResponse
- Added Type Alias SolutionProvisioningState
- Added Type Alias SolutionSelfHelpGetResponse
- Added Type Alias SolutionType
- Added Type Alias SolutionUpdateResponse
- Added Type Alias TroubleshooterProvisioningState
- Added Type Alias TroubleshootersCreateResponse
- Added Type Alias TroubleshootersGetResponse
- Added Type Alias TroubleshootersRestartResponse
- Added Type Alias Type
- Added Type Alias ValidationScope
- Interface SolutionMetadataResource has a new optional parameter solutions
- Added Enum KnownAggregationType
- Added Enum KnownAutomatedCheckResultType
- Added Enum KnownConfidence
- Added Enum KnownDiagnosticProvisioningState
- Added Enum KnownExecutionStatus
- Added Enum KnownName
- Added Enum KnownQuestionContentType
- Added Enum KnownQuestionType
- Added Enum KnownResultType
- Added Enum KnownSolutionProvisioningState
- Added Enum KnownSolutionType
- Added Enum KnownTroubleshooterProvisioningState
- Added Enum KnownType
- Added Enum KnownValidationScope

### Other Changes
### Breaking Changes

- Removed operation Diagnostics.checkNameAvailability
- Operation Diagnostics.beginCreate has a new signature
- Operation Diagnostics.beginCreateAndWait has a new signature
- Operation DiscoverySolution.list has a new signature
- Interface DiagnosticsCreateOptionalParams no longer has parameter diagnosticResourceRequest
- Interface SolutionMetadataResource no longer has parameter description
- Interface SolutionMetadataResource no longer has parameter requiredParameterSets
- Interface SolutionMetadataResource no longer has parameter solutionId
- Interface SolutionMetadataResource no longer has parameter solutionType
- Parameter value of interface DiscoveryResponse is now required
- Type of parameter provisioningState of interface DiagnosticResource is changed from ProvisioningState to DiagnosticProvisioningState
- Removed Enum KnownProvisioningState


## 2.0.0-beta.5 (2024-06-26)
Compared with version 1.0.0

Expand Down
2 changes: 1 addition & 1 deletion sdk/selfhelp/arm-selfhelp/LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
12 changes: 4 additions & 8 deletions sdk/selfhelp/arm-selfhelp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ npm install @azure/identity
```

You will also need to **register a new AAD application and grant access to Azure HelpRP** by assigning the suitable role to your service principal (note: roles such as `"Owner"` will not grant the necessary permissions).
Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables: `AZURE_CLIENT_ID`, `AZURE_TENANT_ID`, `AZURE_CLIENT_SECRET`.

For more information about how to create an Azure AD Application check out [this guide](https://learn.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal).

Expand All @@ -55,7 +54,7 @@ import { HelpRP } from "@azure/arm-selfhelp";
import { DefaultAzureCredential } from "@azure/identity";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new HelpRP(new DefaultAzureCredential());
const client = new HelpRP(new DefaultAzureCredential(), subscriptionId);
```

For browser environments, use the `InteractiveBrowserCredential` from the `@azure/identity` package to authenticate.
Expand All @@ -64,16 +63,14 @@ For browser environments, use the `InteractiveBrowserCredential` from the `@azur
import { InteractiveBrowserCredential } from "@azure/identity";
import { HelpRP } from "@azure/arm-selfhelp";

const subscriptionId = "00000000-0000-0000-0000-000000000000";
const credential = new InteractiveBrowserCredential({
tenantId: "<YOUR_TENANT_ID>",
clientId: "<YOUR_CLIENT_ID>",
});
const client = new HelpRP(credential);
clientId: "<YOUR_CLIENT_ID>"
});
const client = new HelpRP(credential, subscriptionId);
```

### JavaScript Bundle

To use this client library in the browser, first you need to use a bundler. For details on how to do this, please refer to our [bundling documentation](https://aka.ms/AzureSDKBundling).

## Key concepts
Expand Down Expand Up @@ -109,7 +106,6 @@ If you'd like to contribute to this library, please read the [contributing guide
- [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)



[azure_cli]: https://learn.microsoft.com/cli/azure
[azure_sub]: https://azure.microsoft.com/free/
[azure_sub]: https://azure.microsoft.com/free/
Expand Down
10 changes: 5 additions & 5 deletions sdk/selfhelp/arm-selfhelp/_meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"commit": "1c63635d66ae38cff18045ab416a6572d3e15f6e",
"commit": "51be344f3e6ae8e3e9b2a8b4c2676ee74c31bd4a",
"readme": "specification/help/resource-manager/readme.md",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=D:\\Git\\azure-sdk-for-js ..\\azure-rest-api-specs\\specification\\help\\resource-manager\\readme.md --use=@autorest/[email protected].23 --generate-sample=true",
"autorest_command": "autorest --version=3.9.7 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/help/resource-manager/readme.md --use=@autorest/typescript@^6.0.12",
"repository_url": "https://github.com/Azure/azure-rest-api-specs.git",
"release_tool": "@azure-tools/[email protected].10",
"use": "@autorest/[email protected].23"
}
"release_tool": "@azure-tools/[email protected].26",
"use": "@autorest/typescript@^6.0.12"
}
2 changes: 1 addition & 1 deletion sdk/selfhelp/arm-selfhelp/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@
}
}
}
}
}
6 changes: 0 additions & 6 deletions sdk/selfhelp/arm-selfhelp/assets.json

This file was deleted.

54 changes: 27 additions & 27 deletions sdk/selfhelp/arm-selfhelp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,42 +10,41 @@
"dependencies": {
"@azure/abort-controller": "^2.1.2",
"@azure/core-auth": "^1.9.0",
"@azure/core-client": "^1.9.2",
"@azure/core-client": "^1.9.4",
"@azure/core-lro": "^2.5.4",
"@azure/core-paging": "^1.6.2",
"@azure/core-rest-pipeline": "^1.19.0",
"@azure/core-rest-pipeline": "^1.20.0",
"tslib": "^2.8.1"
},
"keywords": [
"node",
"azure",
"typescript",
"browser",
"isomorphic"
"isomorphic",
"cloud"
],
"license": "MIT",
"main": "./dist/commonjs/index.js",
"module": "./dist/esm/index.js",
"types": "./dist/commonjs/index.d.ts",
"type": "module",
"devDependencies": {
"@azure-tools/test-credential": "^2.0.0",
"@azure-tools/test-recorder": "^4.1.0",
"@azure-tools/test-utils-vitest": "^1.0.0",
"@azure/dev-tool": "^1.0.0",
"@azure/identity": "^4.6.0",
"@azure/logger": "^1.1.4",
"@azure/identity": "^4.9.1",
"@azure/logger": "^1.2.0",
"@types/node": "^18.0.0",
"@vitest/browser": "^3.0.9",
"@vitest/coverage-istanbul": "^3.0.9",
"dotenv": "^16.0.0",
"playwright": "^1.50.1",
"playwright": "^1.52.0",
"typescript": "~5.8.2",
"vitest": "^3.0.9"
},
"repository": {
"type": "git",
"url": "https://github.com/Azure/azure-sdk-for-js.git"
},
"repository": "github:Azure/azure-sdk-for-js",
"bugs": {
"url": "https://github.com/Azure/azure-sdk-for-js/issues"
},
Expand All @@ -58,20 +57,30 @@
],
"scripts": {
"build": "npm run clean && dev-tool run build-package && dev-tool run extract-api",
"build:browser": "echo skipped",
"build:node": "echo skipped",
"build:samples": "echo skipped.",
"check-format": "echo skipped",
"build:test": "echo skipped",
"check-format": "dev-tool run vendored prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
"clean": "dev-tool run vendored rimraf --glob dist dist-browser dist-esm test-dist temp types *.tgz *.log",
"execute:samples": "echo skipped",
"extract-api": "dev-tool run extract-api",
"format": "echo skipped",
"format": "dev-tool run vendored prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.{ts,cts,mts}\" \"test/**/*.{ts,cts,mts}\" \"*.{js,cjs,mjs,json}\" ",
"integration-test": "npm run integration-test:node && npm run integration-test:browser",
"integration-test:browser": "echo skipped",
"integration-test:node": "dev-tool run test:vitest --esm",
"lint": "echo skipped",
"minify": "dev-tool run vendored uglifyjs -c -m --comments --source-map \"content='./dist/index.js.map'\" -o ./dist/index.min.js ./dist/index.js",
"pack": "npm pack 2>&1",
"prepack": "npm run build",
"test": "npm run test:node && npm run test:browser",
"test": "npm run integration-test",
"test:browser": "echo skipped",
"test:node": "dev-tool run test:vitest",
"test:node:esm": "dev-tool run test:vitest --esm",
"update-snippets": "dev-tool run update-snippets"
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
"unit-test:browser": "echo skipped",
"unit-test:node": "dev-tool run test:vitest",
"update-snippets": "dev-tool run update-snippets",
"test:node:esm": "dev-tool run test:vitest --esm"
},
"sideEffects": false,
"//metadata": {
Expand All @@ -83,16 +92,9 @@
]
},
"autoPublish": true,
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/selfhelp/arm-selfhelp",
"//sampleConfiguration": {
"productName": "",
"productSlugs": [
"azure"
],
"disableDocsMs": true,
"apiRefLink": "https://learn.microsoft.com/javascript/api/@azure/arm-selfhelp?view=azure-node-preview"
},
"type": "module",
"tshy": {
"project": "./tsconfig.src.json",
"exports": {
Expand All @@ -109,8 +111,6 @@
],
"selfLink": false
},
"browser": "./dist/browser/index.js",
"react-native": "./dist/react-native/index.js",
"exports": {
"./package.json": "./package.json",
".": {
Expand All @@ -132,4 +132,4 @@
}
}
}
}
}
Loading