docs: update readme with http api #43
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
dtbuchholz
commented
Mar 27, 2024
| @@ -107,20 +117,24 @@ vaults account create [FILENAME] | |||
|
|
|||
| A new private key will be written to `FILENAME`. | |||
|
|
|||
| The name of a vault contains a `namespace` (e.g. `my_company`) and the name of an existing database relation (e.g. `my_table`), separated by a period (`.`). Use `vaults create` to create a new vault. See `vaults create --help` for more info. | |||
| The name of a vault contains a `namespace` (e.g. `my_company`) and an identifier (e.g., `my_data`), separated by a period (`.`). Use `vaults create` to create a new vault. See `vaults create --help` for more info. | |||
There was a problem hiding this comment.
idk if the namespace.identifier is the right way to define it, but i figured the "relation" nomenclature should be dropped.
dtbuchholz
commented
Mar 27, 2024
| vaults retrieve --output [FILENAME] bafybeifr5njnrw67yyb2h2t7k6ukm3pml4fgphsxeurqcmgmeb7omc2vlq | ||
| ``` | ||
|
|
||
| ### HTTP APIs |
There was a problem hiding this comment.
added docs for HTTP APIs (I've been sharing a Notion doc, so i figured it'd best if it's just public)
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.
Summary
Adds HTTP API endpoints to the docs and makes a few small language tweaks.