scottk/wlan-docs
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-docs.git synced 2025-11-01 11:17:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [master] 3 pages modified

Browse Source
This commit is contained in:
Chris Busch
2020-11-24 21:49:28 +00:00
committed by gitbook-bot
parent 6818f76522
commit 8852aceb21
3 changed files with 67 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
SUMMARY.md
View File

@@ -1,5 +1,5 @@
# Table of contents
* [Open Wi-Fi](README.md)
* [Untitled](untitled.md)
* [Using the API](untitled.md)

66
untitled.md
View File

@@ -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 %}