cleaning up http spec #370
Merged
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
jiyoonie9
requested review from
michaelneale,
mistermoe,
KendallWeihe,
kirahsapong,
diehuxx,
decentralgabe and
angiejones
as code owners
mistermoe
approved these changes
Aug 14, 2024
KendallWeihe
approved these changes
Aug 14, 2024
specs/http-api/README.md
Outdated
| | ----------------- | ------------------------------------------------------------- | | ||
| | `id` | see [DID-CORE spec](https://www.w3.org/TR/did-core/#services) | | ||
| | `type` | `PFI` | | ||
| | `serviceEndpoint` | PFI's publicly addressable API endpoint | |
There was a problem hiding this comment.
could we link this API endpoint to something?
There was a problem hiding this comment.
🤔 like to a spec?
There was a problem hiding this comment.
something like a common base API https://swagger.io/docs/specification/api-host-and-base-path/
| "createdAt": "2023-09-13T20:28:40.345Z", | ||
| "protocol": "1.0" | ||
| }, | ||
| "data": {}, |
There was a problem hiding this comment.
is data present even if it's a null value?
There was a problem hiding this comment.
yep! order's data is empty.
specs/http-api/README.md
Outdated
| "kind": "order", | ||
| "id": "order_01ha83pkgsfk6t1kxg7q42s48j", | ||
| "createdAt": "2023-09-13T20:28:40.345Z", | ||
| "protocol": "1.0" |
…pec mermaid diagram
angiejones
reviewed
Aug 15, 2024
angiejones
reviewed
Aug 15, 2024
angiejones
reviewed
Aug 15, 2024
Co-authored-by: Angie Jones <jones.angie@gmail.com>
… http-spec-cleanup
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.
changes
AuthenticationandAuthorizationheaders for each protected endpoint description and added reference to top levelAuthenticationheading that explains how bearer did authn worksserviceEndpoint