feat: document args/options schemas, fixes #157

danielgtaylor · Aug 4, 2023 · 6b1980e · 6b1980e
1 parent 6b9ecae
commit 6b1980e
Show file tree

Hide file tree

Showing 5 changed files with 93 additions and 0 deletions.
diff --git a/openapi/openapi.go b/openapi/openapi.go
@@ -199,8 +199,19 @@ func getRequestInfo(op *v3.Operation) (string, *base.Schema, []interface{}) {
 	return "", nil, nil
 }
 
+// paramSchema returns a rendered schema line for a given parameter, falling
+// back to the param type info if no schema is available.
+func paramSchema(p *cli.Param, s *base.Schema) string {
+	schemaDesc := fmt.Sprintf("(%s): %s", p.Type, p.Description)
+	if s != nil {
+		schemaDesc = renderSchema(s, "  ", modeWrite)
+	}
+	return schemaDesc
+}
+
 func openapiOperation(cmd *cobra.Command, method string, uriTemplate *url.URL, path *v3.PathItem, op *v3.Operation) cli.Operation {
 	var pathParams, queryParams, headerParams []*cli.Param
+	var pathSchemas, querySchemas, headerSchemas []*base.Schema = []*base.Schema{}, []*base.Schema{}, []*base.Schema{}
 
 	// Combine path and operation parameters, with operation params having
 	// precedence when there are name conflicts.
@@ -225,8 +236,10 @@ func openapiOperation(cmd *cobra.Command, method string, uriTemplate *url.URL, p
 		var example interface{}
 
 		typ := "string"
+		var schema *base.Schema
 		if p.Schema != nil && p.Schema.Schema() != nil {
 			s := p.Schema.Schema()
+			schema = s
 			if len(s.Type) > 0 {
 				// TODO: support params of multiple types?
 				typ = s.Type[0]
@@ -277,16 +290,19 @@ func openapiOperation(cmd *cobra.Command, method string, uriTemplate *url.URL, p
 				pathParams = []*cli.Param{}
 			}
 			pathParams = append(pathParams, param)
+			pathSchemas = append(pathSchemas, schema)
 		case "query":
 			if queryParams == nil {
 				queryParams = []*cli.Param{}
 			}
 			queryParams = append(queryParams, param)
+			querySchemas = append(querySchemas, schema)
 		case "header":
 			if headerParams == nil {
 				headerParams = []*cli.Param{}
 			}
 			headerParams = append(headerParams, param)
+			headerSchemas = append(headerSchemas, schema)
 		}
 	}
 
@@ -305,6 +321,25 @@ func openapiOperation(cmd *cobra.Command, method string, uriTemplate *url.URL, p
 	desc := getExt(op.Extensions, ExtDescription, op.Description)
 	hidden := getExt(op.Extensions, ExtHidden, false)
 
+	if len(pathParams) > 0 {
+		desc += "\n## Argument Schema:\n```schema\n{\n"
+		for i, p := range pathParams {
+			desc += "  " + p.OptionName() + ": " + paramSchema(p, pathSchemas[i]) + "\n"
+		}
+		desc += "}\n```\n"
+	}
+
+	if len(queryParams) > 0 || len(headerParams) > 0 {
+		desc += "\n## Option Schema:\n```schema\n{\n"
+		for i, p := range queryParams {
+			desc += "  --" + p.OptionName() + ": " + paramSchema(p, querySchemas[i]) + "\n"
+		}
+		for i, p := range headerParams {
+			desc += "  --" + p.OptionName() + ": " + paramSchema(p, headerSchemas[i]) + "\n"
+		}
+		desc += "}\n```\n"
+	}
+
 	mediaType := ""
 	var examples []string
 	if op.RequestBody != nil {

diff --git a/openapi/testdata/extensions/output.yaml b/openapi/testdata/extensions/output.yaml
@@ -7,6 +7,22 @@ operations:
       - gi
     short: ""
     long: |
+      ## Argument Schema:
+      ```schema
+      {
+        item-id: (string)
+      }
+      ```
+
+      ## Option Schema:
+      ```schema
+      {
+        --query: [
+          (string)
+        ]
+      }
+      ```
+
       ## Response 200 (application/json)
 
       CLI-specific description override

diff --git a/openapi/testdata/long_example/output.yaml b/openapi/testdata/long_example/output.yaml
@@ -4,6 +4,13 @@ operations:
     aliases: []
     short: ""
     long: |
+      ## Argument Schema:
+      ```schema
+      {
+        item-id: (string)
+      }
+      ```
+
       ## Input Example
 
       ```json

diff --git a/openapi/testdata/petstore/output.yaml b/openapi/testdata/petstore/output.yaml
@@ -28,6 +28,13 @@ operations:
       - listpets
     short: List all pets
     long: |
+      ## Option Schema:
+      ```schema
+      {
+        --limit: (integer format:int32)
+      }
+      ```
+
       ## Response 200 (application/json)
 
       A paged array of pets
@@ -66,6 +73,13 @@ operations:
       - showpetbyid
     short: Info for a specific pet
     long: |
+      ## Argument Schema:
+      ```schema
+      {
+        pet-id: (string)
+      }
+      ```
+
       ## Response 200 (application/json)
 
       Expected response to a valid request

diff --git a/openapi/testdata/request/output.yaml b/openapi/testdata/request/output.yaml
@@ -4,6 +4,13 @@ operations:
     aliases: []
     short: ""
     long: |
+      ## Argument Schema:
+      ```schema
+      {
+        item-id: (string)
+      }
+      ```
+
       ## Response 204
 
       Response has no body
@@ -16,6 +23,20 @@ operations:
     aliases: []
     short: ""
     long: |
+      ## Argument Schema:
+      ```schema
+      {
+        item-id: (string)
+      }
+      ```
+
+      ## Option Schema:
+      ```schema
+      {
+        --my-header: (string)
+      }
+      ```
+
       ## Input Example
 
       ```json