Skip to content

Add first draft of the Jelly-Patch specification#42

Merged
Ostrzyciel merged 11 commits intomainfrom
patch-spec-1
May 6, 2025
Merged

Add first draft of the Jelly-Patch specification#42
Ostrzyciel merged 11 commits intomainfrom
patch-spec-1

Conversation

@Ostrzyciel
Copy link
Member

Issue: Jelly-RDF/jelly-protobuf#11

Follows the proto content from: Jelly-RDF/jelly-protobuf#67

First spec draft formalizing what is written as comments in the proto and how the current prototype implementation in Jelly-JVM behaves.

Notable things:

  • Some of the sections are identical as in Jelly-RDF, so I factored them out as includes in the includes directory.
  • I've also included some minor changes to the Jelly-RDF spec, to clarify a few things (like: wonky language, or it is the consumers who should throw the error).
  • I've added the Jelly-Patch media type and file extension.
  • And I've added links to the spec from a few places on the website.

@Ostrzyciel Ostrzyciel requested a review from adanilenka May 6, 2025 10:14
@adanilenka
Copy link
Collaborator

@Ostrzyciel If possible, I would suggest adding more info on the PATCH_STREAM_TYPE_PUNCTUATED type. For instance, as both patches and transactions can span multiple patch frames, the explicit wording on "transactions must start and end inside one patch" or smth like that would be nice or that punctuation message should not occur inside an ongoing transaction.
So similar to PATCH_STREAM_TYPE_FRAME description

Ostrzyciel and others added 4 commits May 6, 2025 15:25
Co-authored-by: Anastasiya Danilenka <41057639+adanilenka@users.noreply.github.com>
Co-authored-by: Anastasiya Danilenka <41057639+adanilenka@users.noreply.github.com>
Co-authored-by: Anastasiya Danilenka <41057639+adanilenka@users.noreply.github.com>
@Ostrzyciel
Copy link
Member Author

@adanilenka fixed, I think. Could you take a look?

@adanilenka
Copy link
Collaborator

@adanilenka fixed, I think. Could you take a look?

perfect, I have no more comments, we're good to go :)

@Ostrzyciel Ostrzyciel merged commit 8af908c into main May 6, 2025
1 check passed
@Ostrzyciel Ostrzyciel deleted the patch-spec-1 branch May 6, 2025 13:43
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.

2 participants