# OPENAPI description
This document will describe how the API is built and how to use it. 

## Where is the OpenAPI.
This uses OpenAPI definition 3.0 and can be found [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/openapi/ucentral/owgw.yaml).
All endpoints begin with `/api/v1`.

## OpenAPI docs
You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-ucentralgw).

Also you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentralgw/master/openapi/owgw.yaml)) to get interactive docs page.

## The flow
In order to use any of the API calls, you must obtain a token (I know - shocking). You do so by calling the end-point
`/oauth2`. Once you obtain that `access-token`, you will need to pass it in the headers under `Authorization: Bearer <place your token here>`.

## The basic entities
The API revolves around `devices`, `commands`, and `default_configurations`. You can get a list of `devices` to know what is available and then 
use the endpoint `device` to access all device specific information. The same is true about `commands` and `default_configurations`.
Most operations rely on the `serialNumber` of a device. That `serialNumber` is unique and generated on the device. It usually matches the
device's MAC address.

- `devices`: The list of all devices in the system. This maybe very large abnd you should use pagination. 
- `commands`: The list of commands issued by the system. This list could also be large and should be used with care.
- `default_configurations`: A list of default configurations used to supply existing devices.

## Relationships
A device is a physical (or potentially logical) entity using the ucentral protocol. Currently, APs and Switches ate the only devices used. A device 
has several attributes. Additionally, other collections are supported for each device:

- `logs`: These are specific for that device. They may originate from the device or associated with the device by some mechanism.
- `healthchecks`: These are reports from the device coming periodically after self tests of its subsystems.
- `statistics`: These are periodically produced by the devices and document actual data from each device.
- `capabilities`: This details the actual data model supported by the device.

The `device` entry point is also use to query about the `status` of the device. It is also used to inject certain commands for 
a specific device. Here are some commands supported for each device:

- `reboot`: This will force the device to reboot.
- `configure`: Configure sends a new configuration to a device. 
- `factory`: Forces the device to perform a factory-reset.
- `upgrade`: Forces the device to do a firmware upgrade.
- `leds`: Ask the device to flash its LEDs or turn them on or off.
- `trace`: Performs a remove LAN trace. Once the trace is completed, the produced file may be removed using the `file` endpoint.
- `command`: Performs a proprietary command. The meaning depends on the device. 
- `request`: Request an immediate message of type `state` or `healthcheck`.

The `file` end point is used to retrieve and remove files produced by the gateway. Currently this is limited to the results of a `trace` command. The file name will always match the `uuid` of the command that produced it. If several files are needed, the files will be named `uuid`, `uuid.1`, `uuid.2`, etc.

## Dates 
All dates should use the format defined in [RFC3339](https://tools.ietf.org/html/rfc3339). All times are UTC based. Here is 
an example:

```shell
1985-04-12T23:20:50.52Z
```

## Command `when` parameter
Most commands use a `when` parameter to suggest to the device when to perform the command. This is a _suggestion_ only.
The device may decide to perform the command when it is optimal for itself. It maybe busy doing something and decline to do a reboot for several minutes 
for example. The device may reply with the actual `when` it will perform the command. 

## Configuration UUID
The gateway manages the configuration UUID. So if you set a UUID for a configuration, it will be ignored. The gateway uses UUID 
as versioning. The UUID is unique within a single device. The resulting UUID or a configuration change is returned as part of
the `configure` command.


