Skip to content

Commit

Permalink
try-fix-doc-in-params-tag (#1846)
Browse files Browse the repository at this point in the history 
* try-fix-doc-in-params-tag

* fix ci failures
  • Loading branch information
@qiaozha
qiaozha authored May 17, 2023
1 parent c10217f commit d4f78fb
Show file tree
Hide file tree
Showing 69 changed files with 269 additions and 272 deletions.
254 changes: 127 additions & 127 deletions packages/autorest.typescript/test/commands/smoke-test-list.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,133 +46,133 @@ const getArmReadmes = (): SpecDefinition[] => {
};

export const readmes: SpecDefinition[] = [
// ...getArmReadmes(),
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/sql/resource-manager/readme.md"
// ),
// branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
// params: [
// AutorestParams.GenerateTest,
// AutorestParams.ModelDedup,
// AutorestParams.GenerateSamples,
// AutorestParams.AzureArm,
// AutorestParams.AzureSdkForJs
// ],
// buildTag: "ci_1"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/web/resource-manager/readme.md"
// ),
// params: [
// AutorestParams.GenerateTest,
// AutorestParams.GenerateSamples,
// AutorestParams.AzureSdkForJs
// ],
// branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
// buildTag: "ci_2"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/monitor/data-plane/readme.md"
// ),
// params: [AutorestParams.Security],
// buildTag: "ci_2"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/graphrbac/data-plane/readme.md"
// ),
// buildTag: "ci_2"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/cosmos-db/resource-manager/readme.md"
// ),
// params: [AutorestParams.ModelDedup],
// branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
// buildTag: "ci_2"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/compute/resource-manager/readme.md"
// ),
// params: [
// AutorestParams.GenerateTest,
// AutorestParams.ModelDedup,
// AutorestParams.GenerateSamples,
// AutorestParams.AzureSdkForJs
// ],
// branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
// buildTag: "ci_2"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/network/resource-manager/readme.md"
// ),
// params: [
// AutorestParams.GenerateTest,
// AutorestParams.GenerateSamples,
// AutorestParams.AzureSdkForJs,
// AutorestParams.AzureArm
// ],
// branch: "25bea13c86145a7620e363826a9ae476c18adb5f",
// buildTag: "ci_3"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/keyvault/resource-manager/readme.md"
// ),
// params: [
// AutorestParams.GenerateTest,
// AutorestParams.GenerateSamples,
// AutorestParams.AzureSdkForJs,
// AutorestParams.AzureArm
// ],
// branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
// buildTag: "ci_3"
// },
// {
// path: joinPath(
// `${__dirname}`,
// "..",
// "..",
// "./.tmp/specs/specification/storage/resource-manager/readme.md"
// ),
// params: [
// AutorestParams.ModelDedup,
// AutorestParams.GenerateTest,
// AutorestParams.GenerateSamples,
// AutorestParams.AzureSdkForJs
// ],
// branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
// buildTag: "ci_3"
// },
...getArmReadmes(),
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/sql/resource-manager/readme.md"
),
branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
params: [
AutorestParams.GenerateTest,
AutorestParams.ModelDedup,
AutorestParams.GenerateSamples,
AutorestParams.AzureArm,
AutorestParams.AzureSdkForJs
],
buildTag: "ci_1"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/web/resource-manager/readme.md"
),
params: [
AutorestParams.GenerateTest,
AutorestParams.GenerateSamples,
AutorestParams.AzureSdkForJs
],
branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
buildTag: "ci_2"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/monitor/data-plane/readme.md"
),
params: [AutorestParams.Security],
buildTag: "ci_2"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/graphrbac/data-plane/readme.md"
),
buildTag: "ci_2"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/cosmos-db/resource-manager/readme.md"
),
params: [AutorestParams.ModelDedup],
branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
buildTag: "ci_2"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/compute/resource-manager/readme.md"
),
params: [
AutorestParams.GenerateTest,
AutorestParams.ModelDedup,
AutorestParams.GenerateSamples,
AutorestParams.AzureSdkForJs
],
branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
buildTag: "ci_2"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/network/resource-manager/readme.md"
),
params: [
AutorestParams.GenerateTest,
AutorestParams.GenerateSamples,
AutorestParams.AzureSdkForJs,
AutorestParams.AzureArm
],
branch: "25bea13c86145a7620e363826a9ae476c18adb5f",
buildTag: "ci_3"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/keyvault/resource-manager/readme.md"
),
params: [
AutorestParams.GenerateTest,
AutorestParams.GenerateSamples,
AutorestParams.AzureSdkForJs,
AutorestParams.AzureArm
],
branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
buildTag: "ci_3"
},
{
path: joinPath(
`${__dirname}`,
"..",
"..",
"./.tmp/specs/specification/storage/resource-manager/readme.md"
),
params: [
AutorestParams.ModelDedup,
AutorestParams.GenerateTest,
AutorestParams.GenerateSamples,
AutorestParams.AzureSdkForJs
],
branch: "925e8285703ddd461588d8f5fbf14bd97c286fab",
buildTag: "ci_3"
},
{
path: joinPath(
`${__dirname}`,
Expand Down
2 changes: 1 addition & 1 deletion ...est.typescript/test/rlcIntegration/generated/bodyComplexRest/src/bodyComplexRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { BodyComplexRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `BodyComplexRestClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion packages/autorest.typescript/test/rlcIntegration/generated/bodyFileRest/src/bodyFile.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { BodyFileClient } from "./clientDefinitions";

/**
* Initialize a new instance of `BodyFileClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion ...es/autorest.typescript/test/rlcIntegration/generated/bodyFormDataRest/src/bodyFormData.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { BodyFormDataClient } from "./clientDefinitions";

/**
* Initialize a new instance of `BodyFormDataClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion ...es/autorest.typescript/test/rlcIntegration/generated/bodyStringRest/src/bodyStringRest.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { BodyStringRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `BodyStringRestClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
4 changes: 2 additions & 2 deletions ...utorest.typescript/test/rlcIntegration/generated/customUrlRest/src/customUrlRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import { CustomUrlRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `CustomUrlRestClient`
* @param host type: string, A string value that is used as a global part of the parameterized host
* @param options type: ClientOptions, the parameter for all optional parameters
* @param host - A string value that is used as a global part of the parameterized host
* @param options - the parameter for all optional parameters
*/
export default function createClient(
host: string,
Expand Down
2 changes: 1 addition & 1 deletion ...t.typescript/test/rlcIntegration/generated/dpgCustomization/src/dPGCustomizationClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { DPGCustomizationClient } from "./clientDefinitions";

/**
* Initialize a new instance of `DPGCustomizationClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion ...ages/autorest.typescript/test/rlcIntegration/generated/headerRest/src/headerRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { HeaderRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `HeaderRestClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion .../test/rlcIntegration/generated/httpInfrastructureRest/src/httpInfrastructureRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { HttpInfrastructureRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `HttpInfrastructureRestClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion packages/autorest.typescript/test/rlcIntegration/generated/lroRest/src/lRORestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { LRORestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `LRORestClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion packages/autorest.typescript/test/rlcIntegration/generated/mediaTypesRest/src/mediaTypes.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { MediaTypesClient } from "./clientDefinitions";

/**
* Initialize a new instance of `MediaTypesClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
2 changes: 1 addition & 1 deletion ...est/rlcIntegration/generated/multipleInheritanceRest/src/multipleInheritanceRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { MultipleInheritanceRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `MultipleInheritanceRestClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
8 changes: 4 additions & 4 deletions ...test/rlcIntegration/generated/multipleUrlParameters/src/multipleUrlParameterRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ import { MultipleUrlParameterRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `MultipleUrlParameterRestClient`
* @param endpoint type: string, The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com
* @param serviceVersion type: "v2"|"v1", the version of api
* @param credentials type: TokenCredential, uniquely identify client credential
* @param options type: ClientOptions, the parameter for all optional parameters
* @param endpoint - The catalog endpoint of your Purview account. Example: https://{accountName}.purview.azure.com
* @param serviceVersion - the version of api
* @param credentials - uniquely identify client credential
* @param options - the parameter for all optional parameters
*/
export default function createClient(
endpoint: string,
Expand Down
2 changes: 1 addition & 1 deletion packages/autorest.typescript/test/rlcIntegration/generated/pagingRest/src/paging.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { PagingClient } from "./clientDefinitions";

/**
* Initialize a new instance of `PagingClient`
* @param options type: ClientOptions, the parameter for all optional parameters
* @param options - the parameter for all optional parameters
*/
export default function createClient(
options: ClientOptions = {}
Expand Down
4 changes: 2 additions & 2 deletions ...est.typescript/test/rlcIntegration/generated/securityAADRest/src/securityAADRestClient.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ import { SecurityAADRestClient } from "./clientDefinitions";

/**
* Initialize a new instance of `SecurityAADRestClient`
* @param credentials type: TokenCredential, uniquely identify client credential
* @param options type: ClientOptions, the parameter for all optional parameters
* @param credentials - uniquely identify client credential
* @param options - the parameter for all optional parameters
*/
export default function createClient(
credentials: TokenCredential,
Expand Down
Loading

0 comments on commit d4f78fb

Please sign in to comment.