consul icon indicating copy to clipboard operation
consul copied to clipboard

Added an initial openapi protobuf generator for our resource APIs.

Open mkeeler opened this issue 2 years ago • 2 comments

Description

I wrote a protobuf generator to output openapi specs for all our resource API groups.

Areas for improvement:

  • Handling of doc comments need some improvement.
    • stripping // from the beginning of lines
    • better HTTP path/operation docs
    • high level resource docs attached to the component schemas
    • external docs links eventually
  • Annotations for field validations
  • Support for knowing whether a resource can be imported/peered.

Testing & Reproduction steps

  • Ran openapi linters to ensure things are okay.
  • Opened openapi previews using a vscode extension to ensure the auto-generated docs look right.

mkeeler avatar Sep 21 '23 12:09 mkeeler

This pull request has been automatically flagged for inactivity because it has not been acted upon in the last 60 days. It will be closed if no new activity occurs in the next 30 days. Please feel free to re-open to resurrect the change if you feel this has happened by mistake. Thank you for your contributions.

github-actions[bot] avatar Nov 21 '23 01:11 github-actions[bot]

This pull request has been automatically flagged for inactivity because it has not been acted upon in the last 60 days. It will be closed if no new activity occurs in the next 30 days. Please feel free to re-open to resurrect the change if you feel this has happened by mistake. Thank you for your contributions.

github-actions[bot] avatar Feb 16 '24 01:02 github-actions[bot]

Closing due to inactivity. If you feel this was a mistake or you wish to re-open at any time in the future, please leave a comment and it will be re-surfaced for the maintainers to review.

github-actions[bot] avatar May 28 '24 01:05 github-actions[bot]