Skip to content

Week of March 30#452

Merged
duglin merged 4 commits into
xregistry:mainfrom
duglin:Mar30
Apr 6, 2026
Merged

Week of March 30#452
duglin merged 4 commits into
xregistry:mainfrom
duglin:Mar30

Conversation

@duglin

@duglin duglin commented Mar 31, 2026

Copy link
Copy Markdown
Contributor
  • fix typos w.r.t. capabilityofferings
  • Change how express format and compat validation requests/status
  • make ?doc not include formatvalidated and compatibilityvalidated attributes
/capabilities
{
  "formats": [ "avro", "protobuf", "jsonSchema" ],
  "compatibilities": {
    "avro": [ "backward", "forward", "full" ],
    "protobf": [ "backward" ]
  } 
}

/model  (on RESOURCE definition)
{
  ...
  "validateformat": <BOOLEAN>,              # Default is true
  "validatecompatibility": <BOOLEAN>,       # Default is true. If true then validateformat MUST be true
  "strictvalidation": <BOOLEAN>,            # Default is false. Block unknown format/compat values?
  ...
}


/...RESOURCE
{
  ...
  "format": "<STRING>", ?                  # Absent=no validation. Unknown values are ignored
  "formatvalidated": <BOOLEAN>, ?          # Absent=disabled. False=unknown format value. Read-only
  "compatibilityvalidated": <BOOLEAN>, ?   # Absent=disabled. False=unknown format/compat value. Read-only
  ...
  "meta": {
    ...
    "compatability": "<STRING>", ?          # Absence=no validation. Unknown values are ignored
    ...
  }
}

Fixes: #447
Fixes: #449

Signed-off-by: Doug Davis <duglin@gmail.com>
Comment thread core/model.md Outdated
"typemap": <MAP>, ? # Contenttype mappings
"validatecompatibility": <BOOLEAN>, ? # Do Version compat checks. Default=true
"validateformat": <BOOLEAN>, ? # Do Version format checks. Default=true
"strictvalidation": <BOOLEAN>, ? # Allow unknown format/compat. Default=false

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be "block unkown format/compat"?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch - fixed!

Comment thread core/spec.md Outdated
"validateformat": <BOOLEAN>, ? # Check version format compliance
"validatecompatibility": <BOOLEAN>, ? # Check version compatibility. Default=true
"validateformat": <BOOLEAN>, ? # Check version format compliance. Default=true
"strictvalidation": <BOOLEAN>, ? # Allow unknown format/compat. Default=false

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above, if strict = true then we block

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

- make ?doc not include formatvalidated and compatibilityvalidated attributes

Signed-off-by: Doug Davis <duglin@gmail.com>
duglin added 2 commits April 2, 2026 13:02
Signed-off-by: Doug Davis <duglin@gmail.com>
Signed-off-by: Doug Davis <duglin@gmail.com>
@duglin

duglin commented Apr 6, 2026

Copy link
Copy Markdown
Contributor Author

Approved on the 4/2 call

@duglin
duglin merged commit 010a3fb into xregistry:main Apr 6, 2026
2 checks passed
@duglin
duglin deleted the Mar30 branch April 6, 2026 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a "supported formats" and "supported compatibilities" type of capabilities validatecompat & meta.compat vs validateformat & version.format

2 participants