redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

config option: remove version from API title

Open ArtFlag opened this issue 3 years ago • 2 comments
trafficstars

Is your feature request related to a problem? Please describe.

When I preview my docs, the API version is appended to the API title as an H1 title by default.

Describe the solution you'd like

I would like to be able to not insert the version in the title.

ArtFlag avatar Sep 07 '22 13:09 ArtFlag

@ArtFlag, do you mean you're using preview-docs command? Could you put a screenshot here?

tatomyr avatar Sep 12 '22 09:09 tatomyr

@ArtFlag the version won't display if you change your version to an empty string, for example.

https://redocly.com/docs/openapi-visual-reference/info/#version-examples

You can set the version as an empty string pro grammatically by using a decorator.

I'd recommend looking at these: https://redocly.com/docs/cli/decorators/ to get a sense of how to create one. We don't have a step-by-step guide for that yet.

adamaltman avatar Sep 12 '22 19:09 adamaltman

@tatomyr that's right, I generate the output with preview-docs.

@adamaltman setting the version to an empty string did the trick thanks a lot 😊

ArtFlag avatar Oct 08 '22 16:10 ArtFlag