Skip to content

Add note about empty fields and null values for API responses - #11833

Merged
openshift-merge-robot merged 1 commit into
podman-container-tools:mainfrom
umohnani8:swagger
Oct 1, 2021
Merged

Add note about empty fields and null values for API responses#11833
openshift-merge-robot merged 1 commit into
podman-container-tools:mainfrom
umohnani8:swagger

Conversation

@umohnani8

Copy link
Copy Markdown
Contributor

[NO TESTS NEEDED]

Signed-off-by: Urvashi Mohnani umohnani@redhat.com

What this PR does / why we need it:

Add a note the global swagger docs about some fields not showing
up in responses as they are set to omitempty. Also add a note about
null values for complicated field types that swagger-go has a hard time
with.

How to verify it

Check swagger docs for update

Which issue(s) this PR fixes:

Fixes #11826
Fixes #11830

Special notes for your reviewer:

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 1, 2021
@umohnani8

Copy link
Copy Markdown
Contributor Author

@jwhonce @TomSweeneyRedHat PTAL

@jwhonce jwhonce left a comment

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.

One small nit

Comment thread pkg/api/server/docs.go Outdated
@jwhonce

jwhonce commented Oct 1, 2021

Copy link
Copy Markdown
Contributor

LGTM

Add a note the global swagger docs about some fields not showing
up in responses as they are set to omitempty. Also add a note about
null values for complicated field types that swagger-go has a hard time
with.

[NO TESTS NEEDED]

Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
@rhatdan

rhatdan commented Oct 1, 2021

Copy link
Copy Markdown
Contributor

/lgtm
/approve
/hold

@openshift-ci openshift-ci Bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 1, 2021
@openshift-ci

openshift-ci Bot commented Oct 1, 2021

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhatdan, umohnani8

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

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Oct 1, 2021
@TomSweeneyRedHat

Copy link
Copy Markdown
Contributor

one suspected flake test, I restarted.

@TomSweeneyRedHat

Copy link
Copy Markdown
Contributor

LGTM

@rhatdan

rhatdan commented Oct 1, 2021

Copy link
Copy Markdown
Contributor

/hold cancel

@openshift-ci openshift-ci Bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 1, 2021
@openshift-merge-robot
openshift-merge-robot merged commit 9dddd6a into podman-container-tools:main Oct 1, 2021
@umohnani8
umohnani8 deleted the swagger branch February 23, 2023 18:44
@github-actions github-actions Bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 8, 2023
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Sep 8, 2023
@edsantiago edsantiago added the No New Tests Allow PR to proceed without adding regression tests label Feb 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. No New Tests Allow PR to proceed without adding regression tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some networks API endpoints are missing fields or returning null instead of a string. Inspect pod API endpoint result differs from API documentation

6 participants