feat(data): create a schema for definitions #93
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
CZDanol
reviewed
Nov 18, 2025
Collaborator
CZDanol
left a comment
CZDanol
left a comment
There was a problem hiding this comment.
I'm sorry, I don't have enough time to do a proper review. The idea sounds good, found some nitpicks on a quick skim.
data/schema/config.yaml
Outdated
| # this pattern enables vendored and versioned mime types, e.g., | ||
| # - application/vnd.openprinttag.v2 | ||
| # - application/vnd.openprinttag+cool-feature | ||
| pattern: "^application/vnd\\.openprinttag(\\.[a-z0-9]+|\\+[a-z0-9]+)*$" |
Collaborator
There was a problem hiding this comment.
Let's restrict this to only application/. Even us (Prusa) are using this format for some other things than just openprinttag ;)
Plus, vnd.openprinttag vendor tree is now registered by us, so it's not something anyone can use for their own spinoffs.
Contributor
Author
There was a problem hiding this comment.
You mean "application/vnd.openprinttag" strictly and no sub-vendoring stuff, correct?
Contributor
Author
There was a problem hiding this comment.
(potentially) Fixed in johnlettman@7067d2a
(squashed)
Contributor
Author
No worries at all.
Will fix all, thank you! |
johnlettman
added a commit
to johnlettman/pr-prusa3d-openprinttag
that referenced
this pull request
Nov 18, 2025
johnlettman
added a commit
to johnlettman/pr-prusa3d-openprinttag
that referenced
this pull request
Nov 18, 2025
johnlettman
added a commit
to johnlettman/pr-prusa3d-openprinttag
that referenced
this pull request
Nov 18, 2025
This commit creates several schemas covering all definition YAML files in the OpenPrintTag standard. These schemas can be useful in enforcing certain standards and criteria for valid information in the definitions while also instructing editors and IDEs as to the valid fields, their contents, and their type information. Further, many editors can use these schemas to provide contextual information about each field -- of note, descriptions and hints. A small, but nice feature, is the ability to enforce certain naming schemes. For example, all tags use the format of `my_tag_name` with lowercase characters an underscores separating each word. A simple regular expression ensures a stand-out, such as `MyTAG--NAME` would not be considered valid. Additionally, the schemas formalize the structure of each file. They can provide a source of truth as to what is considered valid and required for a definition. Lastly, tools such as `pre-commit` can use these schemas to check whether an addition fits the conventions prior to a commit or within a pull request. fix(schema): make `mime_type` const "application/vnd.openprinttag" Fix for prusa3d#93 (comment) fix(schema): use "Identifier" verbiage for `key` across schemas Fix for prusa3d#93 (comment) fix(schema): drop `required: required` from `fields` Fix for prusa3d#93 (comment)
johnlettman
force-pushed
the
feat/schema
branch
from
7067d2a to
6fa48cc
Compare
Contributor
Author
|
Rebasing to resolve conflicts. |
This commit adds the `color_rgba` type, a simple alias to `bytes` with a `max_length` of 4. The more explicit use of `color_rgba` as a type can signal to implementing libraries that the data within the field could be interpreted as a color. This can enable features such as encoding or displaying the color in a different format, performing color operations, and so on.
Maximum allowed value is 320.
BFW-8077
BFW-8092
Authored by MartinPoupa, I've just tweaked the wording a little. BFW-8092 Co-Authored-By: MartinPoupa <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR creates several schemas covering all definition YAML files in the OpenPrintTag standard.
These schemas can be useful for enforcing standards and criteria for valid information in the definitions, while also instructing editors and IDEs about the valid fields, their contents, and their type information. Further, many editors can use these schemas to provide contextual information for each field -- notably, descriptions and hints.
A small but nice feature is the ability to enforce certain naming schemes. For example, all tags use the format of
my_tag_namewith lowercase characters and underscores separating each word. A simple regular expression ensures a stand-out, such asMyTAG--NAMEwould not be considered valid.Additionally, the schemas formalize the structure of each file. They can serve as a source of truth for what is considered valid and required for a definition.
Lastly, tools such as
pre-commitcan use these schemas to check whether an addition adheres to the conventions before a commit or within a pull request.Currently, the schemas are namespaced to
https://specs.openprinttag.org/schema/. The PR usesgenerate.pyto insert the schemas intodocs, which appear to push tospecs.openprinttag.org:OpenPrintTag/docs_src/generate.py
Lines 90 to 91 in 7db85ec
In each
datadefinition, theyaml-language-serverused by most editors and IDEs to perform YAML inspections is configured to use a relative path to reference the schemas. This could theoretically be changed to use the namespace URL; however, since they are packaged with the repository, it seems more sensible to keep them relative.