Expand README with warning about additional properties & contexts. #67
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TallTed
reviewed
Oct 9, 2024
Co-authored-by: Ted Thibodeau Jr <[email protected]>
BigBlueHat
requested changes
Oct 22, 2024
Comment on lines
+107
to
+108
| and supported VC Data Model versions. Endpoints in most cases should: be VC-API capable; be able to sign and/or | ||
| verify using `did:key`; and be able to resolve the following contexts: |
There was a problem hiding this comment.
Suggested change
| and supported VC Data Model versions. Endpoints in most cases should: be VC-API capable; be able to sign and/or | |
| verify using `did:key`; and be able to resolve the following contexts: | |
| and supported VC Data Model versions. Endpoints in most cases should: be test suite API | |
| capable; be able to sign and/or verify using `did:key`; and be support the following contexts: |
There was a problem hiding this comment.
Clarifying the use of "test suite API" and using "support" for contexts rather than "resolve" as implementations should be caching those contexts based on the specs anyhow (and not constantly resolve them).
There was a problem hiding this comment.
Starts with @BigBlueHat's suggestion, and improves language from there.
Suggested change
| and supported VC Data Model versions. Endpoints in most cases should: be VC-API capable; be able to sign and/or | |
| verify using `did:key`; and be able to resolve the following contexts: | |
| and supported VC Data Model versions. In most cases, endpoints are expected to: be capable | |
| of using the test suite API; be capable of signing and/or verifying using `did:key`; and support the following contexts: |
There was a problem hiding this comment.
@BigBlueHat I think we should take @TallTed 's suggestion and get this PR in. Opinions?
There was a problem hiding this comment.
@aljones15 yes. Please add it.
BigBlueHat
approved these changes
Nov 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves the README by making implementers aware of test suite specific properties, endpoints, tags, and contexts.