Move the documentation a bit #90
Merged
Conversation
This file contains hidden or 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
gtardif
reviewed
Feb 8, 2022
Comment on lines
+52
to
+75
| window.ddClient.backend | ||
| .post("/some/service", { ... }) | ||
| .then((value: any) => console.log(value)); | ||
|
|
||
| window.ddClient.backend | ||
| .put("/some/service", { ... }) | ||
| .then((value: any) => console.log(value)); | ||
|
|
||
| window.ddClient.backend | ||
| .patch("/some/service", { ... }) | ||
| .then((value: any) => console.log(value)); | ||
|
|
||
| window.ddClient.backend | ||
| .delete("/some/service") | ||
| .then((value: any) => console.log(value)); | ||
|
|
||
| window.ddClient.backend | ||
| .head("/some/service") | ||
| .then((value: any) => console.log(value)); | ||
|
|
||
| window.ddClient.backend | ||
| .request({ url: "/url", method: "GET", headers: { 'header-key': 'header-value' }, data: { ... }}) | ||
| .then((value: any) => console.log(value)); | ||
| ``` |
There was a problem hiding this comment.
If we want to publish this to the docs site now, we should add these in a separate PR as well
felipecruz91
reviewed
Feb 8, 2022
docs/dev/api/backend.md
Outdated
| defined in the [vm section](../../extensions/METADATA.md#vm-section) in the | ||
| extensions metadata. The client is already connected to the backend. | ||
|
|
||
| It implements the following interafce |
There was a problem hiding this comment.
Suggested change
| It implements the following interafce | |
| It implements the following interface |
felipecruz91
reviewed
Feb 8, 2022
| @@ -0,0 +1,24 @@ | |||
| ## User notifications | |||
There was a problem hiding this comment.
@rumpl Could you include the screenshot that showed the three types of toast messages?
felipecruz91
reviewed
Feb 8, 2022
Comment on lines
+6
to
+8
| ```typescript | ||
| window.ddClient.toastError("Something went wrong"); | ||
| ``` |
There was a problem hiding this comment.
Shouldn't we include the toast info and warning as well?
I also got carried away and moved things around a bit. Signed-off-by: Djordje Lukic <djordje.lukic@docker.com>
felipecruz91
approved these changes
Feb 8, 2022
gtardif
approved these changes
Feb 8, 2022
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.
This change moves the documentation a bit making different sections for different APIs