From 5117deda04b765cd3dc7bd454286764a7c1ea6bc Mon Sep 17 00:00:00 2001
From: cdoern <cbdoer23@g.holycross.edu>
Date: Tue, 8 Jun 2021 12:58:48 -0400
Subject: fixed docs and schemas

Signed-off-by: cdoern <cbdoer23@g.holycross.edu>
---
 pkg/api/handlers/compat/networks.go | 31 ++++++++++++++++++-------------
 pkg/api/server/register_networks.go | 10 ++++++++++
 2 files changed, 28 insertions(+), 13 deletions(-)

(limited to 'pkg/api')

diff --git a/pkg/api/handlers/compat/networks.go b/pkg/api/handlers/compat/networks.go
index 77ed548d8..be895001c 100644
--- a/pkg/api/handlers/compat/networks.go
+++ b/pkg/api/handlers/compat/networks.go
@@ -28,19 +28,24 @@ import (
 func InspectNetwork(w http.ResponseWriter, r *http.Request) {
 	runtime := r.Context().Value("runtime").(*libpod.Runtime)
 
-	// FYI scope and version are currently unused but are described by the API
-	// Leaving this for if/when we have to enable these
-	// query := struct {
-	//	scope   string
-	//	verbose bool
-	// }{
-	//	// override any golang type defaults
-	// }
-	// decoder := r.Context().Value("decoder").(*schema.Decoder)
-	// if err := decoder.Decode(&query, r.URL.Query()); err != nil {
-	//	utils.Error(w, "Something went wrong.", http.StatusBadRequest, errors.Wrapf(err, "failed to parse parameters for %s", r.URL.String()))
-	//	return
-	// }
+	// scope is only used to see if the user passes any illegal value, verbose is not used but implemented
+	// for compatibility purposes only.
+	query := struct {
+		scope   string `schema:"scope"`
+		verbose bool   `schema:"verbose"`
+	}{
+		scope: "local",
+	}
+	decoder := r.Context().Value("decoder").(*schema.Decoder)
+	if err := decoder.Decode(&query, r.URL.Query()); err != nil {
+		utils.Error(w, "Something went wrong.", http.StatusBadRequest, errors.Wrapf(err, "failed to parse parameters for %s", r.URL.String()))
+		return
+	}
+
+	if query.scope != "local" {
+		utils.Error(w, "Invalid scope value. Can only be local.", http.StatusBadRequest, define.ErrInvalidArg)
+		return
+	}
 	config, err := runtime.GetConfig()
 	if err != nil {
 		utils.InternalServerError(w, err)
diff --git a/pkg/api/server/register_networks.go b/pkg/api/server/register_networks.go
index 4d9806316..9b2e187b2 100644
--- a/pkg/api/server/register_networks.go
+++ b/pkg/api/server/register_networks.go
@@ -44,6 +44,16 @@ func (s *APIServer) registerNetworkHandlers(r *mux.Router) error {
 	//    type: string
 	//    required: true
 	//    description: the name of the network
+	//  - in: query
+	//    name: verbose
+	//    type: boolean
+	//    required: false
+	//    description: Detailed inspect output for troubleshooting
+	//  - in: query
+	//    name: scope
+	//    type: string
+	//    required: false
+	//    description: Filter the network by scope (swarm, global, or local)
 	// produces:
 	// - application/json
 	// responses:
-- 
cgit v1.2.3-54-g00ecf