Add REST API Changes to Support Token Based Subscription Policies

[SavinduDimal]

Purpose

• Resolves Introduce AI-specific (Token-based) Policy Creation - Admin API api-manager#3074
• Update existing admin REST APIs for token based subscription policies.
• Update internal service REST APIs for token based subscription policies.

Description

• In order to support token based subscription policies, this PR introduces a new default limit type AIQUOTALIMIT.
• A sample payload for adding new subscription policy is given below.

{
    "policyName": "sampleAISubscriptionPolicy",
    "description": "Test AI subscription policy",
    "defaultLimit": {
        "type": "AIQUOTALIMIT",
        "aiQuota": {
            "requestCount": "40",
            "totalTokenCount": "1000",
            "requestTokenCount": "300",
            "responseTokenCount": "400",
            "timeUnit": "min",
            "unitTime": "1"
        }
    },
    "subscriberCount": 0,
    "rateLimitCount": "30",
    "rateLimitTimeUnit": "sec",
    "billingPlan": "FREE",
    "stopOnQuotaReach": true,
    "customAttributes": [],
    "graphQLMaxComplexity": 0,
    "graphQLMaxDepth": 0,
    "monetization": {
        "monetizationPlan": "FIXEDRATE",
        "properties": {
            "fixedPrice": "",
            "pricePerRequest": "",
            "currencyType": "",
            "billingCycle": "week"
        }
    },
    "permissions": null
}

• When adding a new subscription policy with type AIQUOTALIMIT,

  • requestCount is the only quota that is mandatory. The default value for token count quotas are set to 0.

• When updating an existing subscription policy with type AIQUOTALIMIT,

  • defaultType can not be changed to AIQUOTALIMIT or from AIQUOTALIMIT.
  • if token count quotas are not given in the request the existing values will not be updated.

• Please note that Siddhi template given in this PR is subject to change.

• We need to implement org.wso2.carbon.apimgt.impl.utils.APIUtil#getTiersFromPolicies and org.wso2.carbon.apimgt.impl.utils.APIUtil#getPolicyByName according to the requirements in the publisher portal and developer portal.

[SavinduDimal]

Following tests failures will be fixed by PR: wso2/product-apim#13526

2024-09-03T10:02:22.7525403Z [ERROR] Failures: 
2024-09-03T10:02:22.7527145Z [ERROR] org.wso2.am.integration.tests.restapi.admin.throttlingpolicy.ThrottlePolicyExportImportTestCase.testAdvancedThrottlePolicyExport
2024-09-03T10:02:22.7529918Z [ERROR]   Run 1: ThrottlePolicyExportImportTestCase.testAdvancedThrottlePolicyExport:361 » IllegalArgument
2024-09-03T10:02:22.7531670Z [ERROR]   Run 2: ThrottlePolicyExportImportTestCase.testAdvancedThrottlePolicyExport:361 » IllegalArgument
2024-09-03T10:02:22.7532628Z [INFO] 
2024-09-03T10:02:22.7534006Z [ERROR] org.wso2.am.integration.tests.restapi.admin.throttlingpolicy.ThrottlePolicyExportImportTestCase.testApplicationThrottlePolicyExport
2024-09-03T10:02:22.7536496Z [ERROR]   Run 1: ThrottlePolicyExportImportTestCase.testApplicationThrottlePolicyExport:333 » IllegalArgument
2024-09-03T10:02:22.7538692Z [ERROR]   Run 2: ThrottlePolicyExportImportTestCase.testApplicationThrottlePolicyExport:333 » IllegalArgument
2024-09-03T10:02:22.7539878Z [INFO] 
2024-09-03T10:02:22.7541634Z [ERROR] org.wso2.am.integration.tests.restapi.admin.throttlingpolicy.ThrottlePolicyExportImportTestCase.testSubscriptionThrottlePolicyExport
2024-09-03T10:02:22.7544747Z [ERROR]   Run 1: ThrottlePolicyExportImportTestCase.testSubscriptionThrottlePolicyExport:305 » IllegalArgument
2024-09-03T10:02:22.7546967Z [ERROR]   Run 2: ThrottlePolicyExportImportTestCase.testSubscriptionThrottlePolicyExport:305 » IllegalArgument