mirror of
https://github.com/Telecominfraproject/wlan-docs.git
synced 2025-11-01 19:27:48 +00:00
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
---
|
|
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 %}
|
|
|
|
|
|
|