Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conformance #266

Open
jonathanrobie opened this issue Apr 29, 2021 · 2 comments
Open

Conformance #266

jonathanrobie opened this issue Apr 29, 2021 · 2 comments
Assignees
Labels
Documentation Things to include or change in the doc
Milestone

Comments

@jonathanrobie
Copy link
Collaborator

What does it mean to confirm to the Scripture Burrito specification?

We need to define both (1) conformance for readers and (2) conformance for writers.

For readers, perhaps a system needs to identify one or more flavors that it can read, and it needs to be able to read any valid Burrito of that flavor.

For writers, we need to consider extensibility and x- flavors, etc.

@jonathanrobie
Copy link
Collaborator Author

Do implementations need to support .zip?

@jag3773 jag3773 added this to the SB 1.0.0-beta milestone Nov 18, 2021
@jag3773
Copy link
Collaborator

jag3773 commented Nov 18, 2021

Add a section to documentation for "Conformance" which describes the following:

  • if you support SB, then:
    • you should list the flavorTypes that your application can use (including custom flavorTypes, if applicable)
    • list the schema versions that you support
    • indicate whether you can only read and/or write SBs
    • graciously error on flavorTypes that you don't support (let user know that flavorType is not supported)

@jag3773 jag3773 added the Documentation Things to include or change in the doc label Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Things to include or change in the doc
Projects
None yet
Development

No branches or pull requests

3 participants