search

BitGo / api-ts

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

docs: rework openapi-generator README.md #871

Closed ad-world closed 2 months ago

ad-world commented 2 months ago

DX-669

This is a ticket to rework the README for openapi-generator. This ticket adds a table of contents, and it also adds a generator reference at the end to showcase the different features that this generator supports for adding openapi documentation.

ad-world commented 2 months ago

@andrew-scott-fischer am I good to merge? There's another unresolved comment!

andrew-scott-fischer commented 2 months ago

@ad-world I've left a comment

ad-world commented 2 months ago

@ericcrosson-bitgo the actual stripping happens in another step of the process here. But I'm now thinking that we may just get rid of this, as @andrew-scott-fischer has mentioned that it is not the expected result of the @unstable tag to remove the docs completely, rather than annotate them as unstable. I guess we just need to make sure that this information is captured correctly in dev-portal

ericcrosson-bitgo commented 2 months ago

@ad-world Will you please squash this PR's commits?

github-actions[bot] commented 2 months ago

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

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

Your semantic-release bot :package::rocket:

github-actions[bot] commented 2 months ago

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

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

Your semantic-release bot :package::rocket:

github-actions[bot] commented 2 months ago

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

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

Your semantic-release bot :package::rocket:

github-actions[bot] commented 2 months ago

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

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

Your semantic-release bot :package::rocket:

github-actions[bot] commented 1 week ago

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

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

Your semantic-release bot :package::rocket: