Skip to content

chore(ws): update swaggo dependency to v1.16.5 and add required fields in OpenAPI definitions #489

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
Open
wants to merge 1 commit into
base: notebooks-v2
Choose a base branch
from
Open

chore(ws): update swaggo dependency to v1.16.5 and add required fields in OpenAPI definitions #489

wants to merge 1 commit into from

Conversation

andyatmiami
Copy link
Contributor

related: #430

  • Updated swaggo/swag from v1.16.4 to v1.16.5 in go.mod and Makefile.
  • Added required fields to various OpenAPI definitions in docs.go and swagger.json for better validation via --requiredByDefault flag
    • swag v1.16.5 contains a commit we authored to treat json:omitempty as required: false. That, in conjunction with --requiredByDefault flag, allows us to generate models with proper required-ness

@andyatmiami
chore(ws): update swaggo dependency to v1.16.5 and add required field…
c51c964 
…s in OpenAPI definitions

- Updated swaggo/swag from v1.16.4 to v1.16.5 in go.mod and Makefile.
- Added required fields to various OpenAPI definitions in docs.go and swagger.json for better validation via `--requiredByDefault` flag
    - `swag` `v1.16.5` contains a commit we authored to treat `json:omitempty` as `required: false`.  That, in conjunction with `--requiredByDefault` flag, allows us to generate models with proper _required-ness_

Signed-off-by: Andy Stoneberg <[email protected]>
@github-project-automation github-project-automation bot moved this to Needs Triage in Kubeflow Notebooks Jul 18, 2025
@google-oss-prow google-oss-prow bot added the area/backend area - related to backend components label Jul 18, 2025
@google-oss-prow Google OSS Prow
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kimwnasptd for approval. For more information see the Kubernetes Code Review Process.

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

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

@google-oss-prow google-oss-prow bot added area/v2 area - version - kubeflow notebooks v2 size/L labels Jul 18, 2025
@andyatmiami
Copy link
Contributor Author

/hold

The v1.16.5 release of swag is quasi-broken in that numerous adopters raised an issue shortly after release around a nil pointer dereference:

While this particular bug does not seem to affect kubeflow/notebooks - even though we are leveraging the parseDependency flag - I would prefer we wait a couple days to see if a v1.16.6 release will be published since a fix to swaggo/swag#2042 has been merged.

@caponetto caponetto mentioned this pull request Jul 22, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kimwnasptd kimwnasptd Awaiting requested review from kimwnasptd

@thesuperzapper thesuperzapper Awaiting requested review from thesuperzapper

Assignees
No one assigned
Labels
area/backend area - related to backend components area/v2 area - version - kubeflow notebooks v2 do-not-merge/hold size/L
Projects
Kubeflow Notebooks
Status: Needs Triage
Milestone
No milestone
Development

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