search

opticdev / optic

OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.
https://useoptic.com
MIT License
1.35k stars 79 forks source link

Highlight deprecated fields in history command output #2846

Closed amit-ng closed 2 months ago

amit-ng commented 2 months ago

Describe the enhancement Highlight deprecated fields when using history command, this will be really informative when generating change logs for end users. Having this as always available in history command or adding a separate command will be great to have.

Additional information We are planning to use Optic for our API change log documentation. We found that fields marked as deprecated are not captured in history command output. We feel this could a neat add-on to history command itself.

amit-ng commented 2 months ago

Seems like this support is available in some form. So will close this request.

acunniffe commented 2 months ago

Yeah it will show removed fields and added the attribute deprecated but it doesn't get any special formatting. If there's another way you'd like it to show up, feel free to copy some Optic history output, modify it, then share it here