Merging to release-5.2: [TT-10358] Add fallback to default version OA…

…S support (#5679) [TT-10358] Add fallback to default version OAS support (#5679) parent ticket: https://tyktech.atlassian.net/browse/TT-9901 subticket: https://tyktech.atlassian.net/browse/TT-10358
TykTechnologies · Oct 30, 2023 · d11a5c5 · d11a5c5
1 parent 3df352b
commit d11a5c5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/apidef/oas/oas_test.go b/apidef/oas/oas_test.go
@@ -188,7 +188,6 @@ func TestOAS_ExtractTo_ResetAPIDefinition(t *testing.T) {
 		"APIDefinition.RequestSigning.HeaderList[0]",
 		"APIDefinition.RequestSigning.CertificateId",
 		"APIDefinition.RequestSigning.SignatureHeader",
-		"APIDefinition.VersionDefinition.FallbackToDefault",
 		"APIDefinition.VersionData.Versions[0].ExtendedPaths.TransformJQ[0].Filter",
 		"APIDefinition.VersionData.Versions[0].ExtendedPaths.TransformJQ[0].Path",
 		"APIDefinition.VersionData.Versions[0].ExtendedPaths.TransformJQ[0].Method",

diff --git a/apidef/oas/root.go b/apidef/oas/root.go
@@ -167,6 +167,10 @@ type Versioning struct {
 	Versions []VersionToID `bson:"versions" json:"versions"` // required
 	// StripVersioningData is a boolean flag, if set to `true`, the API responses will be stripped of versioning data.
 	StripVersioningData bool `bson:"stripVersioningData,omitempty" json:"stripVersioningData,omitempty"`
+	// FallbackToDefault controls the behaviour of Tyk when a versioned API is called with a nonexistent version name.
+	// If set to `true` then the default API version will be invoked; if set to `false` Tyk will return an HTTP 404
+	// `This API version does not seem to exist` error in this scenario.
+	FallbackToDefault bool `bson:"fallbackToDefault,omitempty" json:"fallbackToDefault,omitempty"`
 }
 
 // Fill fills *Versioning from apidef.APIDefinition.
@@ -190,6 +194,7 @@ func (v *Versioning) Fill(api apidef.APIDefinition) {
 	}
 
 	v.StripVersioningData = api.VersionDefinition.StripVersioningData
+	v.FallbackToDefault = api.VersionDefinition.FallbackToDefault
 }
 
 // ExtractTo extracts *Versioning into *apidef.APIDefinition.
@@ -210,6 +215,7 @@ func (v *Versioning) ExtractTo(api *apidef.APIDefinition) {
 	}
 
 	api.VersionDefinition.StripVersioningData = v.StripVersioningData
+	api.VersionDefinition.FallbackToDefault = v.FallbackToDefault
 }
 
 // VersionToID contains a single mapping from a version name into an API ID.

diff --git a/apidef/oas/schema/x-tyk-gateway.md b/apidef/oas/schema/x-tyk-gateway.md
@@ -88,6 +88,10 @@ Versions contains a list of versions that map to individual API IDs.
 **Field: `stripVersioningData` (`boolean`)**
 StripVersioningData is a boolean flag, if set to `true`, the API responses will be stripped of versioning data.
 
+**Field: `fallbackToDefault` (`boolean`)**
+FallbackToDefault controls the behaviour of Tyk when a versioned API is called with a nonexistent version name.
+If set to `true` then the default API version will be invoked; if set to `false` Tyk will return an HTTP 404 `This API version does not seem to exist` error in this scenario.
+
 
 ### **VersionToID**