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.
Gitignore
Optional generated docs page for
@utdk/github.
Gitignore
Use these operations through the generated client (not direct HTTP calls).
Import path: @utdk/github
Operations
github.gitignore.getAllTemplates
- HTTP:
GET /gitignore/templates - What it does: Get all gitignore templates
- OpenAPI operationId:
gitignore/get-all-templates - 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:
(string)[] - OpenAPI response codes:
200,304
import github from "@utdk/github";
type GitignoreGetAllTemplatesInput = Parameters<typeof github.gitignore.getAllTemplates> extends [infer T, ...unknown[]] ? T : undefined;
type GitignoreGetAllTemplatesOutput = Awaited<ReturnType<typeof github.gitignore.getAllTemplates>>;
const result: GitignoreGetAllTemplatesOutput = await github.gitignore.getAllTemplates();
// Result shape (from schema): (string)[]
github.gitignore.getTemplate
- HTTP:
GET /gitignore/templates/{name} - What it does: Get a gitignore template
- OpenAPI operationId:
gitignore/get-template - Path params:
name - Query params: None
- Response codes:
200,304 - Transport options: None
- Source: OpenAPI reference
- TypeScript: Client interface
Inputs
- Client input type:
{ name: string } - Client transport options: None
Outputs
- Client return type:
{ name: string; source: string } - OpenAPI response codes:
200,304
import github from "@utdk/github";
type GitignoreGetTemplateInput = Parameters<typeof github.gitignore.getTemplate> extends [infer T, ...unknown[]] ? T : undefined;
type GitignoreGetTemplateOutput = Awaited<ReturnType<typeof github.gitignore.getTemplate>>;
const input: GitignoreGetTemplateInput = {} as { name: string };
const result: GitignoreGetTemplateOutput = await github.gitignore.getTemplate(input);
// Result shape (from schema): { name: string; source: string }