cbSwagger

Description

I am often moving too fast to keep API documentation updated, and in most of those cases documentation isn't critical. But not adding documentation for new endpoints breaks the module completely. It would be great if existing documentation for endpoints that have been completed were not broken if a new one isn't complete yet. Ideally, a mock reference could be added for these with the text "documentation not available/complete/ready/whatever".

Activity

Show:

John WilsonFebruary 9, 2022 at 11:43 PM

Belt and suspenders

Jon ClausenFebruary 9, 2022 at 11:37 PM

Line commenting a block comment gives me a mental and emotional java.lang.StackOverflowError

John WilsonFebruary 9, 2022 at 9:24 PM

Clearly, I tend to overthink things… Thanks all for your help.

Daniel GarciaFebruary 9, 2022 at 9:00 PM
Edited

another option is to simply create the documentation block how you are going to want it and then temporarily comment it out.

If the block is commented out then cbSwagger should ignore it.

John WilsonFebruary 9, 2022 at 6:39 PM

OK, I can work with that. Thanks for the quick response.

Pinned fields
Click on the next to a field label to start pinning.

Details

Assignee

Reporter

Priority

Sentry

Created February 9, 2022 at 1:12 PM
Updated February 9, 2022 at 11:43 PM