ory_keto_client 0.9.0-alpha.0 ory_keto_client: ^0.9.0-alpha.0 copied to clipboard
OpenAPI API client
ory_keto_client #
Documentation for all of Ory Keto's REST APIs. gRPC is documented separately.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: v0.9.0-alpha.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen
Requirements #
Dart 2.12 or later
Installation & Usage #
Github #
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
ory_keto_client:
git: https://github.com/ory/sdk.git
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
ory_keto_client:
path: /path/to/ory_keto_client
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ory_keto_client/api.dart';
final api_instance = MetadataApi();
try {
final result = api_instance.getVersion();
print(result);
} catch (e) {
print('Exception when calling MetadataApi->getVersion: $e\n');
}
Documentation for API Endpoints #
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
MetadataApi | getVersion | GET /version | Return Running Software Version. |
MetadataApi | isAlive | GET /health/alive | Check HTTP Server Status |
MetadataApi | isReady | GET /health/ready | Check HTTP Server and Database Status |
ReadApi | getCheck | GET /relation-tuples/check/openapi | Check a relation tuple |
ReadApi | getCheckMirrorStatus | GET /relation-tuples/check | Check a relation tuple |
ReadApi | getExpand | GET /relation-tuples/expand | Expand a Relation Tuple |
ReadApi | getRelationTuples | GET /relation-tuples | Query relation tuples |
ReadApi | postCheck | POST /relation-tuples/check/openapi | Check a relation tuple |
ReadApi | postCheckMirrorStatus | POST /relation-tuples/check | Check a relation tuple |
WriteApi | createRelationTuple | PUT /admin/relation-tuples | Create a Relation Tuple |
WriteApi | deleteRelationTuples | DELETE /admin/relation-tuples | Delete Relation Tuples |
WriteApi | patchRelationTuples | PATCH /admin/relation-tuples | Patch Multiple Relation Tuples |
Documentation For Models #
- ExpandTree
- GenericError
- GetCheckResponse
- GetRelationTuplesResponse
- GetVersion200Response
- HealthNotReadyStatus
- HealthStatus
- IsAlive200Response
- IsReady503Response
- PatchDelta
- RelationQuery
- RelationTuple
- SubjectSet
- Version
Documentation For Authorization #
All endpoints do not require authorization.