provider 1190 operations 47 docs pages
@utdk/github
GitHub v3 REST API
Generated UTDK provider client for GitHub v3 REST API. GitHub's v3 REST API.
Codes Of Conduct
Optional generated docs page for
@utdk/github.
Codes Of Conduct
Use these operations through the generated client (not direct HTTP calls).
Import path: @utdk/github
Operations
github.codesOfConduct.getAllCodesOfConduct
- HTTP:
GET /codes_of_conduct - What it does: Get all codes of conduct
- OpenAPI operationId:
codes-of-conduct/get-all-codes-of-conduct - Path params: None
- Query params: None
- Response codes:
200,304 - Transport options: None
- Source: OpenAPI reference
- TypeScript: Client interface
Inputs
- Client input type:
{ [key: string]: unknown } - Client transport options: None
Outputs
- Client return type:
({ key: string; name: string; url: string; body?: string; html_url: string | null })[] - OpenAPI response codes:
200,304
import github from "@utdk/github";
type CodesOfConductGetAllCodesOfConductInput = Parameters<typeof github.codesOfConduct.getAllCodesOfConduct> extends [infer T, ...unknown[]] ? T : undefined;
type CodesOfConductGetAllCodesOfConductOutput = Awaited<ReturnType<typeof github.codesOfConduct.getAllCodesOfConduct>>;
const result: CodesOfConductGetAllCodesOfConductOutput = await github.codesOfConduct.getAllCodesOfConduct();
// Result shape (from schema): ({ key: string; name: string; url: string; body?: string; html_url: string | null })[]
github.codesOfConduct.getConductCode
- HTTP:
GET /codes_of_conduct/{key} - What it does: Get a code of conduct
- OpenAPI operationId:
codes-of-conduct/get-conduct-code - Path params:
key - Query params: None
- Response codes:
200,304,404 - Transport options: None
- Source: OpenAPI reference
- TypeScript: Client interface
Inputs
- Client input type:
{ key: string } - Client transport options: None
Outputs
- Client return type:
{ key: string; name: string; url: string; body?: string; html_url: string | null } - OpenAPI response codes:
200,304,404
import github from "@utdk/github";
type CodesOfConductGetConductCodeInput = Parameters<typeof github.codesOfConduct.getConductCode> extends [infer T, ...unknown[]] ? T : undefined;
type CodesOfConductGetConductCodeOutput = Awaited<ReturnType<typeof github.codesOfConduct.getConductCode>>;
const input: CodesOfConductGetConductCodeInput = {} as { key: string };
const result: CodesOfConductGetConductCodeOutput = await github.codesOfConduct.getConductCode(input);
// Result shape (from schema): { key: string; name: string; url: string; body?: string; html_url: string | null }