Extend release validation to support v1 API files #42
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
theory
force-pushed
the
api-properties
branch
2 times, most recently
from
8390531 to
5275c9b
Compare
The API Server adds additional properties to the [Meta API], an which here is called Release (because it contains release metadata). This caused validation to fail for metadata fetched from api.pgxn.org. Extend the validation of Release metadata to optionally include these properties. Define a new v1 schema, `api-extras.schema.json`, and add it to `release.schema.json`. Like the existing schemas, it applies strict validation for the new properties. Since the new schemas validate file paths, copy `path.schema.json` from the v2 schemas and apply it to the other paths in the v1 schema. Increment to v0.6.0 and prep for release. [Meta API]: https://github.com/pgxn/pgxn-api/wiki/meta-api#api-server-structure
vrmiguel
approved these changes
Mar 25, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The API Server adds additional properties to the Meta API, an which here is called Release (because it contains release metadata). This caused validation to fail for metadata fetched from api.pgxn.org.
Extend the validation of Release metadata to optionally include these properties. Define a new v1 schema,
api-extras.schema.json, and add it torelease.schema.json. Like the existing schemas, it applies strict validation for the new properties.Since the new schemas validate file paths, copy
path.schema.jsonfrom the v2 schemas and apply it to the other paths in the v1 schema.Increment to v0.6.0 and prep for release.