registry/internal
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
..
api Improve golang type documentation and examples (#631) 2025-10-16 21:55:52 +01:00
auth Apply gofmt formatting to all Go files (#588) 2025-09-30 17:32:22 +03:00
config Apply gofmt formatting to all Go files (#588) 2025-09-30 17:32:22 +03:00
database Fix migration numbering and add migration 010 for package format (#675) 2025-10-15 17:00:39 +03:00
importer Enforce schema validation on the publish and edit API level (#598) 2025-10-05 13:57:10 +01:00
service Enforce schema validation on the publish and edit API level (#598) 2025-10-05 13:57:10 +01:00
telemetry Add OpenTelemetry metrics instrumentation (#290) 2025-08-21 14:23:37 +01:00
validators Use distribution/reference for parsing OCI references (#651) 2025-10-14 15:27:57 +03:00