Skip to content

feat(apim cache): Add default caching type to cache policies #927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hemalshah-gradientedge merged 3 commits into from
Nov 19, 2025
Merged

feat(apim cache): Add default caching type to cache policies #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edaf255
feat(apim cache): Add default caching type to cache policies
hemalshah-gradientedge Nov 19, 2025
5a5af83
feat(apim cache): Add default caching type to cache policies
hemalshah-gradientedge Nov 19, 2025
a215e28
feat(apim cache): Add default caching type to cache policies
hemalshah-gradientedge Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/lib/azure/services/api-management/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ export class AzureApiManagementManager {
cacheSetInboundPolicy = `<choose>
<when condition="@((string)context.Variables["bypassCache"] != "true")">
<!-- Attempt to retrieve cached response -->
<cache-lookup-value key="@((string)context.Variables["customCacheKey"])" variable-name="cachedResponse" />
<cache-lookup-value key="@((string)context.Variables["customCacheKey"])" variable-name="cachedResponse" caching-type="${operation.caching.cachingType || 'prefer-external'}" />

<!-- If cache hit, return cached response -->
<choose>
Expand All @@ -288,13 +288,13 @@ export class AzureApiManagementManager {
</choose>
</when>
<when condition="@((string)context.Variables["bypassCache"] == "true")">
<cache-remove-value key="@((string)context.Variables["customCacheKey"])" />
<cache-remove-value key="@((string)context.Variables["customCacheKey"])" caching-type="${operation.caching.cachingType || 'prefer-external'}" />
</when>
</choose>`
cacheSetOutboundPolicy = `<!-- Store the response body in cache -->
<choose>
<when condition="@(context.Response.StatusCode == 200)">
<cache-store-value key="@((string)context.Variables["customCacheKey"])" value="@(context.Response.Body.As<string>(preserveContent: true))" duration="${operation.caching.ttlInSecs ?? 900}" />
<cache-store-value key="@((string)context.Variables["customCacheKey"])" value="@(context.Response.Body.As<string>(preserveContent: true))" duration="${operation.caching.ttlInSecs ?? 900}" caching-type="${operation.caching.cachingType || 'prefer-external'}" />
<!-- Add cache status header -->
<set-header name="X-Apim-Cache-Status" exists-action="override">
<value>MISS</value>
Expand All @@ -315,7 +315,7 @@ export class AzureApiManagementManager {
<!-- Allow admin to clear specific cache entries -->
<choose>
<when condition="@((string)context.Variables["clearCache"] == "true")">
<cache-remove-value key="@((string)context.Variables["customCacheKey"])" />
<cache-remove-value key="@((string)context.Variables["customCacheKey"])" caching-type="${operation.caching.cachingType || 'prefer-external'}" />
<return-response>
<set-status code="200" reason="OK" />
<set-body>Cache entry removed successfully</set-body>
Expand Down
1 change: 1 addition & 0 deletions src/lib/azure/services/api-management/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface ApiManagementApiCaching {
enableCacheSet?: boolean
enableCacheInvalidation?: boolean
ttlInSecs?: number
cachingType?: string
}

export interface ApiManagementApiRateLimit {
Expand Down
Loading