Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added an initial openapi protobuf generator for our resource APIs. #18936

Closed
wants to merge 1 commit into from
Closed

Added an initial openapi protobuf generator for our resource APIs. #18936

wants to merge 1 commit into from

Conversation

mkeeler
Copy link
Member

@mkeeler mkeeler commented Sep 21, 2023

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.

@github-actions github-actions bot added the pr/dependencies PR specifically updates dependencies of project label Sep 21, 2023
@mkeeler mkeeler changed the base branch from main to ishustava/NET-5580-bump-resource-versions September 21, 2023 16:10
@mkeeler mkeeler changed the base branch from ishustava/NET-5580-bump-resource-versions to resource-type-gen September 21, 2023 20:46
Base automatically changed from resource-type-gen to main September 21, 2023 21:18
@github-actions GitHub Actions
Copy link

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 github-actions bot added the meta/stale Automatically flagged for inactivity by stalebot label Nov 21, 2023
@github-actions github-actions bot removed the meta/stale Automatically flagged for inactivity by stalebot label Dec 1, 2023
@mkeeler mkeeler marked this pull request as ready for review December 6, 2023 16:45
@mkeeler mkeeler requested a review from a team as a code owner December 6, 2023 16:45
@github-actions GitHub Actions
Copy link

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 github-actions bot added the meta/stale Automatically flagged for inactivity by stalebot label Feb 16, 2024
@github-actions GitHub Actions
Copy link

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 github-actions bot closed this May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
meta/stale Automatically flagged for inactivity by stalebot pr/dependencies PR specifically updates dependencies of project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@mkeeler