Add x-internal

README.md

@@ -98,6 +98,9 @@ fizz.InputModel(model interface{})
 
 // Add a Code Sample to the operation.
 fizz.XCodeSample(codeSample *XCodeSample)
+
+// Mark the operation as internal or external.
+fizz.XInternal(isInternal bool)
 ```
 
 **NOTES:**

fizz.go

@@ -360,6 +360,13 @@ func XCodeSample(cs *openapi.XCodeSample) func(*openapi.OperationInfo) {
 	}
 }
 
+// XInternal marks the operation as internal or external.
+func XInternal(isInternal bool) func(*openapi.OperationInfo) {
+	return func(o *openapi.OperationInfo) {
+		o.XInternal = isInternal
+	}
+}
+
 // OperationFromContext returns the OpenAPI operation from
 // the givent Gin context or an error if none is found.
 func OperationFromContext(c *gin.Context) (*openapi.Operation, error) {

fizz_test.go

@@ -271,6 +271,7 @@ func TestSpecHandler(t *testing.T) {
 				Label:  "v4.4",
 				Source: "curl http://0.0.0.0:8080",
 			}),
+			XInternal(true),
 		},
 		tonic.Handler(func(c *gin.Context) error {
 			return nil

openapi/generator.go

@@ -251,6 +251,7 @@ func (g *Generator) AddOperation(path, method, tag string, in, out reflect.Type,
 		op.Deprecated = info.Deprecated
 		op.Responses = make(Responses)
 		op.XCodeSamples = info.XCodeSamples
+		op.XInternal = info.XInternal
 	}
 	if tag != "" {
 		op.Tags = append(op.Tags, tag)

openapi/operation.go

@@ -13,6 +13,7 @@ type OperationInfo struct {
 	InputModel        interface{}
 	Responses         []*OperationResponse
 	XCodeSamples      []*XCodeSample
+	XInternal         bool
 }
 
 // ResponseHeader represents a single header that

openapi/spec.go

@@ -194,6 +194,7 @@ type Operation struct {
 	Deprecated   bool              `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
 	Servers      []*Server         `json:"servers,omitempty" yaml:"servers,omitempty"`
 	XCodeSamples []*XCodeSample    `json:"x-codeSamples,omitempty" yaml:"x-codeSamples,omitempty"`
+	XInternal    bool              `json:"x-internal,omitempty" yaml:"x-internal,omitempty"`
 }
 
 // Responses represents a container for the expected responses

testdata/spec.json

@@ -94,7 +94,8 @@
                         "label":"v4.4",
                         "source":"curl http://0.0.0.0:8080"
                     }
-                ]
+                ],
+                "x-internal": true
             }
         },
         "/test/{a}/{b}": {

testdata/spec.yaml

@@ -63,6 +63,7 @@ paths:
         - lang: Shell
           label: v4.4
           source: curl http://0.0.0.0:8080
+      x-internal: true
   /test/{a}/{b}:
     get:
       operationId: GetTest2