Skip to content

[3.1] Add JSON-LD serialization annotations link - #1405

Merged
bact merged 8 commits into
spdx:developfrom
bact:add-serialize-annotations
Jul 21, 2026
Merged

[3.1] Add JSON-LD serialization annotations link#1405
bact merged 8 commits into
spdx:developfrom
bact:add-serialize-annotations

Conversation

@bact

@bact bact commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

As agreed in 23 June 2026 Tech call,
add JSON-LD serialization annotations URL and its description
to the "Serialization in SPDX 3 JSON" section.

To fix spdx/spdx-3-model#1381

Note

Within the "Serialization in SPDX 3 JSON" section,
to have three related subsections about serialization mechanics sit together for better flow,
this PR swap position of "JSON-LD context file" and "SpdxDocument":

Current:

  1. A strict subset of JSON-LD
  2. JSON-LD context file
  3. SpdxDocument
  4. JSON-LD validation
  5. Examples

Proposed in this PR:

  1. A strict subset of JSON-LD
  2. SpdxDocument <---- Was (3)
  3. JSON-LD serialization annotations <---- NEW
  4. JSON-LD context file <---- Was (2)
  5. JSON-LD validation
  6. Examples

From 23 June 2026 Tech call

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact added this to the 3.1-rc2 milestone Jun 23, 2026
@bact bact added the serialization Representation of data in bytes label Jun 23, 2026
@bact bact changed the title Add JSON-LD serialization annotations to Serialization section [3.1] Add JSON-LD serialization annotations link Jun 23, 2026
@bact
bact requested review from goneall, kestewart and zvr June 23, 2026 22:15
@bact

bact commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator Author

From Tech call 30 June 2026 (from @henrylyons's presentation):

  • Document what annotations.ttl contains and when an implementer must consume it

Should put that in this PR too

Update 7 July 2026: Done

bact added 3 commits July 6, 2026 23:46
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>

@goneall goneall left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@goneall

goneall commented Jul 21, 2026

Copy link
Copy Markdown
Member

Discussed on the 21 July 2026 tech call - changes look OK, need one more reviewer.

@zvr - do you want to do a review and merge if OK?

@goneall

goneall commented Jul 21, 2026

Copy link
Copy Markdown
Member

@bact - looks like we got 2 reviews - could you resolve the merge conflict and merge?

bact added 2 commits July 21, 2026 22:47
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
bact merged commit 24d532a into spdx:develop Jul 21, 2026
3 checks passed
@bact
bact deleted the add-serialize-annotations branch July 22, 2026 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

serialization Representation of data in bytes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[3.1-RC1] Document the purpose and required use of annotations.ttl

3 participants