This repository has been archived by the owner on Jan 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
GitBook: [master] 5 pages and one asset modified
- Loading branch information
1 parent
8cf3380
commit 843ce58
Showing
6 changed files
with
86 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Orchestration | ||
|
||
## Deploying with Orchestration | ||
|
||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# API | ||
|
||
{% api-method method="get" host="https://api.cakes.com" path="/v1/cakes/:id" %} | ||
{% api-method-summary %} | ||
Get Cakes | ||
{% endapi-method-summary %} | ||
|
||
{% api-method-description %} | ||
This endpoint allows you to get free cakes. | ||
{% endapi-method-description %} | ||
|
||
{% api-method-spec %} | ||
{% api-method-request %} | ||
{% api-method-path-parameters %} | ||
{% api-method-parameter name="id" type="string" %} | ||
ID of the cake to get, for free of course. | ||
{% endapi-method-parameter %} | ||
{% endapi-method-path-parameters %} | ||
|
||
{% api-method-headers %} | ||
{% api-method-parameter name="Authentication" type="string" required=true %} | ||
Authentication token to track down who is emptying our stocks. | ||
{% endapi-method-parameter %} | ||
{% endapi-method-headers %} | ||
|
||
{% api-method-query-parameters %} | ||
{% api-method-parameter name="recipe" type="string" %} | ||
The API will do its best to find a cake matching the provided recipe. | ||
{% endapi-method-parameter %} | ||
|
||
{% api-method-parameter name="gluten" type="boolean" %} | ||
Whether the cake should be gluten-free or not. | ||
{% endapi-method-parameter %} | ||
{% endapi-method-query-parameters %} | ||
{% endapi-method-request %} | ||
|
||
{% api-method-response %} | ||
{% api-method-response-example httpCode=200 %} | ||
{% api-method-response-example-description %} | ||
Cake successfully retrieved. | ||
{% endapi-method-response-example-description %} | ||
|
||
``` | ||
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"} | ||
``` | ||
{% endapi-method-response-example %} | ||
|
||
{% api-method-response-example httpCode=404 %} | ||
{% api-method-response-example-description %} | ||
Could not find a cake matching this query. | ||
{% endapi-method-response-example-description %} | ||
|
||
``` | ||
{ "message": "Ain't no cake like that."} | ||
``` | ||
{% endapi-method-response-example %} | ||
{% endapi-method-response %} | ||
{% endapi-method-spec %} | ||
{% endapi-method %} | ||
|
||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Architecture | ||
|
||
![Components of this are run in Docker containers](../.gitbook/assets/packet_cafe_diagram.png) | ||
|
||
|
||
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Untitled | ||
|