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.

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

OpenAPI spec for diagnostics server #6213

Open
2 of 5 tasks
czeslavo opened this issue Jun 17, 2024 · 0 comments
Open
2 of 5 tasks

OpenAPI spec for diagnostics server #6213

czeslavo opened this issue Jun 17, 2024 · 0 comments
Labels
area/docs area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality.
Milestone

Comments

@czeslavo
Copy link
Contributor

czeslavo commented Jun 17, 2024

Is there an existing issue for this?

  • I have searched the existing issues

Does this enhancement require public documentation?

  • I have added an Acceptance Criteria item for adding and/or adjusting public documentation (if applicable)

Problem Statement

Currently, KIC's diagnostics server is not documented properly. As we started adding more endpoints to it, it might be worth defining it properly using some industry-standard API spec like OpenAPI.

Proposed Solution

  • Define OpenAPI 3.0 spec for the existing server
  • Adjust the server code by replacing hand-written boilerplate with auto-generated types and server base (e.g. using oapi-codegen)
  • Make the spec available from the official docs

Additional information

No response

Acceptance Criteria

  • KIC's diagnostics server API is defined in OpenAPI spec
  • KIC's diagnostics server boilerplate (types and parts of server) is generated from the spec
  • OpenAPI spec is linked in the docs.konghq.com diagnostics server reference
@czeslavo czeslavo added area/docs area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality. labels Jun 17, 2024
@czeslavo czeslavo added this to the KIC v3.3.x milestone Jun 25, 2024
@lahabana lahabana modified the milestones: KIC v3.3.x, KIC v3.4.x Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs area/maintenance Cleanup, refactoring, and other maintenance improvements that don't change functionality.
Projects
None yet
Development

No branches or pull requests

2 participants