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

Class ValidationApi

  • public class ValidationApi
extends Object

    • Constructor Detail

      • ValidationApi

        public ValidationApi()

      • ValidationApi

        public ValidationApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • validateAPICall

        public okhttp3.Call validateAPICall​(String query,
                                    String ifNoneMatch,
                                    ApiCallback _callback)
                             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)
        _callback - Callback for upload/download progress
        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 Context Name already Exists 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 Context Name already Exists 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 okhttp3.Call validateAPIAsync​(String query,
                                     String ifNoneMatch,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Check Given API Context Name already Exists (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

      • validateAsyncAPISpecificationCall

        public okhttp3.Call validateAsyncAPISpecificationCall​(Boolean returnContent,
                                                      String url,
                                                      File file,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for validateAsyncAPISpecification
        Parameters:
        returnContent - Specify whether to return the full content of the AsyncAPI specification in the response. This is only applicable when using url based validation (optional, default to false)
        url - AsyncAPI definition url (optional)
        file - AsyncAPI definition as a file (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • validateAsyncAPISpecification

        public AsyncAPISpecificationValidationResponseDTO validateAsyncAPISpecification​(Boolean returnContent,
                                                                                String url,
                                                                                File file)
                                                                         throws ApiException
        Validate an AsyncAPI Specification This operation can be used to validate and AsyncAPI Specification and retrieve a summary. Provide either 'url' or 'file' to specify the definition.
        Parameters:
        returnContent - Specify whether to return the full content of the AsyncAPI specification in the response. This is only applicable when using url based validation (optional, default to false)
        url - AsyncAPI definition url (optional)
        file - AsyncAPI definition as a file (optional)
        Returns:
        AsyncAPISpecificationValidationResponseDTO
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateAsyncAPISpecificationWithHttpInfo

        public ApiResponse<AsyncAPISpecificationValidationResponseDTO> validateAsyncAPISpecificationWithHttpInfo​(Boolean returnContent,
                                                                                                         String url,
                                                                                                         File file)
                                                                                                  throws ApiException
        Validate an AsyncAPI Specification This operation can be used to validate and AsyncAPI Specification and retrieve a summary. Provide either 'url' or 'file' to specify the definition.
        Parameters:
        returnContent - Specify whether to return the full content of the AsyncAPI specification in the response. This is only applicable when using url based validation (optional, default to false)
        url - AsyncAPI definition url (optional)
        file - AsyncAPI definition as a file (optional)
        Returns:
        ApiResponse<AsyncAPISpecificationValidationResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateAsyncAPISpecificationAsync

        public okhttp3.Call validateAsyncAPISpecificationAsync​(Boolean returnContent,
                                                       String url,
                                                       File file,
                                                       ApiCallback<AsyncAPISpecificationValidationResponseDTO> _callback)
                                                throws ApiException
        Validate an AsyncAPI Specification (asynchronously) This operation can be used to validate and AsyncAPI Specification and retrieve a summary. Provide either 'url' or 'file' to specify the definition.
        Parameters:
        returnContent - Specify whether to return the full content of the AsyncAPI specification in the response. This is only applicable when using url based validation (optional, default to false)
        url - AsyncAPI definition url (optional)
        file - AsyncAPI definition 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

      • validateEndpointCall

        public okhttp3.Call validateEndpointCall​(String endpointUrl,
                                         String apiId,
                                         ApiCallback _callback)
                                  throws ApiException
        Build call for validateEndpoint
        Parameters:
        endpointUrl - API endpoint url (required)
        apiId - (optional)
        _callback - Callback for upload/download progress
        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 okhttp3.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

      • validateGraphQLSchemaCall

        public okhttp3.Call validateGraphQLSchemaCall​(File file,
                                              ApiCallback _callback)
                                       throws ApiException
        Build call for validateGraphQLSchema
        Parameters:
        file - Definition to upload as a file (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • validateGraphQLSchema

        public GraphQLValidationResponseDTO validateGraphQLSchema​(File file)
                                                   throws ApiException
        Validate a GraphQL SDL 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

      • validateGraphQLSchemaWithHttpInfo

        public ApiResponse<GraphQLValidationResponseDTO> validateGraphQLSchemaWithHttpInfo​(File file)
                                                                            throws ApiException
        Validate a GraphQL SDL 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

      • validateGraphQLSchemaAsync

        public okhttp3.Call validateGraphQLSchemaAsync​(File file,
                                               ApiCallback<GraphQLValidationResponseDTO> _callback)
                                        throws ApiException
        Validate a GraphQL SDL (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

      • validateOpenAPIDefinitionCall

        public okhttp3.Call validateOpenAPIDefinitionCall​(Boolean returnContent,
                                                  String url,
                                                  File file,
                                                  String inlineAPIDefinition,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for validateOpenAPIDefinition
        Parameters:
        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)
        url - OpenAPI definition url (optional)
        file - OpenAPI definition as a file (optional)
        inlineAPIDefinition - Inline content of the OpenAPI definition (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • validateOpenAPIDefinition

        public OpenAPIDefinitionValidationResponseDTO validateOpenAPIDefinition​(Boolean returnContent,
                                                                        String url,
                                                                        File file,
                                                                        String inlineAPIDefinition)
                                                                 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:
        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)
        url - OpenAPI definition url (optional)
        file - OpenAPI definition as a file (optional)
        inlineAPIDefinition - Inline content of the OpenAPI definition (optional)
        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​(Boolean returnContent,
                                                                                                 String url,
                                                                                                 File file,
                                                                                                 String inlineAPIDefinition)
                                                                                          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:
        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)
        url - OpenAPI definition url (optional)
        file - OpenAPI definition as a file (optional)
        inlineAPIDefinition - Inline content of the OpenAPI definition (optional)
        Returns:
        ApiResponse<OpenAPIDefinitionValidationResponseDTO>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • validateOpenAPIDefinitionAsync

        public okhttp3.Call validateOpenAPIDefinitionAsync​(Boolean returnContent,
                                                   String url,
                                                   File file,
                                                   String inlineAPIDefinition,
                                                   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:
        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)
        url - OpenAPI definition url (optional)
        file - OpenAPI definition as a file (optional)
        inlineAPIDefinition - Inline content of the OpenAPI definition (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

      • validateWSDLDefinitionCall

        public okhttp3.Call validateWSDLDefinitionCall​(String url,
                                               File file,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for validateWSDLDefinition
        Parameters:
        url - Definition url (optional)
        file - Definition to upload as a file (optional)
        _callback - Callback for upload/download progress
        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 okhttp3.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