Documentation
¶
Overview ¶
Package contract renders ContentKit's route catalog (internal/httpapi) and error-code registry as the files other tools read: api/openapi.json, the Go client's methods (client_gen.go), the browser SDK's generated route table, wire types and error codes, and docs/api/routes.md. They are committed: `go generate ./internal/contract` rewrites them and TestGeneratedContractIsFresh fails when one is stale.
Index ¶
Constants ¶
const ( OpenAPIFile = "api/openapi.json" RoutesDoc = "docs/api/routes.md" SDKDir = "sdk/ui/src/client/generated/" )
Where each generated file lives, relative to the repository.
const GoClientFile = "client_gen.go"
GoClientFile is the generated Go client: a method on contentkit.Client per route.
const GoErrorCodesFile = "error_codes_gen.go"
GoErrorCodesFile holds the error codes as Go constants.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ErrorReply ¶
type ErrorReply struct {
Error string `json:"error"`
Code string `json:"code"`
RetryAfter int `json:"retry_after,omitempty"`
Action content.Action `json:"action,omitempty"`
Ban *content.BanNotice `json:"ban,omitempty"`
Blobs []string `json:"blobs,omitempty"`
Details *media.ErrorDetails `json:"details,omitempty"`
// Reason and AvailableAt explain a download_unavailable: the host
// policy's code and when the download opens.
Reason string `json:"reason,omitempty"`
AvailableAt *time.Time `json:"available_at,omitempty"`
}
ErrorReply is the flat error body every module answers. A code's own members appear only with it: retry_after with rate_limited and unavailable, action with an interaction's rate_limited, ban with comment_banned, blobs with not_uploaded, details with an upload refusal.
Source Files
Directories