diff --git a/README.md b/README.md index fdd0e09..2f50b4a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ description: Telecom Infra Project Open Wi-Fi TIP Open Wi-Fi is an open source disaggregated technology stack. Open Wi-Fi delivers premium managed Wi-Fi features, local break-out design, cloud native open controller, and an open AP firmware operating system. -Friends don't let friends become vendor locked in... +Friends don't let friends become vendor locked in... diff --git a/SUMMARY.md b/SUMMARY.md index d450356..c95192a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,5 +1,5 @@ # Table of contents * [Open Wi-Fi](README.md) -* [Untitled](untitled.md) +* [Using the API](untitled.md) diff --git a/untitled.md b/untitled.md index 5094080..61453f4 100644 --- a/untitled.md +++ b/untitled.md @@ -1,2 +1,66 @@ -# Untitled +--- +description: Controller Northbound Integration +--- + +# Using the 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 %} + +