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

Class DocumentCollectionApi

java.lang.Object

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

public class DocumentCollectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DocumentCollectionApi()
DocumentCollectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DocumentList	apisApiIdDocumentsGet(String apiId, Integer limit, Integer offset, String ifNoneMatch) Get a list of documents of an API This operation can be used to retrieve a list of documents belonging to an API by providing the id of the API.
com.squareup.okhttp.Call	apisApiIdDocumentsGetAsync(String apiId, Integer limit, Integer offset, String ifNoneMatch, ApiCallback<DocumentList> callback) Get a list of documents of an API (asynchronously) This operation can be used to retrieve a list of documents belonging to an API by providing the id of the API.
com.squareup.okhttp.Call	apisApiIdDocumentsGetCall(String apiId, Integer limit, Integer offset, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdDocumentsGet
ApiResponse<DocumentList>	apisApiIdDocumentsGetWithHttpInfo(String apiId, Integer limit, Integer offset, String ifNoneMatch) Get a list of documents of an API This operation can be used to retrieve a list of documents belonging to an API by providing the id of the API.
Document	apisApiIdDocumentsPost(String apiId, Document body, String ifMatch, String ifUnmodifiedSince) Add a new document to an API This operation can be used to add a new documentation to an API.
com.squareup.okhttp.Call	apisApiIdDocumentsPostAsync(String apiId, Document body, String ifMatch, String ifUnmodifiedSince, ApiCallback<Document> callback) Add a new document to an API (asynchronously) This operation can be used to add a new documentation to an API.
com.squareup.okhttp.Call	apisApiIdDocumentsPostCall(String apiId, Document body, String ifMatch, String ifUnmodifiedSince, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisApiIdDocumentsPost
ApiResponse<Document>	apisApiIdDocumentsPostWithHttpInfo(String apiId, Document body, String ifMatch, String ifUnmodifiedSince) Add a new document to an API This operation can be used to add a new documentation to an API.
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

DocumentCollectionApi

public DocumentCollectionApi()

DocumentCollectionApi

public DocumentCollectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisApiIdDocumentsGetCall

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

Build call for apisApiIdDocumentsGet

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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)

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

apisApiIdDocumentsGet

public DocumentList apisApiIdDocumentsGet(String apiId,
                                          Integer limit,
                                          Integer offset,
                                          String ifNoneMatch)
                                   throws ApiException

Get a list of documents of an API This operation can be used to retrieve a list of documents belonging to an API by providing the id of the API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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)

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

Returns:

DocumentList

Throws:

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

apisApiIdDocumentsGetWithHttpInfo

public ApiResponse<DocumentList> apisApiIdDocumentsGetWithHttpInfo(String apiId,
                                                                   Integer limit,
                                                                   Integer offset,
                                                                   String ifNoneMatch)
                                                            throws ApiException

Get a list of documents of an API This operation can be used to retrieve a list of documents belonging to an API by providing the id of the API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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)

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

Returns:

ApiResponse<DocumentList>

Throws:

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

apisApiIdDocumentsGetAsync

public com.squareup.okhttp.Call apisApiIdDocumentsGetAsync(String apiId,
                                                           Integer limit,
                                                           Integer offset,
                                                           String ifNoneMatch,
                                                           ApiCallback<DocumentList> callback)
                                                    throws ApiException

Get a list of documents of an API (asynchronously) This operation can be used to retrieve a list of documents belonging to an API by providing the id of the API.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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)

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

apisApiIdDocumentsPostCall

public com.squareup.okhttp.Call apisApiIdDocumentsPostCall(String apiId,
                                                           Document body,
                                                           String ifMatch,
                                                           String ifUnmodifiedSince,
                                                           ProgressResponseBody.ProgressListener progressListener,
                                                           ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                    throws ApiException

Build call for apisApiIdDocumentsPost

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

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

apisApiIdDocumentsPost

public Document apisApiIdDocumentsPost(String apiId,
                                       Document body,
                                       String ifMatch,
                                       String ifUnmodifiedSince)
                                throws ApiException

Add a new document to an API This operation can be used to add a new documentation to an API. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an API document ** API once we obtain a document Id by this operation.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

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

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

Returns:

Document

Throws:

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

apisApiIdDocumentsPostWithHttpInfo

public ApiResponse<Document> apisApiIdDocumentsPostWithHttpInfo(String apiId,
                                                                Document body,
                                                                String ifMatch,
                                                                String ifUnmodifiedSince)
                                                         throws ApiException

Add a new document to an API This operation can be used to add a new documentation to an API. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an API document ** API once we obtain a document Id by this operation.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

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

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

Returns:

ApiResponse<Document>

Throws:

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

apisApiIdDocumentsPostAsync

public com.squareup.okhttp.Call apisApiIdDocumentsPostAsync(String apiId,
                                                            Document body,
                                                            String ifMatch,
                                                            String ifUnmodifiedSince,
                                                            ApiCallback<Document> callback)
                                                     throws ApiException

Add a new document to an API (asynchronously) This operation can be used to add a new documentation to an API. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an API document ** API once we obtain a document Id by this operation.

Parameters:

apiId - **API ID** consisting of the **UUID** of the API. The combination of the provider of the API, name of the API and the version is also accepted as a valid API ID. Should be formatted as **provider-name-version**. (required)

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

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