org.wso2.carbon.apimgt.rest.integration.tests.publisher.api

Class APICollectionApi

java.lang.Object

org.wso2.carbon.apimgt.rest.integration.tests.publisher.api.APICollectionApi

public class APICollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
APICollectionApi()
APICollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
APIList	apisGet(Integer limit, Integer offset, String query, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
com.squareup.okhttp.Call	apisGetAsync(Integer limit, Integer offset, String query, String ifNoneMatch, ApiCallback<APIList> callback) Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition.
com.squareup.okhttp.Call	apisGetCall(Integer limit, Integer offset, String query, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisGet
ApiResponse<APIList>	apisGetWithHttpInfo(Integer limit, Integer offset, String query, String ifNoneMatch) Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition.
void	apisHead(String query, String ifNoneMatch) Check given API attibute name is already exist Using this operation, you can check a given API context is already used.
com.squareup.okhttp.Call	apisHeadAsync(String query, String ifNoneMatch, ApiCallback<Void> callback) Check given API attibute name is already exist (asynchronously) Using this operation, you can check a given API context is already used.
com.squareup.okhttp.Call	apisHeadCall(String query, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisHead
ApiResponse<Void>	apisHeadWithHttpInfo(String query, String ifNoneMatch) Check given API attibute name is already exist Using this operation, you can check a given API context is already used.
API	apisImportDefinitionPost(String type, File file, String url, String additionalProperties, String implementationType, String ifMatch, String ifUnmodifiedSince) Import API Definition This operation can be used to create api from api definition.
com.squareup.okhttp.Call	apisImportDefinitionPostAsync(String type, File file, String url, String additionalProperties, String implementationType, String ifMatch, String ifUnmodifiedSince, ApiCallback<API> callback) Import API Definition (asynchronously) This operation can be used to create api from api definition.
com.squareup.okhttp.Call	apisImportDefinitionPostCall(String type, File file, String url, String additionalProperties, String implementationType, String ifMatch, String ifUnmodifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisImportDefinitionPost
ApiResponse<API>	apisImportDefinitionPostWithHttpInfo(String type, File file, String url, String additionalProperties, String implementationType, String ifMatch, String ifUnmodifiedSince) Import API Definition This operation can be used to create api from api definition.
API	apisPost(API body) Create a new API This operation can be used to create a new API specifying the details of the API in the payload.
com.squareup.okhttp.Call	apisPostAsync(API body, ApiCallback<API> callback) Create a new API (asynchronously) This operation can be used to create a new API specifying the details of the API in the payload.
com.squareup.okhttp.Call	apisPostCall(API body, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisPost
ApiResponse<API>	apisPostWithHttpInfo(API body) Create a new API This operation can be used to create a new API specifying the details of the API in the payload.
APIDefinitionValidationResponse	apisValidateDefinitionPost(String type, File file, String url) Validate API definition and retrieve a summary This operation can be used to validate a swagger or WSDL definition and retrieve a summary.
com.squareup.okhttp.Call	apisValidateDefinitionPostAsync(String type, File file, String url, ApiCallback<APIDefinitionValidationResponse> callback) Validate API definition and retrieve a summary (asynchronously) This operation can be used to validate a swagger or WSDL definition and retrieve a summary.
com.squareup.okhttp.Call	apisValidateDefinitionPostCall(String type, File file, String url, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisValidateDefinitionPost
ApiResponse<APIDefinitionValidationResponse>	apisValidateDefinitionPostWithHttpInfo(String type, File file, String url) Validate API definition and retrieve a summary This operation can be used to validate a swagger or WSDL definition and retrieve a summary.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

APICollectionApi

public APICollectionApi()

APICollectionApi

public APICollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisGetCall

public com.squareup.okhttp.Call apisGetCall(Integer limit,
                                            Integer offset,
                                            String query,
                                            String ifNoneMatch,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for apisGet

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisGet

public APIList apisGet(Integer limit,
                       Integer offset,
                       String query,
                       String ifNoneMatch)
                throws ApiException

Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

APIList

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisGetWithHttpInfo

public ApiResponse<APIList> apisGetWithHttpInfo(Integer limit,
                                                Integer offset,
                                                String query,
                                                String ifNoneMatch)
                                         throws ApiException

Retrieve/Search APIs This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<APIList>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisGetAsync

public com.squareup.okhttp.Call apisGetAsync(Integer limit,
                                             Integer offset,
                                             String query,
                                             String ifNoneMatch,
                                             ApiCallback<APIList> callback)
                                      throws ApiException

Retrieve/Search APIs (asynchronously) This operation provides you a list of available APIs qualifying under a given search condition. Each retrieved API is represented with a minimal amount of attributes. If you want to get complete details of an API, you need to use **Get details of an API** operation.

Parameters:

limit - Maximum size of resource array to return. (optional, default to 25)

offset - Starting point within the complete list of items qualified. (optional, default to 0)

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apisHeadCall

public com.squareup.okhttp.Call apisHeadCall(String query,
                                             String ifNoneMatch,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for apisHead

Parameters:

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisHead

public void apisHead(String query,
                     String ifNoneMatch)
              throws ApiException

Check given API attibute name is already exist Using this operation, you can check a given API context is already used. You need to provide the context name you want to check.

Parameters:

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisHeadWithHttpInfo

public ApiResponse<Void> apisHeadWithHttpInfo(String query,
                                              String ifNoneMatch)
                                       throws ApiException

Check given API attibute name is already exist Using this operation, you can check a given API context is already used. You need to provide the context name you want to check.

Parameters:

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisHeadAsync

public com.squareup.okhttp.Call apisHeadAsync(String query,
                                              String ifNoneMatch,
                                              ApiCallback<Void> callback)
                                       throws ApiException

Check given API attibute name is already exist (asynchronously) Using this operation, you can check a given API context is already used. You need to provide the context name you want to check.

Parameters:

query - **Search condition**. You can search in attributes by using an **\"<attribute>:\"** modifier. Eg. \"provider:wso2\" will match an API if the provider of the API is exactly \"wso2\". Additionally you can use wildcards. Eg. \"provider:wso2*\" will match an API if the provider of the API starts with \"wso2\". Supported attribute modifiers are [**version, context, lifeCycleStatus, description, subcontext, doc, provider**] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (optional)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resourec. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apisImportDefinitionPostCall

public com.squareup.okhttp.Call apisImportDefinitionPostCall(String type,
                                                             File file,
                                                             String url,
                                                             String additionalProperties,
                                                             String implementationType,
                                                             String ifMatch,
                                                             String ifUnmodifiedSince,
                                                             ProgressResponseBody.ProgressListener progressListener,
                                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                      throws ApiException

Build call for apisImportDefinitionPost

Parameters:

type - Definition type to upload (optional, default to SWAGGER)

file - Definition to uploadas a file (optional)

url - Definition url (optional)

additionalProperties - Additional attributes specified as a stringified JSON with API's schema (optional)

implementationType - Currently this is only used when creating an API using a WSDL. If 'SOAP' is specified, the API will be created with only one resource 'POST /' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisImportDefinitionPost

public API apisImportDefinitionPost(String type,
                                    File file,
                                    String url,
                                    String additionalProperties,
                                    String implementationType,
                                    String ifMatch,
                                    String ifUnmodifiedSince)
                             throws ApiException

Import API Definition This operation can be used to create api from api definition. API definition can be either Swagger or a WSDL WSDL can be speficied as a single file or a ZIP archive with WSDLs and reference XSDs etc. When the type is WSDL, it is a **must** to specify additionalProperties with API's name, version, context and endpoints. See the example for additionalProperties.

Parameters:

type - Definition type to upload (optional, default to SWAGGER)

file - Definition to uploadas a file (optional)

url - Definition url (optional)

additionalProperties - Additional attributes specified as a stringified JSON with API's schema (optional)

implementationType - Currently this is only used when creating an API using a WSDL. If 'SOAP' is specified, the API will be created with only one resource 'POST /' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

API

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisImportDefinitionPostWithHttpInfo

public ApiResponse<API> apisImportDefinitionPostWithHttpInfo(String type,
                                                             File file,
                                                             String url,
                                                             String additionalProperties,
                                                             String implementationType,
                                                             String ifMatch,
                                                             String ifUnmodifiedSince)
                                                      throws ApiException

Import API Definition This operation can be used to create api from api definition. API definition can be either Swagger or a WSDL WSDL can be speficied as a single file or a ZIP archive with WSDLs and reference XSDs etc. When the type is WSDL, it is a **must** to specify additionalProperties with API's name, version, context and endpoints. See the example for additionalProperties.

Parameters:

type - Definition type to upload (optional, default to SWAGGER)

file - Definition to uploadas a file (optional)

url - Definition url (optional)

additionalProperties - Additional attributes specified as a stringified JSON with API's schema (optional)

implementationType - Currently this is only used when creating an API using a WSDL. If 'SOAP' is specified, the API will be created with only one resource 'POST /' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

Returns:

ApiResponse<API>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisImportDefinitionPostAsync

public com.squareup.okhttp.Call apisImportDefinitionPostAsync(String type,
                                                              File file,
                                                              String url,
                                                              String additionalProperties,
                                                              String implementationType,
                                                              String ifMatch,
                                                              String ifUnmodifiedSince,
                                                              ApiCallback<API> callback)
                                                       throws ApiException

Import API Definition (asynchronously) This operation can be used to create api from api definition. API definition can be either Swagger or a WSDL WSDL can be speficied as a single file or a ZIP archive with WSDLs and reference XSDs etc. When the type is WSDL, it is a **must** to specify additionalProperties with API's name, version, context and endpoints. See the example for additionalProperties.

Parameters:

type - Definition type to upload (optional, default to SWAGGER)

file - Definition to uploadas a file (optional)

url - Definition url (optional)

additionalProperties - Additional attributes specified as a stringified JSON with API's schema (optional)

implementationType - Currently this is only used when creating an API using a WSDL. If 'SOAP' is specified, the API will be created with only one resource 'POST /' which is to be used for SOAP operations. If 'HTTP_BINDING' is specified, the API will be created with resources using HTTP binding operations which are extracted from the WSDL. (optional, default to SOAP)

ifMatch - Validator for conditional requests; based on ETag. (optional)

ifUnmodifiedSince - Validator for conditional requests; based on Last Modified header. (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apisPostCall

public com.squareup.okhttp.Call apisPostCall(API body,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for apisPost

Parameters:

body - API object that needs to be added (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisPost

public API apisPost(API body)
             throws ApiException

Create a new API This operation can be used to create a new API specifying the details of the API in the payload. The new API will be in `CREATED` state. There is a special capability for a user who has `APIM Admin` permission such that he can create APIs on behalf of other users. For that he can to specify `\"provider\" : \"some_other_user\"` in the payload so that the API's creator will be shown as `some_other_user` in the UI.

Parameters:

body - API object that needs to be added (required)

Returns:

API

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisPostWithHttpInfo

public ApiResponse<API> apisPostWithHttpInfo(API body)
                                      throws ApiException

Create a new API This operation can be used to create a new API specifying the details of the API in the payload. The new API will be in `CREATED` state. There is a special capability for a user who has `APIM Admin` permission such that he can create APIs on behalf of other users. For that he can to specify `\"provider\" : \"some_other_user\"` in the payload so that the API's creator will be shown as `some_other_user` in the UI.

Parameters:

body - API object that needs to be added (required)

Returns:

ApiResponse<API>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisPostAsync

public com.squareup.okhttp.Call apisPostAsync(API body,
                                              ApiCallback<API> callback)
                                       throws ApiException

Create a new API (asynchronously) This operation can be used to create a new API specifying the details of the API in the payload. The new API will be in `CREATED` state. There is a special capability for a user who has `APIM Admin` permission such that he can create APIs on behalf of other users. For that he can to specify `\"provider\" : \"some_other_user\"` in the payload so that the API's creator will be shown as `some_other_user` in the UI.

Parameters:

body - API object that needs to be added (required)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

apisValidateDefinitionPostCall

public com.squareup.okhttp.Call apisValidateDefinitionPostCall(String type,
                                                               File file,
                                                               String url,
                                                               ProgressResponseBody.ProgressListener progressListener,
                                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                        throws ApiException

Build call for apisValidateDefinitionPost

Parameters:

type - Definition type to upload (required)

file - Definition to upload as a file (optional)

url - Definition url (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisValidateDefinitionPost

public APIDefinitionValidationResponse apisValidateDefinitionPost(String type,
                                                                  File file,
                                                                  String url)
                                                           throws ApiException

Validate API definition and retrieve a summary This operation can be used to validate a swagger or WSDL definition and retrieve a summary.

Parameters:

type - Definition type to upload (required)

file - Definition to upload as a file (optional)

url - Definition url (optional)

Returns:

APIDefinitionValidationResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisValidateDefinitionPostWithHttpInfo

public ApiResponse<APIDefinitionValidationResponse> apisValidateDefinitionPostWithHttpInfo(String type,
                                                                                           File file,
                                                                                           String url)
                                                                                    throws ApiException

Validate API definition and retrieve a summary This operation can be used to validate a swagger or WSDL definition and retrieve a summary.

Parameters:

type - Definition type to upload (required)

file - Definition to upload as a file (optional)

url - Definition url (optional)

Returns:

ApiResponse<APIDefinitionValidationResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

apisValidateDefinitionPostAsync

public com.squareup.okhttp.Call apisValidateDefinitionPostAsync(String type,
                                                                File file,
                                                                String url,
                                                                ApiCallback<APIDefinitionValidationResponse> callback)
                                                         throws ApiException

Validate API definition and retrieve a summary (asynchronously) This operation can be used to validate a swagger or WSDL definition and retrieve a summary.

Parameters:

type - Definition type to upload (required)

file - Definition to upload as a file (optional)

url - Definition url (optional)

callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object