# README

Go API client for client

Documentation for all of Ory Keto's REST APIs. gRPC is documented separately.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version:
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import client "github.com/ory/keto-client-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), client.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), client.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identifield by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), client.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), client.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

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
PermissionApi	BatchCheckPermission	Post /relation-tuples/batch/check	Batch check permissions
PermissionApi	CheckPermission	Get /relation-tuples/check/openapi	Check a permission
PermissionApi	CheckPermissionOrError	Get /relation-tuples/check	Check a permission
PermissionApi	ExpandPermissions	Get /relation-tuples/expand	Expand a Relationship into permissions.
PermissionApi	PostCheckPermission	Post /relation-tuples/check/openapi	Check a permission
PermissionApi	PostCheckPermissionOrError	Post /relation-tuples/check	Check a permission
RelationshipApi	CheckOplSyntax	Post /opl/syntax/check	Check the syntax of an OPL file
RelationshipApi	CreateRelationship	Put /admin/relation-tuples	Create a Relationship
RelationshipApi	DeleteRelationships	Delete /admin/relation-tuples	Delete Relationships
RelationshipApi	GetRelationships	Get /relation-tuples	Query relationships
RelationshipApi	ListRelationshipNamespaces	Get /namespaces	Query namespaces
RelationshipApi	PatchRelationships	Patch /admin/relation-tuples	Patch Multiple Relationships

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime

Author

[email protected]