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

Further explain non-tested implementation claims. #67

Merged
merged 2 commits into from
Mar 6, 2025

Conversation

BigBlueHat
Copy link
Member

@BigBlueHat BigBlueHat commented Mar 3, 2025

@iherman this is to address your question in #65 (review)

@BigBlueHat BigBlueHat force-pushed the improve-tradeverifyd-note branch from 01050cc to 7926ab5 Compare March 3, 2025 16:31
abstract.hbs Outdated
<a href="https://github.com/w3c/vc-data-model-2.0-test-suite?tab=readme-ov-file#test-suite-http-api">test suite API</a>
requires raw JSON responses such that implementations
using VC JOSE/COSE or other enveloped response bodies are required to unwrap
the envelopes prior to responsing. Consequently, in addition to the test
Copy link
Member

Choose a reason for hiding this comment

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

As an outsider, I do not understand the "consequently" here. Is it so that the implementation of tradeverifyd does not have the possibility to unwrap (or it requires too much extra work) hence and it cannot connect to the API? If that is the case, then explain this, please, otherwise this additional text does not make sense to me...

Copy link
Member Author

Choose a reason for hiding this comment

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

@iherman I believe it falls into the "requires too much extra work" category, at least if you're working with enveloped formats instead of JSON. I described the approach taken a bit more in #45 (comment)

Copy link
Member

Choose a reason for hiding this comment

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

Then youcan modify the text accordingly. "Too much extra work" is a perfect argument.

Copy link
Member

@TallTed TallTed left a comment

Choose a reason for hiding this comment

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

A couple typos, and some minor language tweaks to hopefully promote readability.

abstract.hbs Outdated
requires raw JSON responses such that implementations
using VC JOSE/COSE or other enveloped response bodies are required to unwrap
the envelopes prior to responsing. Consequently, in addition to the test
results below,
<a href="https://github.com/w3c/vc-bitstring-status-list-test-suite/issues/61">Tradeverifyd reports</a>
a successful implemention of every feature, including the ability to
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to say "implementation of the test cases for every feature"? What I mean is: in abstract, a test case describes a specific, and potentially problematic, situation for handling a status, and the question is whether the implementation handled that situation correctly or not.

If that is the case, it would be preferable to spell this out.

@brentzundel ?

Co-authored-by: Ted Thibodeau Jr <[email protected]>
@BigBlueHat BigBlueHat requested a review from TallTed March 6, 2025 14:26
@BigBlueHat
Copy link
Member Author

@TallTed can you remove your blocking change request? They've been addressed/accepted, but for some reason GitHub doesn't know that...

@BigBlueHat BigBlueHat merged commit 7c17361 into main Mar 6, 2025
2 checks passed
@BigBlueHat BigBlueHat deleted the improve-tradeverifyd-note branch March 6, 2025 16:00
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.

5 participants