diff options
| author | Jhon Honce <jhonce@redhat.com> | 2021-06-04 10:45:52 -0700 |
|---|---|---|
| committer | Jhon Honce <jhonce@redhat.com> | 2021-06-04 10:59:32 -0700 |
| commit | 8f89bc4e074fc6b3da7417e247a08433492caa52 (patch) | |
| tree | a49d5dfc398260a4f6553933f15df8cc09d5eb60 /pkg/api | |
| parent | cdf26a3d5677e0372e8892f85a8fd6065d512bcf (diff) | |
| download | podman-8f89bc4e074fc6b3da7417e247a08433492caa52.tar.gz podman-8f89bc4e074fc6b3da7417e247a08433492caa52.tar.bz2 podman-8f89bc4e074fc6b3da7417e247a08433492caa52.zip | |
[CI:DOCS] Document which CNI fields are encoded
The CNI configuration fields named Bytes are typed
[]byte which the GO JSON encoded automatically Base64 encodes.
Note: Future major versions of Podman will refactor the networking
endpoints to encapsulate/abstract the CNI structures which will
allow better documenation and encoding.
Fixes #10562
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'pkg/api')
| -rw-r--r-- | pkg/api/server/register_networks.go | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/pkg/api/server/register_networks.go b/pkg/api/server/register_networks.go index 9a5ccb789..4d9806316 100644 --- a/pkg/api/server/register_networks.go +++ b/pkg/api/server/register_networks.go @@ -241,7 +241,9 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error { // tags: // - networks // summary: List networks - // description: Display summary of network configurations + // description: | + // Display summary of network configurations. + // - In a 200 response, all of the fields named Bytes are returned as a Base64 encoded string. // parameters: // - in: query // name: filters |