Class McpServerDocumentsApi
java.lang.Object
org.wso2.am.integration.clients.publisher.api.v1.McpServerDocumentsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddMCPServerDocument(String mcpServerId, DocumentDTO documentDTO) Add a New Document to a MCP server This operation can be used to add a new documentation to a MCP server.okhttp3.CalladdMCPServerDocumentAsync(String mcpServerId, DocumentDTO documentDTO, ApiCallback<DocumentDTO> _callback) Add a New Document to a MCP server (asynchronously) This operation can be used to add a new documentation to a MCP server.okhttp3.CalladdMCPServerDocumentCall(String mcpServerId, DocumentDTO documentDTO, ApiCallback _callback) Build call for addMCPServerDocumentaddMCPServerDocumentContent(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent) Upload the Content of a MCP Server Document This operation can be used to upload a file or add inline content to a MCP server document.okhttp3.CalladdMCPServerDocumentContentAsync(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent, ApiCallback<DocumentDTO> _callback) Upload the Content of a MCP Server Document (asynchronously) This operation can be used to upload a file or add inline content to a MCP server document.okhttp3.CalladdMCPServerDocumentContentCall(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent, ApiCallback _callback) Build call for addMCPServerDocumentContentaddMCPServerDocumentContentWithHttpInfo(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent) Upload the Content of a MCP Server Document This operation can be used to upload a file or add inline content to a MCP server document.addMCPServerDocumentWithHttpInfo(String mcpServerId, DocumentDTO documentDTO) Add a New Document to a MCP server This operation can be used to add a new documentation to a MCP server.voiddeleteMCPServerDocument(String mcpServerId, String documentId, String ifMatch) Delete a Document of a MCP Server This operation can be used to delete a document associated with a MCP server.okhttp3.CalldeleteMCPServerDocumentAsync(String mcpServerId, String documentId, String ifMatch, ApiCallback<Void> _callback) Delete a Document of a MCP Server (asynchronously) This operation can be used to delete a document associated with a MCP server.okhttp3.CalldeleteMCPServerDocumentCall(String mcpServerId, String documentId, String ifMatch, ApiCallback _callback) Build call for deleteMCPServerDocumentdeleteMCPServerDocumentWithHttpInfo(String mcpServerId, String documentId, String ifMatch) Delete a Document of a MCP Server This operation can be used to delete a document associated with a MCP server.getMCPServerDocument(String mcpServerId, String documentId, String accept, String ifNoneMatch) Get a Document of a MCP Server This operation can be used to retrieve a particular document's metadata associated with a MCP server.okhttp3.CallgetMCPServerDocumentAsync(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback<DocumentDTO> _callback) Get a Document of a MCP Server (asynchronously) This operation can be used to retrieve a particular document's metadata associated with a MCP server.okhttp3.CallgetMCPServerDocumentCall(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getMCPServerDocumentvoidgetMCPServerDocumentContent(String mcpServerId, String documentId, String accept, String ifNoneMatch) Get the Content of a MCP Server Document This operation can be used to retrieve the content of a MCP server's document.okhttp3.CallgetMCPServerDocumentContentAsync(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback<Void> _callback) Get the Content of a MCP Server Document (asynchronously) This operation can be used to retrieve the content of a MCP server's document.okhttp3.CallgetMCPServerDocumentContentCall(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getMCPServerDocumentContentgetMCPServerDocumentContentWithHttpInfo(String mcpServerId, String documentId, String accept, String ifNoneMatch) Get the Content of a MCP Server Document This operation can be used to retrieve the content of a MCP server's document.getMCPServerDocuments(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch) Get a List of Documents of a MCP Server This operation can be used to retrieve a list of documents belonging to a MCP server by providing the ID of the MCP server.okhttp3.CallgetMCPServerDocumentsAsync(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback<DocumentListDTO> _callback) Get a List of Documents of a MCP Server (asynchronously) This operation can be used to retrieve a list of documents belonging to a MCP server by providing the ID of the MCP server.okhttp3.CallgetMCPServerDocumentsCall(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback _callback) Build call for getMCPServerDocumentsgetMCPServerDocumentsWithHttpInfo(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch) Get a List of Documents of a MCP Server This operation can be used to retrieve a list of documents belonging to a MCP server by providing the ID of the MCP server.getMCPServerDocumentWithHttpInfo(String mcpServerId, String documentId, String accept, String ifNoneMatch) Get a Document of a MCP Server This operation can be used to retrieve a particular document's metadata associated with a MCP server.voidsetApiClient(ApiClient apiClient) updateMCPServerDocument(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of a MCP Server This operation can be used to update metadata of an MCP server's document.okhttp3.CallupdateMCPServerDocumentAsync(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) Update a Document of a MCP Server (asynchronously) This operation can be used to update metadata of an MCP server's document.okhttp3.CallupdateMCPServerDocumentCall(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback _callback) Build call for updateMCPServerDocumentupdateMCPServerDocumentWithHttpInfo(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch) Update a Document of a MCP Server This operation can be used to update metadata of an MCP server's document.voidvalidateMCPServerDocument(String mcpServerId, String name, String ifMatch) Check Whether a Document with the Provided Name Exist This operation can be used to verify the document name exists or not.okhttp3.CallvalidateMCPServerDocumentAsync(String mcpServerId, String name, String ifMatch, ApiCallback<Void> _callback) Check Whether a Document with the Provided Name Exist (asynchronously) This operation can be used to verify the document name exists or not.okhttp3.CallvalidateMCPServerDocumentCall(String mcpServerId, String name, String ifMatch, ApiCallback _callback) Build call for validateMCPServerDocumentvalidateMCPServerDocumentWithHttpInfo(String mcpServerId, String name, String ifMatch) Check Whether a Document with the Provided Name Exist This operation can be used to verify the document name exists or not.
-
Constructor Details
-
McpServerDocumentsApi
public McpServerDocumentsApi() -
McpServerDocumentsApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
addMCPServerDocumentCall
public okhttp3.Call addMCPServerDocumentCall(String mcpServerId, DocumentDTO documentDTO, ApiCallback _callback) throws ApiException Build call for addMCPServerDocument- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentDTO- Document object that needs to be added (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
addMCPServerDocument
public DocumentDTO addMCPServerDocument(String mcpServerId, DocumentDTO documentDTO) throws ApiException Add a New Document to a MCP server This operation can be used to add a new documentation to a MCP server. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an MCP server document ** MCP server once we obtain a document Id by this operation.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentDTO- Document object that needs to be added (required)- Returns:
- DocumentDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
addMCPServerDocumentWithHttpInfo
public ApiResponse<DocumentDTO> addMCPServerDocumentWithHttpInfo(String mcpServerId, DocumentDTO documentDTO) throws ApiException Add a New Document to a MCP server This operation can be used to add a new documentation to a MCP server. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an MCP server document ** MCP server once we obtain a document Id by this operation.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentDTO- Document object that needs to be added (required)- Returns:
- ApiResponse<DocumentDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
addMCPServerDocumentAsync
public okhttp3.Call addMCPServerDocumentAsync(String mcpServerId, DocumentDTO documentDTO, ApiCallback<DocumentDTO> _callback) throws ApiException Add a New Document to a MCP server (asynchronously) This operation can be used to add a new documentation to a MCP server. This operation only adds the metadata of a document. To add the actual content we need to use **Upload the content of an MCP server document ** MCP server once we obtain a document Id by this operation.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentDTO- Document 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
-
addMCPServerDocumentContentCall
public okhttp3.Call addMCPServerDocumentContentCall(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent, ApiCallback _callback) throws ApiException Build call for addMCPServerDocumentContent- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- Document to upload (optional)inlineContent- Inline content of the document (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
addMCPServerDocumentContent
public DocumentDTO addMCPServerDocumentContent(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent) throws ApiException Upload the Content of a MCP Server Document This operation can be used to upload a file or add inline content to a MCP server document. **IMPORTANT:** * Either **file** or **inlineContent** form data parameters should be specified at one time. * Document's source type should be **FILE** in order to upload a file to the document using **file** parameter. * Document's source type should be **INLINE** in order to add inline content to the document using **inlineContent** parameter.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- Document to upload (optional)inlineContent- Inline content of the document (optional)- Returns:
- DocumentDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
addMCPServerDocumentContentWithHttpInfo
public ApiResponse<DocumentDTO> addMCPServerDocumentContentWithHttpInfo(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent) throws ApiException Upload the Content of a MCP Server Document This operation can be used to upload a file or add inline content to a MCP server document. **IMPORTANT:** * Either **file** or **inlineContent** form data parameters should be specified at one time. * Document's source type should be **FILE** in order to upload a file to the document using **file** parameter. * Document's source type should be **INLINE** in order to add inline content to the document using **inlineContent** parameter.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- Document to upload (optional)inlineContent- Inline content of the document (optional)- Returns:
- ApiResponse<DocumentDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
addMCPServerDocumentContentAsync
public okhttp3.Call addMCPServerDocumentContentAsync(String mcpServerId, String documentId, String ifMatch, File file, String inlineContent, ApiCallback<DocumentDTO> _callback) throws ApiException Upload the Content of a MCP Server Document (asynchronously) This operation can be used to upload a file or add inline content to a MCP server document. **IMPORTANT:** * Either **file** or **inlineContent** form data parameters should be specified at one time. * Document's source type should be **FILE** in order to upload a file to the document using **file** parameter. * Document's source type should be **INLINE** in order to add inline content to the document using **inlineContent** parameter.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)file- Document to upload (optional)inlineContent- Inline content of the document (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
-
deleteMCPServerDocumentCall
public okhttp3.Call deleteMCPServerDocumentCall(String mcpServerId, String documentId, String ifMatch, ApiCallback _callback) throws ApiException Build call for deleteMCPServerDocument- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
deleteMCPServerDocument
public void deleteMCPServerDocument(String mcpServerId, String documentId, String ifMatch) throws ApiException Delete a Document of a MCP Server This operation can be used to delete a document associated with a MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteMCPServerDocumentWithHttpInfo
public ApiResponse<Void> deleteMCPServerDocumentWithHttpInfo(String mcpServerId, String documentId, String ifMatch) throws ApiException Delete a Document of a MCP Server This operation can be used to delete a document associated with a MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
deleteMCPServerDocumentAsync
public okhttp3.Call deleteMCPServerDocumentAsync(String mcpServerId, String documentId, String ifMatch, ApiCallback<Void> _callback) throws ApiException Delete a Document of a MCP Server (asynchronously) This operation can be used to delete a document associated with a MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)ifMatch- Validator for conditional requests; based on ETag. (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
-
getMCPServerDocumentCall
public okhttp3.Call getMCPServerDocumentCall(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getMCPServerDocument- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocument
public DocumentDTO getMCPServerDocument(String mcpServerId, String documentId, String accept, String ifNoneMatch) throws ApiException Get a Document of a MCP Server This operation can be used to retrieve a particular document's metadata associated with a MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- DocumentDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getMCPServerDocumentWithHttpInfo
public ApiResponse<DocumentDTO> getMCPServerDocumentWithHttpInfo(String mcpServerId, String documentId, String accept, String ifNoneMatch) throws ApiException Get a Document of a MCP Server This operation can be used to retrieve a particular document's metadata associated with a MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<DocumentDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getMCPServerDocumentAsync
public okhttp3.Call getMCPServerDocumentAsync(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback<DocumentDTO> _callback) throws ApiException Get a Document of a MCP Server (asynchronously) This operation can be used to retrieve a particular document's metadata associated with a MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocumentContentCall
public okhttp3.Call getMCPServerDocumentContentCall(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getMCPServerDocumentContent- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocumentContent
public void getMCPServerDocumentContent(String mcpServerId, String documentId, String accept, String ifNoneMatch) throws ApiException Get the Content of a MCP Server Document This operation can be used to retrieve the content of a MCP server's document. The document can be of 3 types. In each cases responses are different. 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type _Sample cURL_ : `curl -k -H \"Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51\" -F inlineContent=@\"docs.txt\" -X POST \"https://localhost:9443/api/am/publisher/v4/mcp-servers/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: The client will recieve the URL of the document as the Location header with the response with - `303 See Other`- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocumentContentWithHttpInfo
public ApiResponse<Void> getMCPServerDocumentContentWithHttpInfo(String mcpServerId, String documentId, String accept, String ifNoneMatch) throws ApiException Get the Content of a MCP Server Document This operation can be used to retrieve the content of a MCP server's document. The document can be of 3 types. In each cases responses are different. 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type _Sample cURL_ : `curl -k -H \"Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51\" -F inlineContent=@\"docs.txt\" -X POST \"https://localhost:9443/api/am/publisher/v4/mcp-servers/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: The client will recieve the URL of the document as the Location header with the response with - `303 See Other`- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocumentContentAsync
public okhttp3.Call getMCPServerDocumentContentAsync(String mcpServerId, String documentId, String accept, String ifNoneMatch, ApiCallback<Void> _callback) throws ApiException Get the Content of a MCP Server Document (asynchronously) This operation can be used to retrieve the content of a MCP server's document. The document can be of 3 types. In each cases responses are different. 1. **Inline type**: The content of the document will be retrieved in `text/plain` content type _Sample cURL_ : `curl -k -H \"Authorization:Bearer 579f0af4-37be-35c7-81a4-f1f1e9ee7c51\" -F inlineContent=@\"docs.txt\" -X POST \"https://localhost:9443/api/am/publisher/v4/mcp-servers/995a4972-3178-4b17-a374-756e0e19127c/documents/43c2bcce-60e7-405f-bc36-e39c0c5e189e/content` 2. **FILE type**: The file will be downloaded with the related content type (eg. `application/pdf`) 3. **URL type**: The client will recieve the URL of the document as the Location header with the response with - `303 See Other`- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocumentsCall
public okhttp3.Call getMCPServerDocumentsCall(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback _callback) throws ApiException Build call for getMCPServerDocuments- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (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)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
getMCPServerDocuments
public DocumentListDTO getMCPServerDocuments(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch) throws ApiException Get a List of Documents of a MCP Server This operation can be used to retrieve a list of documents belonging to a MCP server by providing the ID of the MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (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)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- DocumentListDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getMCPServerDocumentsWithHttpInfo
public ApiResponse<DocumentListDTO> getMCPServerDocumentsWithHttpInfo(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch) throws ApiException Get a List of Documents of a MCP Server This operation can be used to retrieve a list of documents belonging to a MCP server by providing the ID of the MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (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)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")ifNoneMatch- Validator for conditional requests; based on the ETag of the formerly retrieved variant of the resource. (optional)- Returns:
- ApiResponse<DocumentListDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
getMCPServerDocumentsAsync
public okhttp3.Call getMCPServerDocumentsAsync(String mcpServerId, Integer limit, Integer offset, String accept, String ifNoneMatch, ApiCallback<DocumentListDTO> _callback) throws ApiException Get a List of Documents of a MCP Server (asynchronously) This operation can be used to retrieve a list of documents belonging to a MCP server by providing the ID of the MCP server.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (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)accept- Media types acceptable for the response. Default is application/json. (optional, default to "application/json")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
-
updateMCPServerDocumentCall
public okhttp3.Call updateMCPServerDocumentCall(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback _callback) throws ApiException Build call for updateMCPServerDocument- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)documentDTO- Document object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
updateMCPServerDocument
public DocumentDTO updateMCPServerDocument(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch) throws ApiException Update a Document of a MCP Server This operation can be used to update metadata of an MCP server's document.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)documentDTO- Document object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- DocumentDTO
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateMCPServerDocumentWithHttpInfo
public ApiResponse<DocumentDTO> updateMCPServerDocumentWithHttpInfo(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch) throws ApiException Update a Document of a MCP Server This operation can be used to update metadata of an MCP server's document.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)documentDTO- Document object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<DocumentDTO>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
updateMCPServerDocumentAsync
public okhttp3.Call updateMCPServerDocumentAsync(String mcpServerId, String documentId, DocumentDTO documentDTO, String ifMatch, ApiCallback<DocumentDTO> _callback) throws ApiException Update a Document of a MCP Server (asynchronously) This operation can be used to update metadata of an MCP server's document.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)documentId- Document Identifier (required)documentDTO- Document object that needs to be added (required)ifMatch- Validator for conditional requests; based on ETag. (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
-
validateMCPServerDocumentCall
public okhttp3.Call validateMCPServerDocumentCall(String mcpServerId, String name, String ifMatch, ApiCallback _callback) throws ApiException Build call for validateMCPServerDocument- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)name- The name of the document which needs to be checked for the existence. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object
-
validateMCPServerDocument
public void validateMCPServerDocument(String mcpServerId, String name, String ifMatch) throws ApiException Check Whether a Document with the Provided Name Exist This operation can be used to verify the document name exists or not.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)name- The name of the document which needs to be checked for the existence. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
validateMCPServerDocumentWithHttpInfo
public ApiResponse<Void> validateMCPServerDocumentWithHttpInfo(String mcpServerId, String name, String ifMatch) throws ApiException Check Whether a Document with the Provided Name Exist This operation can be used to verify the document name exists or not.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)name- The name of the document which needs to be checked for the existence. (required)ifMatch- Validator for conditional requests; based on ETag. (optional)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body
-
validateMCPServerDocumentAsync
public okhttp3.Call validateMCPServerDocumentAsync(String mcpServerId, String name, String ifMatch, ApiCallback<Void> _callback) throws ApiException Check Whether a Document with the Provided Name Exist (asynchronously) This operation can be used to verify the document name exists or not.- Parameters:
mcpServerId- **MCP Server ID** consisting of the **UUID** of the MCP Server. (required)name- The name of the document which needs to be checked for the existence. (required)ifMatch- Validator for conditional requests; based on ETag. (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
-