[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>
This commit is contained in:
Jhon Honce
2021-06-04 10:45:52 -07:00
parent cdf26a3d56
commit 8f89bc4e07

View File

@ -241,7 +241,9 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
// tags: // tags:
// - networks // - networks
// summary: List 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: // parameters:
// - in: query // - in: query
// name: filters // name: filters