Merge pull request #138 from danielgtaylor/deprecated

feat: mark & hide deprecated operations
danielgtaylor · Nov 3, 2022 · e054065 · e054065
2 parents 0d2eae2 + 3cde380
commit e054065
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/cli/operation.go b/cli/operation.go
@@ -28,6 +28,7 @@ type Operation struct {
 	BodyMediaType string   `json:"bodyMediaType,omitempty"`
 	Examples      []string `json:"examples,omitempty"`
 	Hidden        bool     `json:"hidden,omitempty"`
+	Deprecated    string   `json:"deprecated,omitempty"`
 }
 
 // command returns a Cobra command instance for this operation.
@@ -52,14 +53,15 @@ func (o Operation) command() *cobra.Command {
 	}
 
 	sub := &cobra.Command{
-		Use:     use,
-		GroupID: o.Group,
-		Aliases: o.Aliases,
-		Short:   o.Short,
-		Long:    long,
-		Example: examples,
-		Args:    argSpec,
-		Hidden:  o.Hidden,
+		Use:        use,
+		GroupID:    o.Group,
+		Aliases:    o.Aliases,
+		Short:      o.Short,
+		Long:       long,
+		Example:    examples,
+		Args:       argSpec,
+		Hidden:     o.Hidden,
+		Deprecated: o.Deprecated,
 		Run: func(cmd *cobra.Command, args []string) {
 			uri := o.URITemplate
 

diff --git a/openapi/openapi.go b/openapi/openapi.go
@@ -340,6 +340,11 @@ func openapiOperation(cmd *cobra.Command, method string, uriTemplate *url.URL, p
 		group = op.Tags[0]
 	}
 
+	dep := ""
+	if op.Deprecated {
+		dep = "do not use"
+	}
+
 	return cli.Operation{
 		Name:          name,
 		Group:         group,
@@ -354,6 +359,7 @@ func openapiOperation(cmd *cobra.Command, method string, uriTemplate *url.URL, p
 		BodyMediaType: mediaType,
 		Examples:      examples,
 		Hidden:        hidden,
+		Deprecated:    dep,
 	}
 }