reposGetCommunityProfileMetrics
Get community profile metrics
Details
- Method:
GET - Path:
/repos/{owner}/{repo}/community/profile - Operation ID:
repos/get-community-profile-metrics
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"
}
}Response Schema
{
"title": "Community Profile",
"description": "Community Profile",
"type": "object",
"properties": {
"health_percentage": {
"type": "integer",
"example": 100
},
"description": {
"type": "string",
"example": "My first repository on GitHub!",
"nullable": true
},
"documentation": {
"type": "string",
"example": "example.com",
"nullable": true
},
"files": {
"type": "object",
"properties": {
"code_of_conduct": {
"title": "Code Of Conduct Simple",
"description": "Code of Conduct Simple",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"example": "https://api.github.com/repos/github/docs/community/code_of_conduct"
},
"key": {
"type": "string",
"example": "citizen_code_of_conduct"
},
"name": {
"type": "string",
"example": "Citizen Code of Conduct"
},
"html_url": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md"
}
},
"required": [
"url",
"key",
"name",
"html_url"
],
"nullable": true
},
"code_of_conduct_file": {
"title": "Community Health File",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url"
],
"nullable": true
},
"license": {
"title": "License Simple",
"description": "License Simple",
"type": "object",
"properties": {
"key": {
"type": "string",
"example": "mit"
},
"name": {
"type": "string",
"example": "MIT License"
},
"url": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "https://api.github.com/licenses/mit"
},
"spdx_id": {
"type": "string",
"nullable": true,
"example": "MIT"
},
"node_id": {
"type": "string",
"example": "MDc6TGljZW5zZW1pdA=="
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"key",
"name",
"url",
"spdx_id",
"node_id"
],
"nullable": true
},
"contributing": {
"title": "Community Health File",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url"
],
"nullable": true
},
"readme": {
"title": "Community Health File",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url"
],
"nullable": true
},
"issue_template": {
"title": "Community Health File",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url"
],
"nullable": true
},
"pull_request_template": {
"title": "Community Health File",
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"html_url": {
"type": "string",
"format": "uri"
}
},
"required": [
"url",
"html_url"
],
"nullable": true
}
},
"required": [
"code_of_conduct",
"code_of_conduct_file",
"license",
"contributing",
"readme",
"issue_template",
"pull_request_template"
]
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2017-02-28T19:09:29Z",
"nullable": true
},
"content_reports_enabled": {
"type": "boolean",
"example": true
}
},
"required": [
"health_percentage",
"description",
"documentation",
"files",
"updated_at"
]
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('github')
# Call this tool
result = await agent.call_tool('reposGetCommunityProfileMetrics', {
# Add required parameters here
})