satori/doc/source/schema.rst
Ziad Sawalha c382a3e860 Implement New Discovery Schema
Change-Id: Ibd34c44211920197cf19df535ef038279fff2714
2014-05-07 15:25:05 -05:00

34 lines
777 B
ReStructuredText

======
Schema
======
The following list of fields describes the data returned from Satori.
Target
======
Target contains the address suplplied to run the discovery.
Found
=====
All data items discovered are returned under the found key. Keys to resources
discovered are also added under found, but the actual resources are stored
under the resources key.
Resources
=========
All resources (servers, load balancers, DNS domains, etc...) are stored under
the resources key.
Each resource contains the following keys:
* **key**: a globally unique identifier for the resource (could be a URI)
* **id**: the id in the system that hosts the resource
* **type**: the resource type using Heat or Heat-like resource types
* **data**: any additional fields for that resource