Merge pull request #563 from snyk/feat/allow-beta-endpoints-in-docs

feat: allow beta endpoints in docs

Author: acaprar

tools/api-docs-generator/generator/reference_docs.go

@@ -152,10 +152,6 @@ func processOperation(pathURL string,
 			}
 		}
 
-		if isBeta(operation) {
-			continue
-		}
-
 		tag += spec.Suffix
 		specDocs[tag] = append(specDocs[tag], operationPath{
 			operation: operation,
@@ -169,18 +165,6 @@ func processOperation(pathURL string,
 	return nil
 }
 
-func isBeta(operation *openapi3.Operation) bool {
-	apiStabilityExtension, ok := operation.Extensions["x-snyk-api-stability"]
-	if !ok || apiStabilityExtension == nil {
-		return false
-	}
-	stabilityStr, ok := apiStabilityExtension.(string)
-	if !ok {
-		return false
-	}
-	return stabilityStr == "beta"
-}
-
 func extractCategoryNameFromExtension(extension interface{}) (string, error) {
 	extensionMap, worked := extension.(map[string]interface{})
 	if !worked {

tools/api-docs-generator/generator/reference_docs_test.go

@@ -294,36 +294,6 @@ func Test_aggregateSpecs(t *testing.T) {
 			},
 			wantErr: assert.NoError,
 		},
-		{
-			name: "filters out beta paths",
-			args: args{
-				cfg: &config.Config{
-					Specs: []config.Spec{
-						{
-							Path: "spec_with_stability.yaml",
-						},
-					},
-				},
-				docsBasePath: "../testdata/reference_docs/",
-			},
-			want: map[string][]operationPath{
-				"stable": {
-					{
-						method:   "GET",
-						specPath: "spec_with_stability.yaml",
-						pathURL:  "/stable-path",
-					},
-				},
-				"no-stability": {
-					{
-						method:   "GET",
-						specPath: "spec_with_stability.yaml",
-						pathURL:  "/no-stability-path",
-					},
-				},
-			},
-			wantErr: assert.NoError,
-		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {