reposGetReadme
Get a repository README
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/readme - Operation ID:
repos/get-readme
Parameters
{
"owner": {
"description": "The account owner of the repository. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"repo": {
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
"required": true,
"location": "path",
"type": "string"
},
"ref": {
"description": "The name of the commit/branch/tag. Default: the repositoryβs default branch.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"title": "Content File",
"description": "Content File",
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"file"
]
},
"encoding": {
"type": "string"
},
"size": {
"type": "integer"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
},
"content": {
"type": "string"
},
"sha": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"git_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"html_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"download_url": {
"type": "string",
"format": "uri",
"nullable": true
},
"_links": {
"type": "object",
"properties": {
"git": {
"type": "string",
"format": "uri",
"nullable": true
},
"html": {
"type": "string",
"format": "uri",
"nullable": true
},
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"git",
"html",
"self"
]
},
"target": {
"type": "string",
"example": "\"actual/actual.md\""
},
"submodule_git_url": {
"type": "string",
"example": "\"git://example.com/defunkt/dotjs.git\""
}
},
"required": [
"_links",
"git_url",
"html_url",
"download_url",
"name",
"path",
"sha",
"size",
"type",
"url",
"content",
"encoding"
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('reposGetReadme', {
# Add required parameters here
})