-
-
Notifications
You must be signed in to change notification settings - Fork 854
web: enable inbox && add inbox api docs #8872
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
base: beta
Are you sure you want to change the base?
Conversation
| icon: Copy.path, | ||
| onClick: async () => { | ||
| try { | ||
| await navigator.clipboard.writeText(notebook.id); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the writeToClipboard utility.
| } | ||
| }, | ||
| isHidden: !settingStore.get().isInboxEnabled, | ||
| multiSelect: false |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No need for this.
|
|
||
| --- | ||
|
|
||
| ### 3. Post data to Inbox API endpoint. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The json plus table seems redundant. A good example of how API documentation should look like is this: https://developer.paddle.com/api-reference/products/create-product
We should also add an example that can be run via curl. Another thing we need to add is how to send pre-encrypted data directly to the Notesnook server without going through the Inbox API server. Perhaps we should also add an example doing it using OpenSSL + cURL.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A good example of how API documentation should look like is this: https://developer.paddle.com/api-reference/products/create-product
I've improved the current doc, not sure which specific changes you meant.
Another thing we need to add is how to send pre-encrypted data directly to the Notesnook server without going through the Inbox API server. Perhaps we should also add an example doing it using OpenSSL + cURL.
This would require us to explain how the data is encrypted, the docs for which are present in the other repo. Maybe we can say something like "You can skip the inbox server altogether and send encrypted data directly to the Notesnook server, learn more here (link to the inbox server repo)"
Signed-off-by: 01zulfi <[email protected]>
75e99e5 to
bc63ca0
Compare
Related #8526