Directory APIs
As of Topaz 0.30+, the Directory APIs are exposed both over gRPC as well as REST.
Prior versions only support the v2 gRPC contracts. To use the new contracts, upgrade to Topaz 0.30+.
gRPC
By default, Topaz exposes all of the directory gRPC endpoints on port 9292. You can override this in config, and configure separate endpoints for the Reader, Writer, Import, and Export services.
Topaz 0.30+ supports two contracts side-by-side - v2 and v3. You can find the contracts on buf.
The v2 Directory APIs are organized into four services:
aserto.directory.reader.v2.Reader- Reader APIsaserto.directory.writer.v2.Writer- Writer APIsaserto.directory.importer.v2.Importer/Import- import entitiesaserto.directory.exporter.v2.Exporter/Export- export entities
The v3 Directory APIs add a Model service as well.
aserto.directory.reader.v3.Reader- Reader APIsaserto.directory.writer.v3.Writer- Writer APIsaserto.directory.exporter.v3.Model- Model APIsaserto.directory.importer.v3.Importer/Import- import entitiesaserto.directory.exporter.v3.Exporter/Export- export entities
The Reader APIs and Writer APIs can be used to read and write data to the directory.
The Import and Export APIs can be used to stream data in and out of the directory.
The Model APIs can be used to get, set, and delete a directory manifest.
REST
Topaz 0.30+ supports REST APIs in addition to the gRPC contracts.
By default, Topaz exposes the directory REST endpoints on port 9393. You can override this in config, and configure separate endpoints for the Reader, Writer, Model, Import, and Export services.
The reference documentation for the REST APIs can be found here.