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

Made the JSON valid #1

Closed
wants to merge 13 commits into from
Closed

Made the JSON valid #1

wants to merge 13 commits into from

Conversation

bact
Copy link

@bact bact commented May 18, 2024

This PR is closed. Please use #2 instead.

The example is now structurally valid.
Passed the validation by ajv and check-jsonschema.

Changes:

  • Fix JSON errors
    • Remove control characters inside a string value
    • Make all strings a one-liner, as required by JSON
  • Fix typos in class/property/type serialized names
  • Fix cardinality
  • Convert dictionary ("key": "value") entries to SPDX 3.0 "DictionaryEntry" objects
  • Replace "hrt"/"simpleHRT" with "htr"/"simpleHTR"
  • Validated with ajv and check-jsonschema

rnjudge and others added 2 commits May 15, 2024 12:47
This commit adds the software profile example drawio file and
screenshot of the drawio diagram. The hope is that other profiles will
build on top of this core example and we can generate SPDX docs for
these examples to make adopting 3.0 easier.

Signed-off-by: Rose Judge <rose.judge@broadcom.com>
Fix these JSON errors:

- Unexpected end of string. json(258)
- Invalid characters in string. Control characters must be escaped. json(262)

Changes:

- Remove one Start of Heading (SOH) control character inside a string value
- Inside string values, replace tab with space
- Make all strings a one-liner (escaped new-line character inside a string value to `\n`)
  - JSON cannot have a multi-line value
- Replace "hrt"/"simpleHRT" with "htr"/"simpleHTR"
  - Keep spelling the same as https://github.com/githubharald/SimpleHTR/
- Format document
  - Make it easier to review on GitHub
- Rename "AI" directory to "ai", to keep it consistent with the value of profileConformance ("core", "software", "ai", "dataset")
goneall and others added 2 commits May 21, 2024 09:34
Add general software profile example
- Fix typos in class/property/type names
- Convert dictionary ("key": "value") entries to SPDX 3.0 "DictionaryEntry" objects
- Now validated with spdx3ToGraph

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact changed the title Fix JSON errors + rename "hrt" to "htr" Made the JSON valid Jun 5, 2024
@bact
Copy link
Author

bact commented Jun 5, 2024

The JSON is now pass the validation by spdx3ToGraph.

bact and others added 9 commits June 6, 2024 05:44
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Fixes the github actions workflow to correctly validates SPDX 2 and SPDX
3 documents, and fixes example-13 to conform to the validation

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
":_creationinfo" -> "_:creationinfo"
Passed both ajv and check-jsonschema
@bact
Copy link
Author

bact commented Jun 17, 2024

Update:

  • Passed the JSON Schema validation, both ajv and check-jsonschema
  • Not passed yet, the SHACL (pyshacl)

@bact
Copy link
Author

bact commented Jun 17, 2024

Now pass the SHACL in PR #2.

Close this PR as it has commits from other non-related stuff.

@bact bact closed this Jun 17, 2024
@bact bact deleted the patch-3 branch June 17, 2024 12:32
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.

4 participants