registry/internal/api/handlers/v0
Repository files (latest commit first)
Filename Latest commit message Latest commit date
adam jones f870a4c000
Improve golang type documentation and examples (#631)
Enhanced Go struct tags throughout `pkg/api/v0/types.go` and
`pkg/model/types.go` to better align with the OpenAPI specification.

## Changes

- Added comprehensive `doc` tags with detailed field descriptions
matching OpenAPI
- Added `example` tags showing valid values for fields (e.g.,
`"io.github.user/weather"`, `"npx"`)
- Added `format` tags (`uri`, `date-time`) for better type specification
- Added `pattern` and `enum` tags for validation constraints
- Added `placeholder` field to `Input` struct matching OpenAPI spec
- Removed redundant comments in favor of inline struct tags

These changes improve code clarity and make the types more
self-documenting, while maintaining compatibility with the OpenAPI
schema definitions in `docs/reference/api/openapi.yaml`.

---------

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Radoslav Dimitrov <radoslav@stacklok.com>
2025-10-16 21:55:52 +01:00
..
auth Replace / with - for operation IDs (#660) 2025-10-14 15:26:43 +03:00
edit.go Replace / with - for operation IDs (#660) 2025-10-14 15:26:43 +03:00
edit_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
health.go Replace / with - for operation IDs (#660) 2025-10-14 15:26:43 +03:00
health_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
ping.go Replace / with - for operation IDs (#660) 2025-10-14 15:26:43 +03:00
ping_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
publish.go Replace / with - for operation IDs (#660) 2025-10-14 15:26:43 +03:00
publish_integration_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
publish_registry_validation_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
publish_test.go Improve golang type documentation and examples (#631) 2025-10-16 21:55:52 +01:00
response.go auth: New auth flow (#273) 2025-08-15 13:03:35 +01:00
servers.go Replace / with - for operation IDs (#660) 2025-10-14 15:26:43 +03:00
servers_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
telemetry_test.go Introduce v0.1 version of the API (#658) 2025-10-14 11:04:48 +03:00
version.go Introduce a /version API (#667) 2025-10-15 17:24:46 +03:00
version_test.go Introduce a /version API (#667) 2025-10-15 17:24:46 +03:00