OpenWiFi Provisioning
OpenAPI
You may get static page with OpenAPI docs generated from the definition on GitHub Page.
Also, you may use Swagger UI with OpenAPI definition file raw link (i.e. latest version file) to get interactive docs page.
Build from source.
You need:
build and install them.
Root entity
It's UUID value is 0000-0000-0000. Its parent entity must be empty.
Entity
Creation rules
- You must set the parent of an entity.
- The only properties you may set at creation are:
- name
- description
- notes
- parent
Modification rules
You may modify the following fields in the POST
- name
- description
- notes
Delete
- Children must be empty
Inventory Tags
Creation rules
- Entity must point to an existing non-root entity
- If you associate a venue, it must exist.
- You must use an existing device type. Device type cannot be empty.
- Name, description, notes are allowed.
Modification rules
- You can modify the device type to another valid one.
Venue
Creation rules
- If you include an entity, the parent must bot be set
- if you include a parent, the entity must not be set
- You cannot have children upon creation.
- You may include an array of devices UUIDs
- Topology and design cannot be set
OWPROV Service Configuration
The configuration is kept in a file called owprov.properties. To understand the content of this file,
please look here
Firewall Considerations
| Port | Description | Configurable |
|---|---|---|
| 16004 | Default port for REST API Access to the OWPROV | yes |
Kafka topics
Toe read more about Kafka, follow the document
Contributions
We need more contributors. Should you wish to contribute, please follow the contributions document.
Pull Requests
Please create a branch with the Jira addressing the issue you are fixing or the feature you are implementing. Create a pull-request from the branch into master.
Additional OWSDK Microservices
Here is a list of additional OWSDK microservices
| Name | Description | Link | OpenAPI |
|---|---|---|---|
| OWSEC | Security Service | here | here |
| OWGW | Controller Service | here | here |
| OWFMS | Firmware Management Service | here | here |
| OWPROV | Provisioning Service | here | here |
| OWANALYTICS | Analytics Service | here | here |