Skip to content

Commit

Permalink
(feature, typescript): Use generator-cli to generate reference.md (#4062
Browse files Browse the repository at this point in the history
)
  • Loading branch information
amckinney authored Jul 15, 2024
1 parent 8bd1643 commit ef62ea3
Show file tree
Hide file tree
Showing 75 changed files with 30,855 additions and 598 deletions.
7 changes: 7 additions & 0 deletions generators/typescript/sdk/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.32.0] - 2024-07-15

- Feature: The `reference.md` is now generated for every SDK.
- Improvement: The `reference.md` is now generated by the `generator-cli`.
- Fix: The `reference.md` includes a single section for the _first_ example specified
on the endpoint. Previously, a separate section was included for _every_ example.

## [0.31.0] - 2024-07-12

- Feature: Add `omitUndefined` generator option. This is enabled with the following config:
Expand Down
2 changes: 1 addition & 1 deletion generators/typescript/sdk/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.31.0
0.32.0
1 change: 0 additions & 1 deletion generators/typescript/sdk/cli/src/SdkGeneratorCli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ export class SdkGeneratorCli extends AbstractGeneratorCli<SdkCustomConfig> {
includeSerdeLayer: !customConfig.noSerdeLayer,
retainOriginalCasing: customConfig.retainOriginalCasing ?? false,
noOptionalProperties: customConfig.noOptionalProperties,
includeApiReference: customConfig.includeApiReference ?? false,
tolerateRepublish: customConfig.tolerateRepublish,
allowExtraFields: customConfig.allowExtraFields ?? false,
inlineFileProperties: customConfig.inlineFileProperties ?? false,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ export const SdkCustomConfigSchema = z.strictObject({
includeContentHeadersOnFileDownloadResponse: z.optional(z.boolean()),
includeUtilsOnUnionMembers: z.optional(z.boolean()),
includeOtherInUnionTypes: z.optional(z.boolean()),
includeApiReference: z.optional(z.boolean()),
retainOriginalCasing: z.optional(z.boolean()),
allowExtraFields: z.optional(z.boolean()),
inlineFileProperties: z.optional(z.boolean()),

// deprecated
timeoutInSeconds: z.optional(z.union([z.literal("infinity"), z.number()]))
timeoutInSeconds: z.optional(z.union([z.literal("infinity"), z.number()])),
includeApiReference: z.optional(z.boolean())
});

export type SdkCustomConfigSchema = z.infer<typeof SdkCustomConfigSchema>;
137 changes: 0 additions & 137 deletions generators/typescript/sdk/generator/src/ReferenceGenerator.ts

This file was deleted.

Loading

0 comments on commit ef62ea3

Please sign in to comment.