Skip to content

Update README with current repo structure - #623

Open
Jefftree wants to merge 1 commit into
kubernetes:masterfrom
Jefftree:update-readme
Open

Jefftree wants to merge 1 commit into
kubernetes:masterfrom
Jefftree:update-readme

Conversation

@Jefftree

@Jefftree Jefftree commented Jul 7, 2026

Copy link
Copy Markdown
Member

Add a note that both OpenAPI v2 and v3 are supported and a short list of the main components.

@kubernetes-prow
kubernetes-prow Bot requested review from jpbetz and sttts July 7, 2026 03:44
@kubernetes-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Jefftree

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubernetes-prow kubernetes-prow Bot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 7, 2026
@Jefftree

Jefftree commented Jul 7, 2026

Copy link
Copy Markdown
Member Author

/assign @jpbetz

Comment thread README.md
- `pkg/builder` and `pkg/builder3`: build a complete OpenAPI v2 or v3 spec
from web service routes and the generated definitions.
- `pkg/handler` and `pkg/handler3`: HTTP handlers that serve the resulting
specs as JSON or protobuf, with etag and gzip support.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it gzip is v2-only?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants