Repository navigation
docs(schemas): move IN-003 pin to fd5f036 and record naming decision - #49
Merged
Merged
Conversation
The pin moves from acfa2b9 to fd5f0363b0e6a634e9d98e2c64e2d89157d74cef. Only the examples layout changed upstream. The schema and spec text are the same, so the mapping table is unchanged. The README now states that IN-003 field names are authoritative and the descriptor is a superset. It also records the answers an AMWA contributor gave on in-003#4: the schema is permissive at this phase, identity waits for the ledger, and the host_capabilities placement is still under investigation upstream. Refs dmfdeploy/dmfdeploy#746 Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
State the pin move accurately: the manifest schema and overview are unchanged, and upstream added a submodule, a PDF and a README edit. Describe the IN-003 name-and-shape alignment as the decision that is still to be implemented, and note in the mapping table where the shape differs today. Keep the unknown-key question as unanswered, since the contributor only described general permissiveness. Refs dmfdeploy/dmfdeploy#746 Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
The schema rejects unknown keys in its fixed objects, but extension bodies and patterned maps accept unlisted keys, so a misspelled key in an extension body isn't caught. The README now says so. The export plan no longer mentions a frame-rate conversion: under the naming decision, fields that differ in shape take the IN-003 shape first, so the export needs no conversion for them. Refs dmfdeploy/dmfdeploy#746 Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
The closed-content note listed the places that accept unlisted keys, and the list was incomplete. It now says some values are deliberately open, gives extension bodies as an example, and points to the schema file as the definition. Refs dmfdeploy/dmfdeploy#746 Signed-off-by: znerol2 <6800371+znerol2@users.noreply.github.com>
lkirc
approved these changes
Nov 6, 2026
lkirc
left a comment
lkirc
left a comment
There was a problem hiding this comment.
Static review complete. The updated documentation accurately distinguishes planned compatibility work from the current implementation, and the refreshed IN-003 pin is substantiated. No blocking findings.
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
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.
Summary
Pin: moves the IN-003 pin in
schemas/README.mdfromacfa2b9tofd5f036. Upstream left the manifest schema anddocs/Overview.mdunchanged. It reorganised the examples, added thelib/mxlsubmodule and a JT-DMF high-level PDF, and edited its root README.Decision note: IN-003 field names are authoritative, and the descriptor is a superset (Keep the media function descriptor compatible with AMWA IN-003 as it evolves dmfdeploy#746).
AMWA's answers on Questions from mapping a function descriptor to IN-003 AMWA-TV/in-003#4, in our own words:
host_capabilitiesplacement is still under investigation upstream.Current versus decided: the README states name-and-shape alignment as the decision, still to be implemented. Rows that differ in shape today (frame rate, CPU and network host capabilities) say so in a Note column. The export and pinned-schema test are marked as planned.
Q1: our unknown-keys question is still unanswered upstream.
No descriptor field is renamed or reshaped. Renames to IN-003 names come as one batch before #637.
Checks
yamllint .: clean.bin/check-review-comments.sh: clean.Refs dmfdeploy/dmfdeploy#746