8d7e471fd3<!-- Provide a brief summary of your changes -->
This PR serves as a placeholder and brings together all of the changes
related to supporting vendor extensions passed through the API. The idea
is to have a single place to track and review the work as it comes
together (even if it’s still a bit of a work in progress).
**The changes in this PR cover:**
* Updates on the data model
* Updates on both databases (in-memory and postgresql), added a new
table to PSQL for tracking the extensions leaving the server table only
for the clean server.json properties
* Updates the seed.json file (thus the big line change)
* Adds a seed-migrate tool to help migrating an existing seed file to
the new format
* Updates the seed import mechanism to support this
* Updates the existing tests - unit, integration and validation tests
* Adds the publish handler to the OpenAPI spec (it was missing)
* Fixes linting errors
* Updates on the API side on (publish, list, get) to support the new
format of `ServerResponse` -
```
{
"server": {},
"x-io.modelcontextprotocol.registry": {}, /*not available for publish since this gets populated by the registry*/
"x-publisher": {}
}
```
## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
Motivated by the discussions in:
https://github.com/modelcontextprotocol/registry/discussions/284
## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->
Locally and by running all of the tests
## Breaking Changes
<!-- Will users need to update their code or configurations? -->
Yes, it changes both the API and the format of the seed file
## 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
---
Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
Co-authored-by: adam jones <domdomegg+git@gmail.com>
38 lines
No EOL
1.4 KiB
Markdown
38 lines
No EOL
1.4 KiB
Markdown
# Migration Test Data
|
|
|
|
This directory contains golden files for testing the seed migration CLI tool.
|
|
|
|
## Files
|
|
|
|
- **`legacy-input.json`** - Sample input file in the legacy seed format (flat structure with registry metadata mixed in)
|
|
- **`expected-output.json`** - Expected output after migration to extension wrapper format
|
|
|
|
## Usage
|
|
|
|
The golden file test (`TestMigrationCLI_GoldenFile`) runs the migration tool on `legacy-input.json` and compares the output against `expected-output.json` to ensure the migration produces the correct result.
|
|
|
|
## Updating Golden Files
|
|
|
|
If you make changes to the migration logic, you may need to update the expected output:
|
|
|
|
1. Review the changes to ensure they're correct
|
|
2. Regenerate the expected output:
|
|
```bash
|
|
cd cmd/migrate-seed
|
|
../../bin/migrate-seed testdata/legacy-input.json testdata/expected-output.json
|
|
```
|
|
3. Verify the new output is correct by reviewing the diff
|
|
4. Run the tests to ensure they pass
|
|
|
|
## Format Details
|
|
|
|
### Legacy Input Format
|
|
- Flat JSON array of server objects
|
|
- Registry metadata fields (`id`, `is_latest`, `release_date`) mixed directly in server objects
|
|
- Version detail contains registry metadata
|
|
|
|
### Expected Output Format
|
|
- Extension wrapper format
|
|
- Each server wrapped in `"server"` field
|
|
- Registry metadata in `"x-io.modelcontextprotocol.registry"` extension
|
|
- No `"x-publisher"` extensions for seed data |