{Resource}

Resource overview

Auth & scopes

See conventions.md for the accepted credential types and how scopes are enforced. The operations on this page require:

Operation	OAuth2 scope	PAT scope
Read	read:{resource}	{resource}:read
Write	write:{resource}	{resource}:write
Administer	admin:{resource}	{resource}:admin

Endpoints

Method	Path	Summary
GET	/api/v1/.../{id}	Fetch a single {resource}
GET	/api/v1/...	List {resource}s (paginated)
POST	/api/v1/...	Create a {resource}
PATCH	/api/v1/.../{id}	Update a {resource}
DELETE	/api/v1/.../{id}	Delete a {resource}

GET /api/v1/.../{id}

Path parameters

Name	Type	Description
{id}	string	{what it identifies}

Query parameters

Name	Type	Default	Description
page	integer	1	See Pagination.
per_page	integer	25	See Pagination.

Request body

{
  "field": "value"
}

Response

{
  "id": "<uuid>",
  "field": "value"
}

Status codes

Status	When
200 OK	{success condition}
404 Not Found	{missing, or private and not readable — see Errors}

Example

curl -H "Authorization: Bearer <token>" \
  https://api.gitvetrix.com/api/v1/.../{id}

Errors

These endpoints use the shared error envelope and status-code conventions in errors.md. Document only the error codes or messages unique to this resource here; link the catalog for the rest.

Rate limits

These endpoints are metered under the standard scopes described in rate-limits.md. Call out any endpoint metered as api.expensive rather than api.read or api.write.