org.wso2.am.integration.clients.publisher.api.v1

Class ValidationApi

java.lang.Object

org.wso2.am.integration.clients.publisher.api.v1.ValidationApi

public class ValidationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ValidationApi()
ValidationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
GraphQLValidationResponseDTO	apisValidateGraphqlSchemaPost(File file) Validate GraphQL API definition and retrieve a summary This operation can be used to validate a graphQL definition and retrieve a summary.
com.squareup.okhttp.Call	apisValidateGraphqlSchemaPostAsync(File file, ApiCallback<GraphQLValidationResponseDTO> callback) Validate GraphQL API definition and retrieve a summary (asynchronously) This operation can be used to validate a graphQL definition and retrieve a summary.
com.squareup.okhttp.Call	apisValidateGraphqlSchemaPostCall(File file, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for apisValidateGraphqlSchemaPost
ApiResponse<GraphQLValidationResponseDTO>	apisValidateGraphqlSchemaPostWithHttpInfo(File file) Validate GraphQL API definition and retrieve a summary This operation can be used to validate a graphQL definition and retrieve a summary.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
void	validateAPI(String query, String ifNoneMatch) Check given API attibute name is already exist.
com.squareup.okhttp.Call	validateAPIAsync(String query, String ifNoneMatch, ApiCallback<Void> callback) Check given API attibute name is already exist.
com.squareup.okhttp.Call	validateAPICall(String query, String ifNoneMatch, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateAPI
ApiResponse<Void>	validateAPIWithHttpInfo(String query, String ifNoneMatch) Check given API attibute name is already exist.
ApiEndpointValidationResponseDTO	validateEndpoint(String endpointUrl, String apiId) Check whether given endpoint url is valid Using this operation, it is possible check whether the given API endpoint url is a valid url
com.squareup.okhttp.Call	validateEndpointAsync(String endpointUrl, String apiId, ApiCallback<ApiEndpointValidationResponseDTO> callback) Check whether given endpoint url is valid (asynchronously) Using this operation, it is possible check whether the given API endpoint url is a valid url
com.squareup.okhttp.Call	validateEndpointCall(String endpointUrl, String apiId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateEndpoint
ApiResponse<ApiEndpointValidationResponseDTO>	validateEndpointWithHttpInfo(String endpointUrl, String apiId) Check whether given endpoint url is valid Using this operation, it is possible check whether the given API endpoint url is a valid url
OpenAPIDefinitionValidationResponseDTO	validateOpenAPIDefinition(String url, File file, Boolean returnContent) Validate an OpenAPI Definition This operation can be used to validate an OpenAPI definition and retrieve a summary.
com.squareup.okhttp.Call	validateOpenAPIDefinitionAsync(String url, File file, Boolean returnContent, ApiCallback<OpenAPIDefinitionValidationResponseDTO> callback) Validate an OpenAPI Definition (asynchronously) This operation can be used to validate an OpenAPI definition and retrieve a summary.
com.squareup.okhttp.Call	validateOpenAPIDefinitionCall(String url, File file, Boolean returnContent, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateOpenAPIDefinition
ApiResponse<OpenAPIDefinitionValidationResponseDTO>	validateOpenAPIDefinitionWithHttpInfo(String url, File file, Boolean returnContent) Validate an OpenAPI Definition This operation can be used to validate an OpenAPI definition and retrieve a summary.
WSDLValidationResponseDTO	validateWSDLDefinition(String url, File file) Validate a WSDL Definition This operation can be used to validate a WSDL definition and retrieve a summary.
com.squareup.okhttp.Call	validateWSDLDefinitionAsync(String url, File file, ApiCallback<WSDLValidationResponseDTO> callback) Validate a WSDL Definition (asynchronously) This operation can be used to validate a WSDL definition and retrieve a summary.
com.squareup.okhttp.Call	validateWSDLDefinitionCall(String url, File file, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for validateWSDLDefinition
ApiResponse<WSDLValidationResponseDTO>	validateWSDLDefinitionWithHttpInfo(String url, File file) Validate a WSDL Definition This operation can be used to validate a WSDL definition and retrieve a summary.

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationApi

public ValidationApi()

ValidationApi

public ValidationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

apisValidateGraphqlSchemaPostCall

public com.squareup.okhttp.Call apisValidateGraphqlSchemaPostCall(File file,
                                                                  ProgressResponseBody.ProgressListener progressListener,
                                                                  ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                                           throws ApiException

Build call for apisValidateGraphqlSchemaPost

Parameters:

file - Definition to upload as a file (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

apisValidateGraphqlSchemaPost

public GraphQLValidationResponseDTO apisValidateGraphqlSchemaPost(File file)
                                                           throws ApiException

Validate GraphQL API definition and retrieve a summary This operation can be used to validate a graphQL definition and retrieve a summary.

Parameters:

file - Definition to upload as a file (required)

Returns:

GraphQLValidationResponseDTO

Throws:

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

apisValidateGraphqlSchemaPostWithHttpInfo

public ApiResponse<GraphQLValidationResponseDTO> apisValidateGraphqlSchemaPostWithHttpInfo(File file)
                                                                                    throws ApiException

Validate GraphQL API definition and retrieve a summary This operation can be used to validate a graphQL definition and retrieve a summary.

Parameters:

file - Definition to upload as a file (required)

Returns:

ApiResponse<GraphQLValidationResponseDTO>

Throws:

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

apisValidateGraphqlSchemaPostAsync

public com.squareup.okhttp.Call apisValidateGraphqlSchemaPostAsync(File file,
                                                                   ApiCallback<GraphQLValidationResponseDTO> callback)
                                                            throws ApiException

Validate GraphQL API definition and retrieve a summary (asynchronously) This operation can be used to validate a graphQL definition and retrieve a summary.

Parameters:

file - Definition to upload as a file (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

validateAPICall

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

Build call for validateAPI

Parameters:

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

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

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateAPI

public void validateAPI(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. \"name:wso2\" will match an API if the provider of the API is exactly \"wso2\". Supported attribute modifiers are [** version, context, name **] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (required)

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

Throws:

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

validateAPIWithHttpInfo

public ApiResponse<Void> validateAPIWithHttpInfo(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. \"name:wso2\" will match an API if the provider of the API is exactly \"wso2\". Supported attribute modifiers are [** version, context, name **] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (required)

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

Returns:

ApiResponse<Void>

Throws:

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

validateAPIAsync

public com.squareup.okhttp.Call validateAPIAsync(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. \"name:wso2\" will match an API if the provider of the API is exactly \"wso2\". Supported attribute modifiers are [** version, context, name **] If no advanced attribute modifier has been specified, search will match the given query string against API Name. (required)

ifNoneMatch - Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (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

validateEndpointCall

public com.squareup.okhttp.Call validateEndpointCall(String endpointUrl,
                                                     String apiId,
                                                     ProgressResponseBody.ProgressListener progressListener,
                                                     ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                              throws ApiException

Build call for validateEndpoint

Parameters:

endpointUrl - API endpoint url (required)

apiId - (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateEndpoint

public ApiEndpointValidationResponseDTO validateEndpoint(String endpointUrl,
                                                         String apiId)
                                                  throws ApiException

Check whether given endpoint url is valid Using this operation, it is possible check whether the given API endpoint url is a valid url

Parameters:

endpointUrl - API endpoint url (required)

apiId - (optional)

Returns:

ApiEndpointValidationResponseDTO

Throws:

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

validateEndpointWithHttpInfo

public ApiResponse<ApiEndpointValidationResponseDTO> validateEndpointWithHttpInfo(String endpointUrl,
                                                                                  String apiId)
                                                                           throws ApiException

Check whether given endpoint url is valid Using this operation, it is possible check whether the given API endpoint url is a valid url

Parameters:

endpointUrl - API endpoint url (required)

apiId - (optional)

Returns:

ApiResponse<ApiEndpointValidationResponseDTO>

Throws:

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

validateEndpointAsync

public com.squareup.okhttp.Call validateEndpointAsync(String endpointUrl,
                                                      String apiId,
                                                      ApiCallback<ApiEndpointValidationResponseDTO> callback)
                                               throws ApiException

Check whether given endpoint url is valid (asynchronously) Using this operation, it is possible check whether the given API endpoint url is a valid url

Parameters:

endpointUrl - API endpoint url (required)

apiId - (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

validateOpenAPIDefinitionCall

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

Build call for validateOpenAPIDefinition

Parameters:

url - OpenAPI definition url (optional)

file - OpenAPI definition as a file (optional)

returnContent - Specify whether to return the full content of the OpenAPI definition in the response. This is only applicable when using url based validation (optional, default to false)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateOpenAPIDefinition

public OpenAPIDefinitionValidationResponseDTO validateOpenAPIDefinition(String url,
                                                                        File file,
                                                                        Boolean returnContent)
                                                                 throws ApiException

Validate an OpenAPI Definition This operation can be used to validate an OpenAPI definition and retrieve a summary. Provide either `url` or `file` to specify the definition.

Parameters:

url - OpenAPI definition url (optional)

file - OpenAPI definition as a file (optional)

returnContent - Specify whether to return the full content of the OpenAPI definition in the response. This is only applicable when using url based validation (optional, default to false)

Returns:

OpenAPIDefinitionValidationResponseDTO

Throws:

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

validateOpenAPIDefinitionWithHttpInfo

public ApiResponse<OpenAPIDefinitionValidationResponseDTO> validateOpenAPIDefinitionWithHttpInfo(String url,
                                                                                                 File file,
                                                                                                 Boolean returnContent)
                                                                                          throws ApiException

Validate an OpenAPI Definition This operation can be used to validate an OpenAPI definition and retrieve a summary. Provide either `url` or `file` to specify the definition.

Parameters:

url - OpenAPI definition url (optional)

file - OpenAPI definition as a file (optional)

returnContent - Specify whether to return the full content of the OpenAPI definition in the response. This is only applicable when using url based validation (optional, default to false)

Returns:

ApiResponse<OpenAPIDefinitionValidationResponseDTO>

Throws:

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

validateOpenAPIDefinitionAsync

public com.squareup.okhttp.Call validateOpenAPIDefinitionAsync(String url,
                                                               File file,
                                                               Boolean returnContent,
                                                               ApiCallback<OpenAPIDefinitionValidationResponseDTO> callback)
                                                        throws ApiException

Validate an OpenAPI Definition (asynchronously) This operation can be used to validate an OpenAPI definition and retrieve a summary. Provide either `url` or `file` to specify the definition.

Parameters:

url - OpenAPI definition url (optional)

file - OpenAPI definition as a file (optional)

returnContent - Specify whether to return the full content of the OpenAPI definition in the response. This is only applicable when using url based validation (optional, default to false)

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

validateWSDLDefinitionCall

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

Build call for validateWSDLDefinition

Parameters:

url - Definition url (optional)

file - Definition to upload as a file (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

validateWSDLDefinition

public WSDLValidationResponseDTO validateWSDLDefinition(String url,
                                                        File file)
                                                 throws ApiException

Validate a WSDL Definition This operation can be used to validate a WSDL definition and retrieve a summary. Provide either `url` or `file` to specify the definition.

Parameters:

url - Definition url (optional)

file - Definition to upload as a file (optional)

Returns:

WSDLValidationResponseDTO

Throws:

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

validateWSDLDefinitionWithHttpInfo

public ApiResponse<WSDLValidationResponseDTO> validateWSDLDefinitionWithHttpInfo(String url,
                                                                                 File file)
                                                                          throws ApiException

Validate a WSDL Definition This operation can be used to validate a WSDL definition and retrieve a summary. Provide either `url` or `file` to specify the definition.

Parameters:

url - Definition url (optional)

file - Definition to upload as a file (optional)

Returns:

ApiResponse<WSDLValidationResponseDTO>

Throws:

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

validateWSDLDefinitionAsync

public com.squareup.okhttp.Call validateWSDLDefinitionAsync(String url,
                                                            File file,
                                                            ApiCallback<WSDLValidationResponseDTO> callback)
                                                     throws ApiException

Validate a WSDL Definition (asynchronously) This operation can be used to validate a WSDL definition and retrieve a summary. Provide either `url` or `file` to specify the definition.

Parameters:

url - Definition url (optional)

file - Definition to upload as a file (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