gin-gonic/gin

Can another program use it through a documented, machine-readable surface?

• next: [service] L2 A contract exists: a checked-in OpenAPI/GraphQL/protobuf/AsyncAPI spec, a framework-generated spec, MCP tool schemas, or a standard application protocol that off-the-shelf clients speak (RESP, MQTT, gRPC, PostgreSQL wire, …). (no machine-readable contract)
• next: [library] L4 An API reference is generated from the code (autodoc, mkdocstrings, typedoc, …). (no generated API reference)

library ladder · level 3

• ✓ L1 An importable, packaged API exists. go.mod Go module with exported packages
• ✓ L2 The public API is delimited (__all__, an exports map, exported identifiers). go.mod exported identifiers
• ✓ L3 The public API is statically typed (py.typed, type declarations, a typed language). go.mod statically typed language
• ✗ L4 An API reference is generated from the code (autodoc, mkdocstrings, typedoc, …). no generated API reference

service ladder · level 1

• ✓ L1 A network surface exists: HTTP routes, an MCP server, or a standard protocol listener. binding/form_mapping.go go-http: 8 route declarations
• ✗ L2 A contract exists: a checked-in OpenAPI/GraphQL/protobuf/AsyncAPI spec, a framework-generated spec, MCP tool schemas, or a standard application protocol that off-the-shelf clients speak (RESP, MQTT, gRPC, PostgreSQL wire, …). no machine-readable contract
• ✗ L3 A contract covers its transport: an HTTP contract covers at least 80% of declared routes (generated contracts do), or the application layer over a standard protocol (commands, topics, payloads) is specified in a protocol document or AsyncAPI. no contract
• ✗ L4 A second surface: another transport (HTTP and a protocol, two protocols), an MCP server, a CLI with JSON output, or an SDK. only one programmatic surface

Can integrators rely on it not changing under them?

• next: L3 A deprecation mechanism is used in code (warnings, @deprecated, Deprecation/Sunset headers) or the API is versioned. (no deprecation mechanism or API versioning)

all ladder · level 2

• ✓ L1 Releases are versioned (semver tags or versioned changelog sections). 36 semver tags, latest v1.12.0
• ✓ L2 A changelog exists and marks breaking changes. CHANGELOG.md marks breaking changes
• ✗ L3 A deprecation mechanism is used in code (warnings, @deprecated, Deprecation/Sunset headers) or the API is versioned. no deprecation mechanism or API versioning
• ✓ L4 Across tagged releases, no OpenAPI operation, CLI option or __all__ symbol was removed without first being deprecated. 20 tagged releases compared

Can others react to state changes without polling?

• next: L3 Signed webhooks registrable through the API, or two mechanisms (webhooks, streams, a broker). (one delivery mechanism, or webhooks that are unsigned or not registrable through the API)

service ladder · level 2

• ✓ L1 Internal events exist (signals, queues, an outbox, emitters). context.go 2 matches
• ✓ L2 Webhooks sent by this system, or a streaming endpoint (SSE, WebSocket). context.go 2 matches
• ✗ L3 Signed webhooks registrable through the API, or two mechanisms (webhooks, streams, a broker). one delivery mechanism, or webhooks that are unsigned or not registrable through the API
• ✗ L4 Events are described by AsyncAPI or CloudEvents. no AsyncAPI or CloudEvents contract

Can a machine act with its own revocable, least-privilege identity?

• next: L1 Programmatic authentication (bearer tokens, API keys). (no token auth)

service ladder · level 0

• ✗ L1 Programmatic authentication (bearer tokens, API keys). no token auth
• ✗ L2 Per-client, revocable credentials (managed API keys, service accounts) or OAuth2. no managed keys or OAuth
• ✗ L3 Credentials carry scopes or permissions. no scopes or permissions
• ✗ L4 Standard provisioning or federation (OIDC client credentials, SCIM). no OIDC client credentials or SCIM

Can its data get in and out, in bulk, in open formats, with an explicit schema?

• next: L1 The data schema is explicit (migrations, DDL, schema files). (no migrations or schema files)

all ladder · level 0

• ✗ L1 The data schema is explicit (migrations, DDL, schema files). no migrations or schema files
• ✗ L2 An export exists (endpoint or command, not only the UI). no export
• ✗ L3 A bulk export in an open format, and a bulk import. no open export format
• ✗ L4 The export format is documented and the round trip is tested. the export format isn't documented

Can an automated caller use it without guessing, and recover from failure?

• next: [service] L1 Errors are machine-readable: consistent JSON over HTTP, or a standard protocol's native error replies (RESP errors, MQTT reason codes, gRPC status, SQLSTATE). (no machine-readable errors)
• next: [library] L1 Errors are specific exception types, and library code never calls sys.exit. (no exception classes)

library ladder · level 0

• ✗ L1 Errors are specific exception types, and library code never calls sys.exit. no exception classes
• ✗ L2 Inputs are validated with messages naming the bad argument. no input validation errors
• ✗ L3 Timeouts and retries are configurable. no timeout parameter
• ✗ L4 Agent docs, and examples that run as tests (doctests). no agent docs

service ladder · level 0

• ✗ L1 Errors are machine-readable: consistent JSON over HTTP, or a standard protocol's native error replies (RESP errors, MQTT reason codes, gRPC status, SQLSTATE). no machine-readable errors
• ✗ L2 Field-level validation errors, and paginated lists. no pagination
• ✗ L3 Typed errors (RFC 9457 over HTTP, or a standard protocol's typed error codes), idempotent writes (Idempotency-Key), and rate-limit signals. no typed errors
• ✗ L4 Dry-run or validate-only, conditional requests, and agent docs. no dry-run

Can another system run and compose it without a human?

• next: [service] L2 Configured through environment variables, documented: a .env example, a config schema, or docs naming at least half of the variables the code reads. (configuration isn't read from the environment)
• next: [library] L4 Optional features behind extras/features. (no optional extras)

library ladder · level 3

• ✓ L1 Importable from source. go.mod Go module with exported packages
• ✓ L2 Installable as a package (a package manifest). go.mod package manifest
• ✓ L3 Published to a public registry, with at most 10 runtime dependencies. .github/workflows/goreleaser.yml 6 matches unknown number of runtime dependencies
• ✗ L4 Optional features behind extras/features. no optional extras

service ladder · level 1

• ✓ L1 Runnable from source with documented steps (a README with commands). README.md
• ✗ L2 Configured through environment variables, documented: a .env example, a config schema, or docs naming at least half of the variables the code reads. configuration isn't read from the environment
• ✗ L3 A container image. no Dockerfile
• ✗ L4 Composition artifacts (compose, Helm, IaC). no compose/Helm/IaC

Can behaviour be added without modifying the code?

• next: L1 Internal seams: a registry, registration function or plugin manager. (no registry or registration function)

all ladder · level 0

• ✗ L1 Internal seams: a registry, registration function or plugin manager. no registry or registration function
• ✗ L2 The docs show how to add behaviour through those seams (even in-tree). no registration functions to document
• ✗ L3 Out-of-tree extensions are discovered (entry points, a plugin directory, configuration) without editing the package. extensions must be added inside the package
• ✗ L4 The extension API is versioned, has lifecycle hooks, and has example extensions. the extension API isn't versioned

Can an operator, or an orchestrating agent, tell whether it works and why not?

• next: [service] L1 A health or readiness endpoint, or a container healthcheck. (no health endpoint or healthcheck)
• next: [library] L1 Logs through a standard logger namespace and never prints from library code. (no standard logger)

library ladder · level 0

• ✗ L1 Logs through a standard logger namespace and never prints from library code. no standard logger
• ✗ L2 Log levels are used meaningfully (at least two levels). fewer than two log levels used
• ✗ L3 Optional metrics or tracing hooks. no metrics or tracing hooks
• ✗ L4 OpenTelemetry instrumentation available. no OpenTelemetry instrumentation

service ladder · level 0

• ✗ L1 A health or readiness endpoint, or a container healthcheck. no health endpoint or healthcheck
• ✗ L2 Structured logs. no structured logging
• ✗ L3 Metrics. no metrics
• ✗ L4 Distributed tracing (OpenTelemetry). no tracing

Can an agent change it safely with limited context?

• next: L3 At least 90% of modules fit 32k tokens and no file exceeds 12k; test/source token ratio at least 0.3; at least 70% of the code is typed. (86% of modules fit 32k tokens; 1 files over 12k)

all ladder · level 2

• ✓ L1 A README and some tests. README.mdauth_test.go 40 test files
• ✓ L2 CI runs the tests; applications pin dependencies (libraries and zero-dependency projects are exempt). .github/workflows/codeql.yml.github/workflows/gin.yml
• ✗ L3 At least 90% of modules fit 32k tokens and no file exceeds 12k; test/source token ratio at least 0.3; at least 70% of the code is typed. 86% of modules fit 32k tokens; 1 files over 12k
• ✗ L4 No import cycles, and agent docs (AGENTS.md, CLAUDE.md, llms.txt). no agent docs (AGENTS.md, CLAUDE.md, llms.txt)