document auth session and sign out methods, more consitent reference … #38
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
0xAlcibiades
requested changes
Nov 21, 2023
README.md
Outdated
| fills their signed offer. Makers are presently required to request access to | ||
| the maker API via the [Valorem discord](https://discord.gg/valorem). | ||
| the maker API via the [Valorem discord](https://discord.gg/valorem); set to be lifted pending the battle testing of our offer validation protocol. |
There was a problem hiding this comment.
Would remove. Let's not make forward looking promises here, but rather speak about the present.
README.md
Outdated
|
|
||
| These protections are in place to ensure that the API is not abused during the | ||
| early access period. | ||
| execute signed offers via the Seaport smart contracts. Takers can get early access to releases of new features with a [Valorem Access Pass](https://opensea.io/collection/valorem-access-pass). |
There was a problem hiding this comment.
Can remove the early access bit here.
|
|
||
| ## ALPN | ||
|
|
||
| The Valorem Trade API supports HTTP/2 via the `h2` ALPN protocol. | ||
|
|
||
| ## Keepalives and timeouts | ||
|
|
||
| The Valorem Trade API sends HTTP/2 keepalives every 75 seconds and times out | ||
| The Valorem Trade API sends HTTP/2 keepalives every 75 seconds and times out |
There was a problem hiding this comment.
Would have made this PR easier to grok if the whitespace changes came in apart from content changes.
0xAlcibiades
approved these changes
Nov 21, 2023
0xAlcibiades
deleted the
megsdevs/val-1593-review-and-tweak-trade-api-api-docs-for-completeness-and
branch
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.
…docs