Skip to main content

Public API index

This is a navigation index, not a substitute for Go package documentation.

PackagePrimary public API
platform/bootstrapSpec, Deps, Dep, Required, Degrade, Migrations, App, Go, Background, Closer, Probe, Run
platform/configOptions, Validator, Load, Base, Configurer, Server, InternalAuth, OpenAPI, PlatformDefaults, CheckSecret
platform/httpHandler, Handle, HandleOptional, HandleVoid, HandleRaw, Created, Accepted, Response, JSON, Blob, RouterSpec, RouteSet, GET/POST/PUT/PATCH/DELETE, Roles, Public, Optional, Streaming, OpID, Problem
platform/errorsCode, Error, classification constructors, Wrap, CodeOf, Message, Details, Classified, Is helpers
platform/pagingRequest, NewRequest, Info, NewInfo, InfoFor, Page, NewPage, Empty, MapPage, Params, SortKey
platform/security/identitySubject, Delegation, Kind, Scope, With, From, Require, MustFrom
platform/database/sqlDB, Querier, Tx, Config, Open, Manager, NewManager, TxFrom, Repo, NewRepo, Query, predicates, SQL, SQLOne, Conn, MapError
platform/database/sql/pgxPool, Tracer
platform/cacheCache, Scope, Store, New, Memory, GetOrLoad, Invalidating, GetOrLoadAhead
platform/cache/redisConfig, Store, Open, NewStore
platform/eventsEvent, Bus, Handler, Topic, NewTopic, Memory, Outbox, Dispatcher
platform/events/amqpConfig, Bus, Open
platform/observability/healthChecker, CheckerFunc, Registry, Result, Report
platform/grpcCodeOf, Status, FromStatus

For exact signatures and method sets, run:

DX_COMMON_GO=../dx-common-go bash scripts/gen-api.sh

The generator writes a source-reference and exported declaration inventory to docs/reference/generated-api.md.