Open Context Protocol is live! 🚀 Read the launch post
updateRelatedWork

updateRelatedWork

Update related work

Details

  • Method: PUT
  • Path: /rest/api/3/version/{id}/relatedwork
  • Operation ID: updateRelatedWork

Parameters

{
  "id": {
    "description": "The ID of the version to update the related work on. For the related work id, pass it to the input JSON.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "category": {
    "description": "The category of the related work",
    "required": true,
    "location": "body",
    "type": "string"
  },
  "issueId": {
    "description": "The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.",
    "required": false,
    "location": "body",
    "type": "integer"
  },
  "relatedWorkId": {
    "description": "The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "title": {
    "description": "The title of the related work",
    "required": false,
    "location": "body",
    "type": "string"
  },
  "url": {
    "description": "The URL of the related work. Will be null for the native release note related work item, but is otherwise required.",
    "required": false,
    "location": "body",
    "type": "string"
  }
}

Response Schema

{
  "additionalProperties": false,
  "description": "Associated related work to a version",
  "properties": {
    "category": {
      "description": "The category of the related work",
      "type": "string"
    },
    "issueId": {
      "description": "The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "relatedWorkId": {
      "description": "The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it.",
      "readOnly": true,
      "type": "string"
    },
    "title": {
      "description": "The title of the related work",
      "type": "string"
    },
    "url": {
      "description": "The URL of the related work. Will be null for the native release note related work item, but is otherwise required.",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "category"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('updateRelatedWork', {
    # Add required parameters here
})