BitGo / api-ts

Type- and runtime- safe TypeScript APIs
https://bitgo.github.io/api-ts
Other
15 stars 21 forks source link

feat: consolidate comments from nested levels of schemas #855

Closed ad-world closed 1 month ago

ad-world commented 1 month ago

DX-592

This is a PR that adds functionality to consolidate comments when they are present in different schemas that refer to each other.

For example.

/** 
@example 123
*/
const EnterpriseIdString = t.string;

const Enterprise = t.type({
    /** The Enterprise ID */
    id: EnterpriseIdString
})

Previously, the example would get stripped from the generation since we saw the second comment and used it to overwrite the first one. This PR ensures that we don't lose that information.

github-actions[bot] commented 1 month ago

:tada: This PR is included in version @api-ts/openapi-generator@4.27.0 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 month ago

:tada: This PR is included in version @api-ts/express-wrapper@1.0.28 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 month ago

:tada: This PR is included in version @api-ts/typed-express-router@1.1.8 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 month ago

:tada: This PR is included in version @api-ts/superagent-wrapper@1.2.3 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 month ago

:tada: This PR is included in version @api-ts/io-ts-http@3.1.0 :tada:

The release is available on npm package (@latest dist-tag)

Your semantic-release bot :package::rocket: