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

Commit

Permalink
GitBook: [master] 13 pages 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 86fe206 commit 79bc1ec
Showing 1 changed file with 75 additions and 1 deletion.
76 changes: 75 additions & 1 deletion design/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `lb` \(load balancer\) will process requests for both the `ui` \(frontend\)

Here are the available API endpoints:

`admin` \(port 5001\):
## `admin` \(port 5001\)

{% api-method method="get" host="http://0.0.0.0:5001" path="/v1" %}
{% api-method-summary %}
Expand Down Expand Up @@ -34,3 +34,77 @@ Returns a list of the available API endpoints for this service.

TODO

## `web` \(port 80\)

{% api-method method="get" host="" path="" %}
{% api-method-summary %}

{% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %}
{% api-method-request %}
{% api-method-path-parameters %}
{% api-method-parameter name="" type="string" required=false %}

{% endapi-method-parameter %}
{% endapi-method-path-parameters %}
{% endapi-method-request %}

{% api-method-response %}
{% api-method-response-example httpCode=200 %}
{% api-method-response-example-description %}

{% endapi-method-response-example-description %}

```
```
{% endapi-method-response-example %}
{% endapi-method-response %}
{% endapi-method-spec %}
{% endapi-method %}

TODO

## `ui` \(port 80\)

{% api-method method="get" host="" path="" %}
{% api-method-summary %}

{% endapi-method-summary %}

{% api-method-description %}

{% endapi-method-description %}

{% api-method-spec %}
{% api-method-request %}
{% api-method-path-parameters %}
{% api-method-parameter name="" type="string" required=false %}

{% endapi-method-parameter %}
{% endapi-method-path-parameters %}
{% endapi-method-request %}

{% api-method-response %}
{% api-method-response-example httpCode=200 %}
{% api-method-response-example-description %}

{% endapi-method-response-example-description %}

```
```
{% endapi-method-response-example %}
{% endapi-method-response %}
{% endapi-method-spec %}
{% endapi-method %}

TODO



0 comments on commit 79bc1ec

Please sign in to comment.