update_endpoint
Modify existing API endpoint configurations including HTTP methods, URLs, headers, request parameters, and response schemas to maintain accurate API documentation and testing workflows.
Instructions
Update existing endpoint configuration
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endpoint_id | Yes | Endpoint ID to update (required) | |
| name | No | Updated endpoint name (optional) | |
| method | No | Updated HTTP method (optional) | |
| url | No | Updated endpoint URL (optional) | |
| description | No | Updated endpoint description (optional) | |
| headers | No | Updated request headers as key-value pairs | |
| body | No | Updated request body (JSON string) | |
| purpose | No | Updated business purpose (optional) | |
| request_params | No | Updated parameter documentation: {param_name: "description"} | |
| response_schema | No | Updated response field documentation: {field_name: "description"} | |
| header_docs | No | Updated header documentation: {header_name: "description"} |
Input Schema (JSON Schema)
{
"properties": {
"body": {
"description": "Updated request body (JSON string)",
"type": "string"
},
"description": {
"description": "Updated endpoint description (optional)",
"type": "string"
},
"endpoint_id": {
"description": "Endpoint ID to update (required)",
"type": "string"
},
"header_docs": {
"additionalProperties": {
"description": "Header description",
"type": "string"
},
"description": "Updated header documentation: {header_name: \"description\"}",
"type": "object"
},
"headers": {
"additionalProperties": {
"description": "Header value",
"type": "string"
},
"description": "Updated request headers as key-value pairs",
"type": "object"
},
"method": {
"description": "Updated HTTP method (optional)",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"HEAD",
"OPTIONS"
],
"type": "string"
},
"name": {
"description": "Updated endpoint name (optional)",
"type": "string"
},
"purpose": {
"description": "Updated business purpose (optional)",
"type": "string"
},
"request_params": {
"additionalProperties": {
"description": "Parameter description",
"type": "string"
},
"description": "Updated parameter documentation: {param_name: \"description\"}",
"type": "object"
},
"response_schema": {
"additionalProperties": {
"description": "Response field description",
"type": "string"
},
"description": "Updated response field documentation: {field_name: \"description\"}",
"type": "object"
},
"url": {
"description": "Updated endpoint URL (optional)",
"type": "string"
}
},
"required": [
"endpoint_id"
],
"type": "object"
}