summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUrvashi Mohnani <umohnani@redhat.com>2021-10-01 13:09:02 -0400
committerUrvashi Mohnani <umohnani@redhat.com>2021-10-01 13:18:52 -0400
commit4ea5d6971919b14698f518ca361c2312a2844d27 (patch)
tree89adc626aadd182b87f28c719bb9bf2b1014abe2
parentc6a896b0c705415a9115dff354b0a19a2c08ce50 (diff)
downloadpodman-4ea5d6971919b14698f518ca361c2312a2844d27.tar.gz
podman-4ea5d6971919b14698f518ca361c2312a2844d27.tar.bz2
podman-4ea5d6971919b14698f518ca361c2312a2844d27.zip
Add note about empty fields and null values for API responses
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>
-rw-r--r--pkg/api/server/docs.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/pkg/api/server/docs.go b/pkg/api/server/docs.go
index bf15afbf9..83d9ef160 100644
--- a/pkg/api/server/docs.go
+++ b/pkg/api/server/docs.go
@@ -15,6 +15,15 @@
// NOTE: if you install the package podman-docker, it will create a symbolic
// link for /run/docker.sock to /run/podman/podman.sock
//
+// NOTE: some fields in the API response JSON are set as omitempty, which means that
+// if there is no value set for them, they will not show up in the API response. This
+// is a feature to help reduce the size of the JSON responses returned via the API.
+//
+// NOTE: due to the limitations of [go-swagger](https://github.com/go-swagger/go-swagger),
+// some field values that have a complex type show up as null in the docs as well as in the
+// API responses. This is because the zero value for the field type is null. The field
+// description in the docs will state what type the field is expected to be for such cases.
+//
// See podman-service(1) for more information.
//
// Quick Examples: