Skip to content

Add more implementer details.#26

Draft
BigBlueHat wants to merge 6 commits intomainfrom
more-implementer-details
Draft

Add more implementer details.#26
BigBlueHat wants to merge 6 commits intomainfrom
more-implementer-details

Conversation

@BigBlueHat
Copy link
Copy Markdown
Member

  • Add .editorconfig.
  • Fix whitespace in GrotoNetworking.json.
  • Add more metadata to implementations.

@BigBlueHat BigBlueHat requested a review from aljones15 March 20, 2024 20:03
@aljones15
Copy link
Copy Markdown
Collaborator

can this be tested with a few test suites first? Properties in a manifest are often cast to the Endpoint class so adding new properties might result in some small correctable issues.

@BigBlueHat
Copy link
Copy Markdown
Member Author

@aljones15 yeah, there are also reporter updates to make. Mainly looking for format/shape feedback first.

This lays the foundation for eventually turning this metadata into VCs.

The context uses a mix of the W3Cs EARL vocabulary, DOAP (which EARL
uses), Schema.org, and a temporary `reporter` namespace mapped to
https://github.com/digitalbazaar/mocha-w3c-interop-reporter#
which is the primary software which consumes these details to generate
W3C test reports.

This context MAY (and likely should) move in the future either to that repo or
to some more permanent home.
Copy link
Copy Markdown
Contributor

@davidlehn davidlehn left a comment

Choose a reason for hiding this comment

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

It might be good to find an EARL/DOAP expert if the idea is to properly align with those schemas. For instances, there is some mixing of schema.org and doap Person and Organization, which doesn't align with the DOAP schema ranges. In this use case, it probably doesn't matter. Not sure what best practices are with that.

Also the usage here isn't quite like what JSON-LD and rdf-canon use in their test results. Again, it might not matter here. This is headed the right direction in any case and will help improve reports.

Comment thread context.json
"@type": "@id"
},
"vendor": {
"@id": "doap:vendor"
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.

Some of these probably should be @type: @id.

@BigBlueHat BigBlueHat requested a review from TallTed September 24, 2024 22:27
@BigBlueHat
Copy link
Copy Markdown
Member Author

Here's how JSON-LD implementations were described: https://w3c.github.io/json-ld-api/reports/#instructions-for-submitting-implementation-reports

Copy link
Copy Markdown
Collaborator

@aljones15 aljones15 left a comment

Choose a reason for hiding this comment

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

Approving as this is needed and an excellent idea, just hope it doesn't require to many changes to sister libs to accomplish this PR.

@lanterno
Copy link
Copy Markdown

Hello @BigBlueHat , this is a great addition here. It would help a lot in figuring out which implementations have open-source projects that we can reuse. I hope you haven't abandoned this PR 🙏

btw, would it make sense to add a flag to indicate which implementation is open source (or not) ?
(Right now, I figure it out by following the github.com/xx/xx links, but an explicit flag might be more interesting)

@TallTed
Copy link
Copy Markdown
Member

TallTed commented Nov 12, 2025

I'll be happy to review this (not sure why I didn't see the request last year), after the conflicts are resolved.

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.

6 participants