Reflect the latest registry changes in openapi.yaml (#345)

<!-- Provide a brief summary of your changes -->

## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
The following PR:
* Adds a new `transport` type used in Package and Remotes
* Added `docker` to the `runtime_hint` examples
* Added support for templated URLs. It is available for streamable-http
and sse transports for Packages. I didn't thought of reasons to have
this for Remotes, but we can enable it if needed.
* Added validation for templated URLs so we can ensure all referenced
placeholder variables are available.
* For streamable-http and SSE transport types the URL is now a required
property
* Updated the publisher init command to reflect these changes
* Updated the seed.json file
* Added unit tests for the transport type related changes
* Updated the server.json schema and the external pkg structs to reflect
the new transport type
* Updated the examples

Thanks to @kkkarthik for spotting it! 🙏 

## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->
Ran the tests locally

## Breaking Changes
<!-- Will users need to update their code or configurations? -->
Yes

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update

## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->
- [ ] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [ ] My code follows the repository's style guidelines
- [ ] New and existing tests pass locally
- [ ] I have added appropriate error handling
- [ ] I have added or updated documentation as needed

## Additional context
<!-- Add any other context, implementation notes, or design decisions
-->

---------

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
This commit is contained in:
Radoslav Dimitrov 2025-09-05 23:07:08 +03:00 • committed by GitHub
commit e0e51eae37
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 1192 additions and 488 deletions

View file

@ -36,7 +36,7 @@ type ServerJSON struct {
Repository model.Repository `json:"repository,omitempty"`
VersionDetail model.VersionDetail `json:"version_detail"`
Packages []model.Package `json:"packages,omitempty"`
Remotes []model.Remote `json:"remotes,omitempty"`
Remotes []model.Transport `json:"remotes,omitempty"`
Meta *ServerMeta `json:"_meta,omitempty"`
}

View file

@ -9,6 +9,13 @@ const (
StatusDeleted Status = "deleted"
)
// Transport represents transport configuration with optional URL templating
type Transport struct {
Type string `json:"type"`
URL string `json:"url,omitempty"`
Headers []KeyValueInput `json:"headers,omitempty"`
}
// Package represents a package configuration
type Package struct {
// RegistryType indicates how to download packages (e.g., "npm", "pypi", "oci", "mcpb")
@ -20,19 +27,12 @@ type Package struct {
Version string `json:"version" minLength:"1"`
FileSHA256 string `json:"file_sha256,omitempty"`
RunTimeHint string `json:"runtime_hint,omitempty"`
TransportType string `json:"transport_type,omitempty"`
Transport Transport `json:"transport,omitempty"`
RuntimeArguments []Argument `json:"runtime_arguments,omitempty"`
PackageArguments []Argument `json:"package_arguments,omitempty"`
EnvironmentVariables []KeyValueInput `json:"environment_variables,omitempty"`
}
// Remote represents a remote connection endpoint
type Remote struct {
TransportType string `json:"transport_type"`
URL string `json:"url" format:"uri"`
Headers []KeyValueInput `json:"headers,omitempty"`
}
// Repository represents a source code repository as defined in the spec
type Repository struct {
URL string `json:"url"`