Update API definitions for AI subscription policies

Update admin and internal API definitions to include AI subscription policies related DTOs

modules/integration/tests-common/clients/admin/.openapi-generator/admin-api.yaml.sha256

@@ -1 +1 @@
-cca415b078e76654cef5d2b0ec616e8e322a3b7607e6a4a14b545c200ad7ec97
+107551f176df23e9935ec5689c024391825a72c2eaf11e3879bdf11d77401eeb

modules/integration/tests-common/clients/admin/api/openapi.yaml

@@ -8147,6 +8147,7 @@ components:
  - REQUESTCOUNTLIMIT
  - BANDWIDTHLIMIT
  - EVENTCOUNTLIMIT
+ - AIQUOTALIMIT
  example: REQUESTCOUNTLIMIT
  type: string
  requestCount:
@@ -8155,6 +8156,8 @@ components:
  $ref: '#/components/schemas/BandwidthLimit'
  eventCount:
  $ref: '#/components/schemas/EventCountLimit'
+ aiQuota:
+ $ref: '#/components/schemas/AIQuotaLimit'
  required:
  - type
  title: Throttle Limit
@@ -8200,6 +8203,11 @@ components:
  - $ref: '#/components/schemas/ThrottleLimitBase'
  - $ref: '#/components/schemas/RequestCountLimit_allOf'
  title: Request Count Limit object
+ AIQuotaLimit:
+ allOf:
+ - $ref: '#/components/schemas/ThrottleLimitBase'
+ - $ref: '#/components/schemas/AIQuotaLimit_allOf'
+ title: AI Quota Limit object
  EventCountLimit:
  allOf:
  - $ref: '#/components/schemas/ThrottleLimitBase'
@@ -10025,6 +10033,30 @@ components:
  type: integer
  required:
  - requestCount
+ AIQuotaLimit_allOf:
+ properties:
+ requestCount:
+ description: Maximum number of requests allowed
+ example: 30
+ format: int64
+ type: integer
+ totalTokenCount:
+ description: Maximum number of total tokens allowed
+ example: 1000
+ format: int64
+ type: integer
+ requestTokenCount:
+ description: Maximum number of request tokens allowed
+ example: 300
+ format: int64
+ type: integer
+ responseTokenCount:
+ description: Maximum number of response tokens allowed
+ example: 300
+ format: int64
+ type: integer
+ required:
+ - requestCount
  EventCountLimit_allOf:
  properties:
  eventCount:

modules/integration/tests-common/clients/admin/src/gen/java/org/wso2/am/integration/clients/admin/api/dto/AIQuotaLimitAllOfDTO.java

@@ -0,0 +1,185 @@
+/*
+ * WSO2 API Manager - Admin
+ * This document specifies a **RESTful API** for WSO2 **API Manager** - **Admin Portal**. Please see [full OpenAPI Specification](https://raw.githubusercontent.com/wso2/carbon-apimgt/v6.7.206/components/apimgt/org.wso2.carbon.apimgt.rest.api.admin.v1/src/main/resources/admin-api.yaml) of the API which is written using [OAS 3.0](http://swagger.io/) specification. # Authentication Our REST APIs are protected using OAuth2 and access control is achieved through scopes. Before you start invoking the the API you need to obtain an access token with the required scopes. This guide will walk you through the steps that you will need to follow to obtain an access token. First you need to obtain the consumer key/secret key pair by calling the dynamic client registration (DCR) endpoint. You can add your preferred grant types in the payload. A sample payload is shown below. ``` { \"callbackUrl\":\"www.google.lk\", \"clientName\":\"rest_api_admin\", \"owner\":\"admin\", \"grantType\":\"client_credentials password refresh_token\", \"saasApp\":true } ``` Create a file (payload.json) with the above sample payload, and use the cURL shown bellow to invoke the DCR endpoint. Authorization header of this should contain the base64 encoded admin username and password. **Format of the request** ``` curl -X POST -H \"Authorization: Basic Base64(admin_username:admin_password)\" -H \"Content-Type: application/json\" \\ -d @payload.json https://<host>:<servlet_port>/client-registration/v0.17/register ``` **Sample request** ``` curl -X POST -H \"Authorization: Basic YWRtaW46YWRtaW4=\" -H \"Content-Type: application/json\" \\ -d @payload.json https://localhost:9443/client-registration/v0.17/register ``` Following is a sample response after invoking the above curl. ``` { \"clientId\": \"fOCi4vNJ59PpHucC2CAYfYuADdMa\", \"clientName\": \"rest_api_admin\", \"callBackURL\": \"www.google.lk\", \"clientSecret\": \"a4FwHlq0iCIKVs2MPIIDnepZnYMa\", \"isSaasApplication\": true, \"appOwner\": \"admin\", \"jsonString\": \"{\\\"grant_types\\\":\\\"client_credentials password refresh_token\\\",\\\"redirect_uris\\\":\\\"www.google.lk\\\",\\\"client_name\\\":\\\"rest_api_admin\\\"}\", \"jsonAppAttribute\": \"{}\", \"tokenType\": null } ``` Next you must use the above client id and secret to obtain the access token. We will be using the password grant type for this, you can use any grant type you desire. You also need to add the proper **scope** when getting the access token. All possible scopes for Admin REST API can be viewed in **OAuth2 Security** section of this document and scope for each resource is given in **authorizations** section of resource documentation. Following is the format of the request if you are using the password grant type. ``` curl -k -d \"grant_type=password&username=<admin_username>&password=<admin_passowrd>&scope=<scopes seperated by space>\" \\ -H \"Authorization: Basic base64(cliet_id:client_secret)\" \\ https://<host>:<gateway_port>/token ``` **Sample request** ``` curl https://localhost:8243/token -k \\ -H \"Authorization: Basic Zk9DaTR2Tko1OVBwSHVjQzJDQVlmWXVBRGRNYTphNEZ3SGxxMGlDSUtWczJNUElJRG5lcFpuWU1h\" \\ -d \"grant_type=password&username=admin&password=admin&scope=apim:admin apim:tier_view\" ``` Shown below is a sample response to the above request. ``` { \"access_token\": \"e79bda48-3406-3178-acce-f6e4dbdcbb12\", \"refresh_token\": \"a757795d-e69f-38b8-bd85-9aded677a97c\", \"scope\": \"apim:admin apim:tier_view\", \"token_type\": \"Bearer\", \"expires_in\": 3600 } ``` Now you have a valid access token, which you can use to invoke an API. Navigate through the API descriptions to find the required API, obtain an access token as described above and invoke the API with the authentication header. If you use a different authentication mechanism, this process may change. # Try out in Postman If you want to try-out the embedded postman collection with \"Run in Postman\" option, please follow the guidelines listed below. * All of the OAuth2 secured endpoints have been configured with an Authorization Bearer header with a parameterized access token. Before invoking any REST API resource make sure you run the `Register DCR Application` and `Generate Access Token` requests to fetch an access token with all required scopes. * Make sure you have an API Manager instance up and running. * Update the `basepath` parameter to match the hostname and port of the APIM instance. [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/f5ac2ca9fb22afef6ed6) 
+ *
+ * The version of the OpenAPI document: v4
+ * Contact: architecture@wso2.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+package org.wso2.am.integration.clients.admin.api.dto;
+
+import java.util.Objects;
+import java.util.Arrays;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+import java.io.IOException;
+import com.fasterxml.jackson.annotation.JsonCreator;
+/**
+* AIQuotaLimitAllOfDTO
+*/
+
+public class AIQuotaLimitAllOfDTO {
+ public static final String SERIALIZED_NAME_REQUEST_COUNT = "requestCount";
+ @SerializedName(SERIALIZED_NAME_REQUEST_COUNT)
+ private Long requestCount;
+
+ public static final String SERIALIZED_NAME_TOTAL_TOKEN_COUNT = "totalTokenCount";
+ @SerializedName(SERIALIZED_NAME_TOTAL_TOKEN_COUNT)
+ private Long totalTokenCount;
+
+ public static final String SERIALIZED_NAME_REQUEST_TOKEN_COUNT = "requestTokenCount";
+ @SerializedName(SERIALIZED_NAME_REQUEST_TOKEN_COUNT)
+ private Long requestTokenCount;
+
+ public static final String SERIALIZED_NAME_RESPONSE_TOKEN_COUNT = "responseTokenCount";
+ @SerializedName(SERIALIZED_NAME_RESPONSE_TOKEN_COUNT)
+ private Long responseTokenCount;
+
+
+ public AIQuotaLimitAllOfDTO requestCount(Long requestCount) {
+
+ this.requestCount = requestCount;
+ return this;
+ }
+
+ /**
+ * Maximum number of requests allowed
+ * @return requestCount
+ **/
+ @ApiModelProperty(example = "30", required = true, value = "Maximum number of requests allowed")
+
+ public Long getRequestCount() {
+ return requestCount;
+ }
+
+
+ public void setRequestCount(Long requestCount) {
+ this.requestCount = requestCount;
+ }
+
+
+ public AIQuotaLimitAllOfDTO totalTokenCount(Long totalTokenCount) {
+
+ this.totalTokenCount = totalTokenCount;
+ return this;
+ }
+
+ /**
+ * Maximum number of total tokens allowed
+ * @return totalTokenCount
+ **/
+ @javax.annotation.Nullable
+ @ApiModelProperty(example = "1000", value = "Maximum number of total tokens allowed")
+
+ public Long getTotalTokenCount() {
+ return totalTokenCount;
+ }
+
+
+ public void setTotalTokenCount(Long totalTokenCount) {
+ this.totalTokenCount = totalTokenCount;
+ }
+
+
+ public AIQuotaLimitAllOfDTO requestTokenCount(Long requestTokenCount) {
+
+ this.requestTokenCount = requestTokenCount;
+ return this;
+ }
+
+ /**
+ * Maximum number of request tokens allowed
+ * @return requestTokenCount
+ **/
+ @javax.annotation.Nullable
+ @ApiModelProperty(example = "300", value = "Maximum number of request tokens allowed")
+
+ public Long getRequestTokenCount() {
+ return requestTokenCount;
+ }
+
+
+ public void setRequestTokenCount(Long requestTokenCount) {
+ this.requestTokenCount = requestTokenCount;
+ }
+
+
+ public AIQuotaLimitAllOfDTO responseTokenCount(Long responseTokenCount) {
+
+ this.responseTokenCount = responseTokenCount;
+ return this;
+ }
+
+ /**
+ * Maximum number of response tokens allowed
+ * @return responseTokenCount
+ **/
+ @javax.annotation.Nullable
+ @ApiModelProperty(example = "300", value = "Maximum number of response tokens allowed")
+
+ public Long getResponseTokenCount() {
+ return responseTokenCount;
+ }
+
+
+ public void setResponseTokenCount(Long responseTokenCount) {
+ this.responseTokenCount = responseTokenCount;
+ }
+
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }
+ AIQuotaLimitAllOfDTO aiQuotaLimitAllOf = (AIQuotaLimitAllOfDTO) o;
+ return Objects.equals(this.requestCount, aiQuotaLimitAllOf.requestCount) &&
+ Objects.equals(this.totalTokenCount, aiQuotaLimitAllOf.totalTokenCount) &&
+ Objects.equals(this.requestTokenCount, aiQuotaLimitAllOf.requestTokenCount) &&
+ Objects.equals(this.responseTokenCount, aiQuotaLimitAllOf.responseTokenCount);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(requestCount, totalTokenCount, requestTokenCount, responseTokenCount);
+ }
+
+
+@Override
+public String toString() {
+StringBuilder sb = new StringBuilder();
+sb.append("class AIQuotaLimitAllOfDTO {\n");
+ sb.append(" requestCount: ").append(toIndentedString(requestCount)).append("\n");
+ sb.append(" totalTokenCount: ").append(toIndentedString(totalTokenCount)).append("\n");
+ sb.append(" requestTokenCount: ").append(toIndentedString(requestTokenCount)).append("\n");
+ sb.append(" responseTokenCount: ").append(toIndentedString(responseTokenCount)).append("\n");
+sb.append("}");
+return sb.toString();
+}
+
+/**
+* Convert the given object to string with each line indented by 4 spaces
+* (except the first line).
+*/
+private String toIndentedString(Object o) {
+if (o == null) {
+return "null";
+}
+return o.toString().replace("\n", "\n ");
+}
+
+}
+