Skip to content
This repository has been archived by the owner on Jan 23, 2023. It is now read-only.

Commit

Permalink
GitBook: [master] 5 pages and one asset modified
Browse files Browse the repository at this point in the history
  • Loading branch information
cglewis authored and gitbook-bot committed Apr 7, 2020
1 parent 8cf3380 commit 843ce58
Show file tree
Hide file tree
Showing 6 changed files with 86 additions and 0 deletions.
Binary file added .gitbook/assets/packet_cafe_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,19 @@

* [Overview](README.md)

## Design

* [Architecture](design/architecture.md)
* [API](design/api.md)

## Deployment

* [Prerequisites](deployment/prerequisites.md)
* [Linux](deployment/linux.md)
* [macOS](deployment/macos.md)
* [Orchestration](deployment/orchestration.md)

## Testing

* [Untitled](testing/untitled.md)

6 changes: 6 additions & 0 deletions deployment/orchestration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Orchestration

## Deploying with Orchestration



62 changes: 62 additions & 0 deletions design/api.md
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 %}



6 changes: 6 additions & 0 deletions design/architecture.md
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)



2 changes: 2 additions & 0 deletions testing/untitled.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Untitled

0 comments on commit 843ce58

Please sign in to comment.