modelcontextprotocol/registry
Watch
1
0
Fork
You've already forked registry
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve golang type documentation and examples (#631)

Browse source 
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>
This commit is contained in:
adam jones 2025-10-16 21:55:52 +01:00 • committed by GitHub
commit f870a4c000
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 78 additions and 101 deletions
Download patch file Download diff file Expand all files Collapse all files

40
internal/api/handlers/v0/publish_test.go
View file

@ -131,7 +131,7 @@ func TestPublishEndpoint(t *testing.T) {
name: "invalid token",
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "test-server",
Name: "example/test-server",
Description: "A test server",
Version: "1.0.0",
},
@ -252,8 +252,8 @@ func TestPublishEndpoint(t *testing.T) {
},
},
setupRegistryService: func(_ service.RegistryService) {},
expectedStatus: http.StatusBadRequest,
expectedError: "server name cannot contain multiple slashes",
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "expected string to match pattern",
},
{
name: "invalid server name - multiple slashes (three slashes)",
@ -270,8 +270,8 @@ func TestPublishEndpoint(t *testing.T) {
},
},
setupRegistryService: func(_ service.RegistryService) {},
expectedStatus: http.StatusBadRequest,
expectedError: "server name cannot contain multiple slashes",
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "expected string to match pattern",
},
{
name: "invalid server name - consecutive slashes",
@ -288,8 +288,8 @@ func TestPublishEndpoint(t *testing.T) {
},
},
setupRegistryService: func(_ service.RegistryService) {},
expectedStatus: http.StatusBadRequest,
expectedError: "server name cannot contain multiple slashes",
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "expected string to match pattern",
},
{
name: "invalid server name - URL-like path",
@ -306,8 +306,8 @@ func TestPublishEndpoint(t *testing.T) {
},
},
setupRegistryService: func(_ service.RegistryService) {},
expectedStatus: http.StatusBadRequest,
expectedError: "server name cannot contain multiple slashes",
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "expected string to match pattern",
},
{
name: "invalid server name - many slashes",
@ -324,8 +324,8 @@ func TestPublishEndpoint(t *testing.T) {
},
},
setupRegistryService: func(_ service.RegistryService) {},
expectedStatus: http.StatusBadRequest,
expectedError: "server name cannot contain multiple slashes",
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "expected string to match pattern",
},
{
name: "invalid server name - with packages and remotes",
@ -363,8 +363,8 @@ func TestPublishEndpoint(t *testing.T) {
},
},
setupRegistryService: func(_ service.RegistryService) {},
expectedStatus: http.StatusBadRequest,
expectedError: "server name cannot contain multiple slashes",
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "expected string to match pattern",
},
}
@ -447,25 +447,25 @@ func TestPublishEndpoint_MultipleSlashesEdgeCases(t *testing.T) {
{
name: "invalid - trailing slash after valid name",
serverName: "com.example/server/",
expectedStatus: http.StatusBadRequest,
expectedStatus: http.StatusUnprocessableEntity,
description: "Trailing slash creates multiple slashes",
},
{
name: "invalid - leading and middle slash",
serverName: "/com.example/server",
expectedStatus: http.StatusBadRequest,
expectedStatus: http.StatusUnprocessableEntity,
description: "Leading slash with middle slash",
},
{
name: "invalid - file system style path",
serverName: "usr/local/bin/server",
expectedStatus: http.StatusBadRequest,
expectedStatus: http.StatusUnprocessableEntity,
description: "File system style paths should be rejected",
},
{
name: "invalid - version-like suffix",
serverName: "com.example/server/v1.0.0",
expectedStatus: http.StatusBadRequest,
expectedStatus: http.StatusUnprocessableEntity,
description: "Version suffixes with slash should be rejected",
},
}
@ -517,9 +517,9 @@ func TestPublishEndpoint_MultipleSlashesEdgeCases(t *testing.T) {
assert.Equal(t, tc.expectedStatus, rr.Code,
"%s: expected status %d, got %d", tc.description, tc.expectedStatus, rr.Code)
if tc.expectedStatus == http.StatusBadRequest {
assert.Contains(t, rr.Body.String(), "server name cannot contain multiple slashes",
"%s: should contain specific error message", tc.description)
if tc.expectedStatus == http.StatusUnprocessableEntity {
assert.Contains(t, rr.Body.String(), "expected string to match pattern",
"%s: should contain pattern validation error", tc.description)
}
})
}