snapshot of https://github.com/ory/keto.git (master, 2026-09-16; blobs > 131072B omitted)
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
This commit is contained in:
56
internal/httpclient/docs/BatchCheckPermissionBody.md
generated
Normal file
56
internal/httpclient/docs/BatchCheckPermissionBody.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# BatchCheckPermissionBody
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Tuples** | Pointer to [**[]Relationship**](Relationship.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewBatchCheckPermissionBody
|
||||
|
||||
`func NewBatchCheckPermissionBody() *BatchCheckPermissionBody`
|
||||
|
||||
NewBatchCheckPermissionBody instantiates a new BatchCheckPermissionBody object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewBatchCheckPermissionBodyWithDefaults
|
||||
|
||||
`func NewBatchCheckPermissionBodyWithDefaults() *BatchCheckPermissionBody`
|
||||
|
||||
NewBatchCheckPermissionBodyWithDefaults instantiates a new BatchCheckPermissionBody object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetTuples
|
||||
|
||||
`func (o *BatchCheckPermissionBody) GetTuples() []Relationship`
|
||||
|
||||
GetTuples returns the Tuples field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTuplesOk
|
||||
|
||||
`func (o *BatchCheckPermissionBody) GetTuplesOk() (*[]Relationship, bool)`
|
||||
|
||||
GetTuplesOk returns a tuple with the Tuples field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetTuples
|
||||
|
||||
`func (o *BatchCheckPermissionBody) SetTuples(v []Relationship)`
|
||||
|
||||
SetTuples sets Tuples field to given value.
|
||||
|
||||
### HasTuples
|
||||
|
||||
`func (o *BatchCheckPermissionBody) HasTuples() bool`
|
||||
|
||||
HasTuples returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
51
internal/httpclient/docs/BatchCheckPermissionResult.md
generated
Normal file
51
internal/httpclient/docs/BatchCheckPermissionResult.md
generated
Normal file
@@ -0,0 +1,51 @@
|
||||
# BatchCheckPermissionResult
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Results** | [**[]CheckPermissionResultWithError**](CheckPermissionResultWithError.md) | An array of check results. The order aligns with the input order. |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewBatchCheckPermissionResult
|
||||
|
||||
`func NewBatchCheckPermissionResult(results []CheckPermissionResultWithError, ) *BatchCheckPermissionResult`
|
||||
|
||||
NewBatchCheckPermissionResult instantiates a new BatchCheckPermissionResult object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewBatchCheckPermissionResultWithDefaults
|
||||
|
||||
`func NewBatchCheckPermissionResultWithDefaults() *BatchCheckPermissionResult`
|
||||
|
||||
NewBatchCheckPermissionResultWithDefaults instantiates a new BatchCheckPermissionResult object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetResults
|
||||
|
||||
`func (o *BatchCheckPermissionResult) GetResults() []CheckPermissionResultWithError`
|
||||
|
||||
GetResults returns the Results field if non-nil, zero value otherwise.
|
||||
|
||||
### GetResultsOk
|
||||
|
||||
`func (o *BatchCheckPermissionResult) GetResultsOk() (*[]CheckPermissionResultWithError, bool)`
|
||||
|
||||
GetResultsOk returns a tuple with the Results field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetResults
|
||||
|
||||
`func (o *BatchCheckPermissionResult) SetResults(v []CheckPermissionResultWithError)`
|
||||
|
||||
SetResults sets Results field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
56
internal/httpclient/docs/CheckOplSyntaxResult.md
generated
Normal file
56
internal/httpclient/docs/CheckOplSyntaxResult.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# CheckOplSyntaxResult
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Errors** | Pointer to [**[]ParseError**](ParseError.md) | The list of syntax errors | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewCheckOplSyntaxResult
|
||||
|
||||
`func NewCheckOplSyntaxResult() *CheckOplSyntaxResult`
|
||||
|
||||
NewCheckOplSyntaxResult instantiates a new CheckOplSyntaxResult object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewCheckOplSyntaxResultWithDefaults
|
||||
|
||||
`func NewCheckOplSyntaxResultWithDefaults() *CheckOplSyntaxResult`
|
||||
|
||||
NewCheckOplSyntaxResultWithDefaults instantiates a new CheckOplSyntaxResult object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetErrors
|
||||
|
||||
`func (o *CheckOplSyntaxResult) GetErrors() []ParseError`
|
||||
|
||||
GetErrors returns the Errors field if non-nil, zero value otherwise.
|
||||
|
||||
### GetErrorsOk
|
||||
|
||||
`func (o *CheckOplSyntaxResult) GetErrorsOk() (*[]ParseError, bool)`
|
||||
|
||||
GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetErrors
|
||||
|
||||
`func (o *CheckOplSyntaxResult) SetErrors(v []ParseError)`
|
||||
|
||||
SetErrors sets Errors field to given value.
|
||||
|
||||
### HasErrors
|
||||
|
||||
`func (o *CheckOplSyntaxResult) HasErrors() bool`
|
||||
|
||||
HasErrors returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
51
internal/httpclient/docs/CheckPermissionResult.md
generated
Normal file
51
internal/httpclient/docs/CheckPermissionResult.md
generated
Normal file
@@ -0,0 +1,51 @@
|
||||
# CheckPermissionResult
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Allowed** | **bool** | whether the relation tuple is allowed |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewCheckPermissionResult
|
||||
|
||||
`func NewCheckPermissionResult(allowed bool, ) *CheckPermissionResult`
|
||||
|
||||
NewCheckPermissionResult instantiates a new CheckPermissionResult object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewCheckPermissionResultWithDefaults
|
||||
|
||||
`func NewCheckPermissionResultWithDefaults() *CheckPermissionResult`
|
||||
|
||||
NewCheckPermissionResultWithDefaults instantiates a new CheckPermissionResult object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetAllowed
|
||||
|
||||
`func (o *CheckPermissionResult) GetAllowed() bool`
|
||||
|
||||
GetAllowed returns the Allowed field if non-nil, zero value otherwise.
|
||||
|
||||
### GetAllowedOk
|
||||
|
||||
`func (o *CheckPermissionResult) GetAllowedOk() (*bool, bool)`
|
||||
|
||||
GetAllowedOk returns a tuple with the Allowed field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetAllowed
|
||||
|
||||
`func (o *CheckPermissionResult) SetAllowed(v bool)`
|
||||
|
||||
SetAllowed sets Allowed field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
77
internal/httpclient/docs/CheckPermissionResultWithError.md
generated
Normal file
77
internal/httpclient/docs/CheckPermissionResultWithError.md
generated
Normal file
@@ -0,0 +1,77 @@
|
||||
# CheckPermissionResultWithError
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Allowed** | **bool** | whether the relation tuple is allowed |
|
||||
**Error** | Pointer to **string** | any error generated while checking the relation tuple | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewCheckPermissionResultWithError
|
||||
|
||||
`func NewCheckPermissionResultWithError(allowed bool, ) *CheckPermissionResultWithError`
|
||||
|
||||
NewCheckPermissionResultWithError instantiates a new CheckPermissionResultWithError object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewCheckPermissionResultWithErrorWithDefaults
|
||||
|
||||
`func NewCheckPermissionResultWithErrorWithDefaults() *CheckPermissionResultWithError`
|
||||
|
||||
NewCheckPermissionResultWithErrorWithDefaults instantiates a new CheckPermissionResultWithError object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetAllowed
|
||||
|
||||
`func (o *CheckPermissionResultWithError) GetAllowed() bool`
|
||||
|
||||
GetAllowed returns the Allowed field if non-nil, zero value otherwise.
|
||||
|
||||
### GetAllowedOk
|
||||
|
||||
`func (o *CheckPermissionResultWithError) GetAllowedOk() (*bool, bool)`
|
||||
|
||||
GetAllowedOk returns a tuple with the Allowed field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetAllowed
|
||||
|
||||
`func (o *CheckPermissionResultWithError) SetAllowed(v bool)`
|
||||
|
||||
SetAllowed sets Allowed field to given value.
|
||||
|
||||
|
||||
### GetError
|
||||
|
||||
`func (o *CheckPermissionResultWithError) GetError() string`
|
||||
|
||||
GetError returns the Error field if non-nil, zero value otherwise.
|
||||
|
||||
### GetErrorOk
|
||||
|
||||
`func (o *CheckPermissionResultWithError) GetErrorOk() (*string, bool)`
|
||||
|
||||
GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetError
|
||||
|
||||
`func (o *CheckPermissionResultWithError) SetError(v string)`
|
||||
|
||||
SetError sets Error field to given value.
|
||||
|
||||
### HasError
|
||||
|
||||
`func (o *CheckPermissionResultWithError) HasError() bool`
|
||||
|
||||
HasError returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
160
internal/httpclient/docs/CreateRelationshipBody.md
generated
Normal file
160
internal/httpclient/docs/CreateRelationshipBody.md
generated
Normal file
@@ -0,0 +1,160 @@
|
||||
# CreateRelationshipBody
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespace** | Pointer to **string** | Namespace to query | [optional]
|
||||
**Object** | Pointer to **string** | Object to query | [optional]
|
||||
**Relation** | Pointer to **string** | Relation to query | [optional]
|
||||
**SubjectId** | Pointer to **string** | SubjectID to query Either SubjectSet or SubjectID can be provided. | [optional]
|
||||
**SubjectSet** | Pointer to [**SubjectSet**](SubjectSet.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewCreateRelationshipBody
|
||||
|
||||
`func NewCreateRelationshipBody() *CreateRelationshipBody`
|
||||
|
||||
NewCreateRelationshipBody instantiates a new CreateRelationshipBody object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewCreateRelationshipBodyWithDefaults
|
||||
|
||||
`func NewCreateRelationshipBodyWithDefaults() *CreateRelationshipBody`
|
||||
|
||||
NewCreateRelationshipBodyWithDefaults instantiates a new CreateRelationshipBody object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespace
|
||||
|
||||
`func (o *CreateRelationshipBody) GetNamespace() string`
|
||||
|
||||
GetNamespace returns the Namespace field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespaceOk
|
||||
|
||||
`func (o *CreateRelationshipBody) GetNamespaceOk() (*string, bool)`
|
||||
|
||||
GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespace
|
||||
|
||||
`func (o *CreateRelationshipBody) SetNamespace(v string)`
|
||||
|
||||
SetNamespace sets Namespace field to given value.
|
||||
|
||||
### HasNamespace
|
||||
|
||||
`func (o *CreateRelationshipBody) HasNamespace() bool`
|
||||
|
||||
HasNamespace returns a boolean if a field has been set.
|
||||
|
||||
### GetObject
|
||||
|
||||
`func (o *CreateRelationshipBody) GetObject() string`
|
||||
|
||||
GetObject returns the Object field if non-nil, zero value otherwise.
|
||||
|
||||
### GetObjectOk
|
||||
|
||||
`func (o *CreateRelationshipBody) GetObjectOk() (*string, bool)`
|
||||
|
||||
GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetObject
|
||||
|
||||
`func (o *CreateRelationshipBody) SetObject(v string)`
|
||||
|
||||
SetObject sets Object field to given value.
|
||||
|
||||
### HasObject
|
||||
|
||||
`func (o *CreateRelationshipBody) HasObject() bool`
|
||||
|
||||
HasObject returns a boolean if a field has been set.
|
||||
|
||||
### GetRelation
|
||||
|
||||
`func (o *CreateRelationshipBody) GetRelation() string`
|
||||
|
||||
GetRelation returns the Relation field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationOk
|
||||
|
||||
`func (o *CreateRelationshipBody) GetRelationOk() (*string, bool)`
|
||||
|
||||
GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelation
|
||||
|
||||
`func (o *CreateRelationshipBody) SetRelation(v string)`
|
||||
|
||||
SetRelation sets Relation field to given value.
|
||||
|
||||
### HasRelation
|
||||
|
||||
`func (o *CreateRelationshipBody) HasRelation() bool`
|
||||
|
||||
HasRelation returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectId
|
||||
|
||||
`func (o *CreateRelationshipBody) GetSubjectId() string`
|
||||
|
||||
GetSubjectId returns the SubjectId field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectIdOk
|
||||
|
||||
`func (o *CreateRelationshipBody) GetSubjectIdOk() (*string, bool)`
|
||||
|
||||
GetSubjectIdOk returns a tuple with the SubjectId field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectId
|
||||
|
||||
`func (o *CreateRelationshipBody) SetSubjectId(v string)`
|
||||
|
||||
SetSubjectId sets SubjectId field to given value.
|
||||
|
||||
### HasSubjectId
|
||||
|
||||
`func (o *CreateRelationshipBody) HasSubjectId() bool`
|
||||
|
||||
HasSubjectId returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectSet
|
||||
|
||||
`func (o *CreateRelationshipBody) GetSubjectSet() SubjectSet`
|
||||
|
||||
GetSubjectSet returns the SubjectSet field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectSetOk
|
||||
|
||||
`func (o *CreateRelationshipBody) GetSubjectSetOk() (*SubjectSet, bool)`
|
||||
|
||||
GetSubjectSetOk returns a tuple with the SubjectSet field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectSet
|
||||
|
||||
`func (o *CreateRelationshipBody) SetSubjectSet(v SubjectSet)`
|
||||
|
||||
SetSubjectSet sets SubjectSet field to given value.
|
||||
|
||||
### HasSubjectSet
|
||||
|
||||
`func (o *CreateRelationshipBody) HasSubjectSet() bool`
|
||||
|
||||
HasSubjectSet returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
51
internal/httpclient/docs/ErrorGeneric.md
generated
Normal file
51
internal/httpclient/docs/ErrorGeneric.md
generated
Normal file
@@ -0,0 +1,51 @@
|
||||
# ErrorGeneric
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Error** | [**GenericError**](GenericError.md) | |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewErrorGeneric
|
||||
|
||||
`func NewErrorGeneric(error_ GenericError, ) *ErrorGeneric`
|
||||
|
||||
NewErrorGeneric instantiates a new ErrorGeneric object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewErrorGenericWithDefaults
|
||||
|
||||
`func NewErrorGenericWithDefaults() *ErrorGeneric`
|
||||
|
||||
NewErrorGenericWithDefaults instantiates a new ErrorGeneric object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetError
|
||||
|
||||
`func (o *ErrorGeneric) GetError() GenericError`
|
||||
|
||||
GetError returns the Error field if non-nil, zero value otherwise.
|
||||
|
||||
### GetErrorOk
|
||||
|
||||
`func (o *ErrorGeneric) GetErrorOk() (*GenericError, bool)`
|
||||
|
||||
GetErrorOk returns a tuple with the Error field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetError
|
||||
|
||||
`func (o *ErrorGeneric) SetError(v GenericError)`
|
||||
|
||||
SetError sets Error field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
103
internal/httpclient/docs/ExpandedPermissionTree.md
generated
Normal file
103
internal/httpclient/docs/ExpandedPermissionTree.md
generated
Normal file
@@ -0,0 +1,103 @@
|
||||
# ExpandedPermissionTree
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Children** | Pointer to [**[]ExpandedPermissionTree**](ExpandedPermissionTree.md) | The children of the node, possibly none. | [optional]
|
||||
**Tuple** | Pointer to [**Relationship**](Relationship.md) | | [optional]
|
||||
**Type** | **string** | The type of the node. union TreeNodeUnion exclusion TreeNodeExclusion intersection TreeNodeIntersection leaf TreeNodeLeaf tuple_to_subject_set TreeNodeTupleToSubjectSet computed_subject_set TreeNodeComputedSubjectSet not TreeNodeNot unspecified TreeNodeUnspecified |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewExpandedPermissionTree
|
||||
|
||||
`func NewExpandedPermissionTree(type_ string, ) *ExpandedPermissionTree`
|
||||
|
||||
NewExpandedPermissionTree instantiates a new ExpandedPermissionTree object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewExpandedPermissionTreeWithDefaults
|
||||
|
||||
`func NewExpandedPermissionTreeWithDefaults() *ExpandedPermissionTree`
|
||||
|
||||
NewExpandedPermissionTreeWithDefaults instantiates a new ExpandedPermissionTree object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetChildren
|
||||
|
||||
`func (o *ExpandedPermissionTree) GetChildren() []ExpandedPermissionTree`
|
||||
|
||||
GetChildren returns the Children field if non-nil, zero value otherwise.
|
||||
|
||||
### GetChildrenOk
|
||||
|
||||
`func (o *ExpandedPermissionTree) GetChildrenOk() (*[]ExpandedPermissionTree, bool)`
|
||||
|
||||
GetChildrenOk returns a tuple with the Children field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetChildren
|
||||
|
||||
`func (o *ExpandedPermissionTree) SetChildren(v []ExpandedPermissionTree)`
|
||||
|
||||
SetChildren sets Children field to given value.
|
||||
|
||||
### HasChildren
|
||||
|
||||
`func (o *ExpandedPermissionTree) HasChildren() bool`
|
||||
|
||||
HasChildren returns a boolean if a field has been set.
|
||||
|
||||
### GetTuple
|
||||
|
||||
`func (o *ExpandedPermissionTree) GetTuple() Relationship`
|
||||
|
||||
GetTuple returns the Tuple field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTupleOk
|
||||
|
||||
`func (o *ExpandedPermissionTree) GetTupleOk() (*Relationship, bool)`
|
||||
|
||||
GetTupleOk returns a tuple with the Tuple field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetTuple
|
||||
|
||||
`func (o *ExpandedPermissionTree) SetTuple(v Relationship)`
|
||||
|
||||
SetTuple sets Tuple field to given value.
|
||||
|
||||
### HasTuple
|
||||
|
||||
`func (o *ExpandedPermissionTree) HasTuple() bool`
|
||||
|
||||
HasTuple returns a boolean if a field has been set.
|
||||
|
||||
### GetType
|
||||
|
||||
`func (o *ExpandedPermissionTree) GetType() string`
|
||||
|
||||
GetType returns the Type field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTypeOk
|
||||
|
||||
`func (o *ExpandedPermissionTree) GetTypeOk() (*string, bool)`
|
||||
|
||||
GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetType
|
||||
|
||||
`func (o *ExpandedPermissionTree) SetType(v string)`
|
||||
|
||||
SetType sets Type field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
233
internal/httpclient/docs/GenericError.md
generated
Normal file
233
internal/httpclient/docs/GenericError.md
generated
Normal file
@@ -0,0 +1,233 @@
|
||||
# GenericError
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Code** | Pointer to **int64** | The status code | [optional]
|
||||
**Debug** | Pointer to **string** | Debug information This field is often not exposed to protect against leaking sensitive information. | [optional]
|
||||
**Details** | Pointer to **map[string]interface{}** | Further error details | [optional]
|
||||
**Id** | Pointer to **string** | The error ID Useful when trying to identify various errors in application logic. | [optional]
|
||||
**Message** | **string** | Error message The error's message. |
|
||||
**Reason** | Pointer to **string** | A human-readable reason for the error | [optional]
|
||||
**Request** | Pointer to **string** | The request ID The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID. | [optional]
|
||||
**Status** | Pointer to **string** | The status description | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewGenericError
|
||||
|
||||
`func NewGenericError(message string, ) *GenericError`
|
||||
|
||||
NewGenericError instantiates a new GenericError object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewGenericErrorWithDefaults
|
||||
|
||||
`func NewGenericErrorWithDefaults() *GenericError`
|
||||
|
||||
NewGenericErrorWithDefaults instantiates a new GenericError object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetCode
|
||||
|
||||
`func (o *GenericError) GetCode() int64`
|
||||
|
||||
GetCode returns the Code field if non-nil, zero value otherwise.
|
||||
|
||||
### GetCodeOk
|
||||
|
||||
`func (o *GenericError) GetCodeOk() (*int64, bool)`
|
||||
|
||||
GetCodeOk returns a tuple with the Code field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetCode
|
||||
|
||||
`func (o *GenericError) SetCode(v int64)`
|
||||
|
||||
SetCode sets Code field to given value.
|
||||
|
||||
### HasCode
|
||||
|
||||
`func (o *GenericError) HasCode() bool`
|
||||
|
||||
HasCode returns a boolean if a field has been set.
|
||||
|
||||
### GetDebug
|
||||
|
||||
`func (o *GenericError) GetDebug() string`
|
||||
|
||||
GetDebug returns the Debug field if non-nil, zero value otherwise.
|
||||
|
||||
### GetDebugOk
|
||||
|
||||
`func (o *GenericError) GetDebugOk() (*string, bool)`
|
||||
|
||||
GetDebugOk returns a tuple with the Debug field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetDebug
|
||||
|
||||
`func (o *GenericError) SetDebug(v string)`
|
||||
|
||||
SetDebug sets Debug field to given value.
|
||||
|
||||
### HasDebug
|
||||
|
||||
`func (o *GenericError) HasDebug() bool`
|
||||
|
||||
HasDebug returns a boolean if a field has been set.
|
||||
|
||||
### GetDetails
|
||||
|
||||
`func (o *GenericError) GetDetails() map[string]interface{}`
|
||||
|
||||
GetDetails returns the Details field if non-nil, zero value otherwise.
|
||||
|
||||
### GetDetailsOk
|
||||
|
||||
`func (o *GenericError) GetDetailsOk() (*map[string]interface{}, bool)`
|
||||
|
||||
GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetDetails
|
||||
|
||||
`func (o *GenericError) SetDetails(v map[string]interface{})`
|
||||
|
||||
SetDetails sets Details field to given value.
|
||||
|
||||
### HasDetails
|
||||
|
||||
`func (o *GenericError) HasDetails() bool`
|
||||
|
||||
HasDetails returns a boolean if a field has been set.
|
||||
|
||||
### GetId
|
||||
|
||||
`func (o *GenericError) GetId() string`
|
||||
|
||||
GetId returns the Id field if non-nil, zero value otherwise.
|
||||
|
||||
### GetIdOk
|
||||
|
||||
`func (o *GenericError) GetIdOk() (*string, bool)`
|
||||
|
||||
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetId
|
||||
|
||||
`func (o *GenericError) SetId(v string)`
|
||||
|
||||
SetId sets Id field to given value.
|
||||
|
||||
### HasId
|
||||
|
||||
`func (o *GenericError) HasId() bool`
|
||||
|
||||
HasId returns a boolean if a field has been set.
|
||||
|
||||
### GetMessage
|
||||
|
||||
`func (o *GenericError) GetMessage() string`
|
||||
|
||||
GetMessage returns the Message field if non-nil, zero value otherwise.
|
||||
|
||||
### GetMessageOk
|
||||
|
||||
`func (o *GenericError) GetMessageOk() (*string, bool)`
|
||||
|
||||
GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetMessage
|
||||
|
||||
`func (o *GenericError) SetMessage(v string)`
|
||||
|
||||
SetMessage sets Message field to given value.
|
||||
|
||||
|
||||
### GetReason
|
||||
|
||||
`func (o *GenericError) GetReason() string`
|
||||
|
||||
GetReason returns the Reason field if non-nil, zero value otherwise.
|
||||
|
||||
### GetReasonOk
|
||||
|
||||
`func (o *GenericError) GetReasonOk() (*string, bool)`
|
||||
|
||||
GetReasonOk returns a tuple with the Reason field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetReason
|
||||
|
||||
`func (o *GenericError) SetReason(v string)`
|
||||
|
||||
SetReason sets Reason field to given value.
|
||||
|
||||
### HasReason
|
||||
|
||||
`func (o *GenericError) HasReason() bool`
|
||||
|
||||
HasReason returns a boolean if a field has been set.
|
||||
|
||||
### GetRequest
|
||||
|
||||
`func (o *GenericError) GetRequest() string`
|
||||
|
||||
GetRequest returns the Request field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRequestOk
|
||||
|
||||
`func (o *GenericError) GetRequestOk() (*string, bool)`
|
||||
|
||||
GetRequestOk returns a tuple with the Request field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRequest
|
||||
|
||||
`func (o *GenericError) SetRequest(v string)`
|
||||
|
||||
SetRequest sets Request field to given value.
|
||||
|
||||
### HasRequest
|
||||
|
||||
`func (o *GenericError) HasRequest() bool`
|
||||
|
||||
HasRequest returns a boolean if a field has been set.
|
||||
|
||||
### GetStatus
|
||||
|
||||
`func (o *GenericError) GetStatus() string`
|
||||
|
||||
GetStatus returns the Status field if non-nil, zero value otherwise.
|
||||
|
||||
### GetStatusOk
|
||||
|
||||
`func (o *GenericError) GetStatusOk() (*string, bool)`
|
||||
|
||||
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetStatus
|
||||
|
||||
`func (o *GenericError) SetStatus(v string)`
|
||||
|
||||
SetStatus sets Status field to given value.
|
||||
|
||||
### HasStatus
|
||||
|
||||
`func (o *GenericError) HasStatus() bool`
|
||||
|
||||
HasStatus returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
51
internal/httpclient/docs/GetVersion200Response.md
generated
Normal file
51
internal/httpclient/docs/GetVersion200Response.md
generated
Normal file
@@ -0,0 +1,51 @@
|
||||
# GetVersion200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Version** | **string** | The version of Ory Keto. |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewGetVersion200Response
|
||||
|
||||
`func NewGetVersion200Response(version string, ) *GetVersion200Response`
|
||||
|
||||
NewGetVersion200Response instantiates a new GetVersion200Response object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewGetVersion200ResponseWithDefaults
|
||||
|
||||
`func NewGetVersion200ResponseWithDefaults() *GetVersion200Response`
|
||||
|
||||
NewGetVersion200ResponseWithDefaults instantiates a new GetVersion200Response object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetVersion
|
||||
|
||||
`func (o *GetVersion200Response) GetVersion() string`
|
||||
|
||||
GetVersion returns the Version field if non-nil, zero value otherwise.
|
||||
|
||||
### GetVersionOk
|
||||
|
||||
`func (o *GetVersion200Response) GetVersionOk() (*string, bool)`
|
||||
|
||||
GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetVersion
|
||||
|
||||
`func (o *GetVersion200Response) SetVersion(v string)`
|
||||
|
||||
SetVersion sets Version field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
56
internal/httpclient/docs/HealthNotReadyStatus.md
generated
Normal file
56
internal/httpclient/docs/HealthNotReadyStatus.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# HealthNotReadyStatus
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Errors** | Pointer to **map[string]string** | Errors contains a list of errors that caused the not ready status. | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewHealthNotReadyStatus
|
||||
|
||||
`func NewHealthNotReadyStatus() *HealthNotReadyStatus`
|
||||
|
||||
NewHealthNotReadyStatus instantiates a new HealthNotReadyStatus object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewHealthNotReadyStatusWithDefaults
|
||||
|
||||
`func NewHealthNotReadyStatusWithDefaults() *HealthNotReadyStatus`
|
||||
|
||||
NewHealthNotReadyStatusWithDefaults instantiates a new HealthNotReadyStatus object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetErrors
|
||||
|
||||
`func (o *HealthNotReadyStatus) GetErrors() map[string]string`
|
||||
|
||||
GetErrors returns the Errors field if non-nil, zero value otherwise.
|
||||
|
||||
### GetErrorsOk
|
||||
|
||||
`func (o *HealthNotReadyStatus) GetErrorsOk() (*map[string]string, bool)`
|
||||
|
||||
GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetErrors
|
||||
|
||||
`func (o *HealthNotReadyStatus) SetErrors(v map[string]string)`
|
||||
|
||||
SetErrors sets Errors field to given value.
|
||||
|
||||
### HasErrors
|
||||
|
||||
`func (o *HealthNotReadyStatus) HasErrors() bool`
|
||||
|
||||
HasErrors returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
56
internal/httpclient/docs/HealthStatus.md
generated
Normal file
56
internal/httpclient/docs/HealthStatus.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# HealthStatus
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Status** | Pointer to **string** | Status always contains \"ok\". | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewHealthStatus
|
||||
|
||||
`func NewHealthStatus() *HealthStatus`
|
||||
|
||||
NewHealthStatus instantiates a new HealthStatus object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewHealthStatusWithDefaults
|
||||
|
||||
`func NewHealthStatusWithDefaults() *HealthStatus`
|
||||
|
||||
NewHealthStatusWithDefaults instantiates a new HealthStatus object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetStatus
|
||||
|
||||
`func (o *HealthStatus) GetStatus() string`
|
||||
|
||||
GetStatus returns the Status field if non-nil, zero value otherwise.
|
||||
|
||||
### GetStatusOk
|
||||
|
||||
`func (o *HealthStatus) GetStatusOk() (*string, bool)`
|
||||
|
||||
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetStatus
|
||||
|
||||
`func (o *HealthStatus) SetStatus(v string)`
|
||||
|
||||
SetStatus sets Status field to given value.
|
||||
|
||||
### HasStatus
|
||||
|
||||
`func (o *HealthStatus) HasStatus() bool`
|
||||
|
||||
HasStatus returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
51
internal/httpclient/docs/IsAlive200Response.md
generated
Normal file
51
internal/httpclient/docs/IsAlive200Response.md
generated
Normal file
@@ -0,0 +1,51 @@
|
||||
# IsAlive200Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Status** | **string** | Always \"ok\". |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewIsAlive200Response
|
||||
|
||||
`func NewIsAlive200Response(status string, ) *IsAlive200Response`
|
||||
|
||||
NewIsAlive200Response instantiates a new IsAlive200Response object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewIsAlive200ResponseWithDefaults
|
||||
|
||||
`func NewIsAlive200ResponseWithDefaults() *IsAlive200Response`
|
||||
|
||||
NewIsAlive200ResponseWithDefaults instantiates a new IsAlive200Response object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetStatus
|
||||
|
||||
`func (o *IsAlive200Response) GetStatus() string`
|
||||
|
||||
GetStatus returns the Status field if non-nil, zero value otherwise.
|
||||
|
||||
### GetStatusOk
|
||||
|
||||
`func (o *IsAlive200Response) GetStatusOk() (*string, bool)`
|
||||
|
||||
GetStatusOk returns a tuple with the Status field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetStatus
|
||||
|
||||
`func (o *IsAlive200Response) SetStatus(v string)`
|
||||
|
||||
SetStatus sets Status field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
51
internal/httpclient/docs/IsReady503Response.md
generated
Normal file
51
internal/httpclient/docs/IsReady503Response.md
generated
Normal file
@@ -0,0 +1,51 @@
|
||||
# IsReady503Response
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Errors** | **map[string]string** | Errors contains a list of errors that caused the not ready status. |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewIsReady503Response
|
||||
|
||||
`func NewIsReady503Response(errors map[string]string, ) *IsReady503Response`
|
||||
|
||||
NewIsReady503Response instantiates a new IsReady503Response object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewIsReady503ResponseWithDefaults
|
||||
|
||||
`func NewIsReady503ResponseWithDefaults() *IsReady503Response`
|
||||
|
||||
NewIsReady503ResponseWithDefaults instantiates a new IsReady503Response object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetErrors
|
||||
|
||||
`func (o *IsReady503Response) GetErrors() map[string]string`
|
||||
|
||||
GetErrors returns the Errors field if non-nil, zero value otherwise.
|
||||
|
||||
### GetErrorsOk
|
||||
|
||||
`func (o *IsReady503Response) GetErrorsOk() (*map[string]string, bool)`
|
||||
|
||||
GetErrorsOk returns a tuple with the Errors field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetErrors
|
||||
|
||||
`func (o *IsReady503Response) SetErrors(v map[string]string)`
|
||||
|
||||
SetErrors sets Errors field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
194
internal/httpclient/docs/MetadataApi.md
generated
Normal file
194
internal/httpclient/docs/MetadataApi.md
generated
Normal file
@@ -0,0 +1,194 @@
|
||||
# \MetadataApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**GetVersion**](MetadataApi.md#GetVersion) | **Get** /version | Return Running Software Version.
|
||||
[**IsAlive**](MetadataApi.md#IsAlive) | **Get** /health/alive | Check HTTP Server Status
|
||||
[**IsReady**](MetadataApi.md#IsReady) | **Get** /health/ready | Check HTTP Server and Database Status
|
||||
|
||||
|
||||
|
||||
## GetVersion
|
||||
|
||||
> GetVersion200Response GetVersion(ctx).Execute()
|
||||
|
||||
Return Running Software Version.
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.MetadataApi.GetVersion(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.GetVersion``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `GetVersion`: GetVersion200Response
|
||||
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.GetVersion`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiGetVersionRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**GetVersion200Response**](GetVersion200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## IsAlive
|
||||
|
||||
> IsAlive200Response IsAlive(ctx).Execute()
|
||||
|
||||
Check HTTP Server Status
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.MetadataApi.IsAlive(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.IsAlive``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `IsAlive`: IsAlive200Response
|
||||
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.IsAlive`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiIsAliveRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**IsAlive200Response**](IsAlive200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## IsReady
|
||||
|
||||
> IsAlive200Response IsReady(ctx).Execute()
|
||||
|
||||
Check HTTP Server and Database Status
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.MetadataApi.IsReady(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `MetadataApi.IsReady``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `IsReady`: IsAlive200Response
|
||||
fmt.Fprintf(os.Stdout, "Response from `MetadataApi.IsReady`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiIsReadyRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**IsAlive200Response**](IsAlive200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json, text/plain
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
56
internal/httpclient/docs/Namespace.md
generated
Normal file
56
internal/httpclient/docs/Namespace.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# Namespace
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **string** | Name of the namespace. | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewNamespace
|
||||
|
||||
`func NewNamespace() *Namespace`
|
||||
|
||||
NewNamespace instantiates a new Namespace object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewNamespaceWithDefaults
|
||||
|
||||
`func NewNamespaceWithDefaults() *Namespace`
|
||||
|
||||
NewNamespaceWithDefaults instantiates a new Namespace object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetName
|
||||
|
||||
`func (o *Namespace) GetName() string`
|
||||
|
||||
GetName returns the Name field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNameOk
|
||||
|
||||
`func (o *Namespace) GetNameOk() (*string, bool)`
|
||||
|
||||
GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetName
|
||||
|
||||
`func (o *Namespace) SetName(v string)`
|
||||
|
||||
SetName sets Name field to given value.
|
||||
|
||||
### HasName
|
||||
|
||||
`func (o *Namespace) HasName() bool`
|
||||
|
||||
HasName returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
108
internal/httpclient/docs/ParseError.md
generated
Normal file
108
internal/httpclient/docs/ParseError.md
generated
Normal file
@@ -0,0 +1,108 @@
|
||||
# ParseError
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**End** | Pointer to [**SourcePosition**](SourcePosition.md) | | [optional]
|
||||
**Message** | Pointer to **string** | | [optional]
|
||||
**Start** | Pointer to [**SourcePosition**](SourcePosition.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewParseError
|
||||
|
||||
`func NewParseError() *ParseError`
|
||||
|
||||
NewParseError instantiates a new ParseError object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewParseErrorWithDefaults
|
||||
|
||||
`func NewParseErrorWithDefaults() *ParseError`
|
||||
|
||||
NewParseErrorWithDefaults instantiates a new ParseError object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetEnd
|
||||
|
||||
`func (o *ParseError) GetEnd() SourcePosition`
|
||||
|
||||
GetEnd returns the End field if non-nil, zero value otherwise.
|
||||
|
||||
### GetEndOk
|
||||
|
||||
`func (o *ParseError) GetEndOk() (*SourcePosition, bool)`
|
||||
|
||||
GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetEnd
|
||||
|
||||
`func (o *ParseError) SetEnd(v SourcePosition)`
|
||||
|
||||
SetEnd sets End field to given value.
|
||||
|
||||
### HasEnd
|
||||
|
||||
`func (o *ParseError) HasEnd() bool`
|
||||
|
||||
HasEnd returns a boolean if a field has been set.
|
||||
|
||||
### GetMessage
|
||||
|
||||
`func (o *ParseError) GetMessage() string`
|
||||
|
||||
GetMessage returns the Message field if non-nil, zero value otherwise.
|
||||
|
||||
### GetMessageOk
|
||||
|
||||
`func (o *ParseError) GetMessageOk() (*string, bool)`
|
||||
|
||||
GetMessageOk returns a tuple with the Message field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetMessage
|
||||
|
||||
`func (o *ParseError) SetMessage(v string)`
|
||||
|
||||
SetMessage sets Message field to given value.
|
||||
|
||||
### HasMessage
|
||||
|
||||
`func (o *ParseError) HasMessage() bool`
|
||||
|
||||
HasMessage returns a boolean if a field has been set.
|
||||
|
||||
### GetStart
|
||||
|
||||
`func (o *ParseError) GetStart() SourcePosition`
|
||||
|
||||
GetStart returns the Start field if non-nil, zero value otherwise.
|
||||
|
||||
### GetStartOk
|
||||
|
||||
`func (o *ParseError) GetStartOk() (*SourcePosition, bool)`
|
||||
|
||||
GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetStart
|
||||
|
||||
`func (o *ParseError) SetStart(v SourcePosition)`
|
||||
|
||||
SetStart sets Start field to given value.
|
||||
|
||||
### HasStart
|
||||
|
||||
`func (o *ParseError) HasStart() bool`
|
||||
|
||||
HasStart returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
450
internal/httpclient/docs/PermissionApi.md
generated
Normal file
450
internal/httpclient/docs/PermissionApi.md
generated
Normal file
@@ -0,0 +1,450 @@
|
||||
# \PermissionApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**BatchCheckPermission**](PermissionApi.md#BatchCheckPermission) | **Post** /relation-tuples/batch/check | Batch check permissions
|
||||
[**CheckPermission**](PermissionApi.md#CheckPermission) | **Get** /relation-tuples/check/openapi | Check a permission
|
||||
[**CheckPermissionOrError**](PermissionApi.md#CheckPermissionOrError) | **Get** /relation-tuples/check | Check a permission
|
||||
[**ExpandPermissions**](PermissionApi.md#ExpandPermissions) | **Get** /relation-tuples/expand | Expand a Relationship into permissions.
|
||||
[**PostCheckPermission**](PermissionApi.md#PostCheckPermission) | **Post** /relation-tuples/check/openapi | Check a permission
|
||||
[**PostCheckPermissionOrError**](PermissionApi.md#PostCheckPermissionOrError) | **Post** /relation-tuples/check | Check a permission
|
||||
|
||||
|
||||
|
||||
## BatchCheckPermission
|
||||
|
||||
> BatchCheckPermissionResult BatchCheckPermission(ctx).MaxDepth(maxDepth).BatchCheckPermissionBody(batchCheckPermissionBody).Execute()
|
||||
|
||||
Batch check permissions
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
maxDepth := int64(789) // int64 | (optional)
|
||||
batchCheckPermissionBody := *openapiclient.NewBatchCheckPermissionBody() // BatchCheckPermissionBody | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.PermissionApi.BatchCheckPermission(context.Background()).MaxDepth(maxDepth).BatchCheckPermissionBody(batchCheckPermissionBody).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `PermissionApi.BatchCheckPermission``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `BatchCheckPermission`: BatchCheckPermissionResult
|
||||
fmt.Fprintf(os.Stdout, "Response from `PermissionApi.BatchCheckPermission`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiBatchCheckPermissionRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**maxDepth** | **int64** | |
|
||||
**batchCheckPermissionBody** | [**BatchCheckPermissionBody**](BatchCheckPermissionBody.md) | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**BatchCheckPermissionResult**](BatchCheckPermissionResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## CheckPermission
|
||||
|
||||
> CheckPermissionResult CheckPermission(ctx).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).MaxDepth(maxDepth).Execute()
|
||||
|
||||
Check a permission
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
namespace := "namespace_example" // string | Namespace of the Relationship (optional)
|
||||
object := "object_example" // string | Object of the Relationship (optional)
|
||||
relation := "relation_example" // string | Relation of the Relationship (optional)
|
||||
subjectId := "subjectId_example" // string | SubjectID of the Relationship (optional)
|
||||
subjectSetNamespace := "subjectSetNamespace_example" // string | Namespace of the Subject Set (optional)
|
||||
subjectSetObject := "subjectSetObject_example" // string | Object of the Subject Set (optional)
|
||||
subjectSetRelation := "subjectSetRelation_example" // string | Relation of the Subject Set (optional)
|
||||
maxDepth := int64(789) // int64 | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.PermissionApi.CheckPermission(context.Background()).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).MaxDepth(maxDepth).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `PermissionApi.CheckPermission``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `CheckPermission`: CheckPermissionResult
|
||||
fmt.Fprintf(os.Stdout, "Response from `PermissionApi.CheckPermission`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiCheckPermissionRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **string** | Namespace of the Relationship |
|
||||
**object** | **string** | Object of the Relationship |
|
||||
**relation** | **string** | Relation of the Relationship |
|
||||
**subjectId** | **string** | SubjectID of the Relationship |
|
||||
**subjectSetNamespace** | **string** | Namespace of the Subject Set |
|
||||
**subjectSetObject** | **string** | Object of the Subject Set |
|
||||
**subjectSetRelation** | **string** | Relation of the Subject Set |
|
||||
**maxDepth** | **int64** | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CheckPermissionResult**](CheckPermissionResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## CheckPermissionOrError
|
||||
|
||||
> CheckPermissionResult CheckPermissionOrError(ctx).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).MaxDepth(maxDepth).Execute()
|
||||
|
||||
Check a permission
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
namespace := "namespace_example" // string | Namespace of the Relationship (optional)
|
||||
object := "object_example" // string | Object of the Relationship (optional)
|
||||
relation := "relation_example" // string | Relation of the Relationship (optional)
|
||||
subjectId := "subjectId_example" // string | SubjectID of the Relationship (optional)
|
||||
subjectSetNamespace := "subjectSetNamespace_example" // string | Namespace of the Subject Set (optional)
|
||||
subjectSetObject := "subjectSetObject_example" // string | Object of the Subject Set (optional)
|
||||
subjectSetRelation := "subjectSetRelation_example" // string | Relation of the Subject Set (optional)
|
||||
maxDepth := int64(789) // int64 | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.PermissionApi.CheckPermissionOrError(context.Background()).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).MaxDepth(maxDepth).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `PermissionApi.CheckPermissionOrError``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `CheckPermissionOrError`: CheckPermissionResult
|
||||
fmt.Fprintf(os.Stdout, "Response from `PermissionApi.CheckPermissionOrError`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiCheckPermissionOrErrorRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **string** | Namespace of the Relationship |
|
||||
**object** | **string** | Object of the Relationship |
|
||||
**relation** | **string** | Relation of the Relationship |
|
||||
**subjectId** | **string** | SubjectID of the Relationship |
|
||||
**subjectSetNamespace** | **string** | Namespace of the Subject Set |
|
||||
**subjectSetObject** | **string** | Object of the Subject Set |
|
||||
**subjectSetRelation** | **string** | Relation of the Subject Set |
|
||||
**maxDepth** | **int64** | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CheckPermissionResult**](CheckPermissionResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## ExpandPermissions
|
||||
|
||||
> ExpandedPermissionTree ExpandPermissions(ctx).Namespace(namespace).Object(object).Relation(relation).MaxDepth(maxDepth).Execute()
|
||||
|
||||
Expand a Relationship into permissions.
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
namespace := "namespace_example" // string | Namespace of the Subject Set
|
||||
object := "object_example" // string | Object of the Subject Set
|
||||
relation := "relation_example" // string | Relation of the Subject Set
|
||||
maxDepth := int64(789) // int64 | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.PermissionApi.ExpandPermissions(context.Background()).Namespace(namespace).Object(object).Relation(relation).MaxDepth(maxDepth).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `PermissionApi.ExpandPermissions``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `ExpandPermissions`: ExpandedPermissionTree
|
||||
fmt.Fprintf(os.Stdout, "Response from `PermissionApi.ExpandPermissions`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiExpandPermissionsRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **string** | Namespace of the Subject Set |
|
||||
**object** | **string** | Object of the Subject Set |
|
||||
**relation** | **string** | Relation of the Subject Set |
|
||||
**maxDepth** | **int64** | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ExpandedPermissionTree**](ExpandedPermissionTree.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## PostCheckPermission
|
||||
|
||||
> CheckPermissionResult PostCheckPermission(ctx).MaxDepth(maxDepth).PostCheckPermissionBody(postCheckPermissionBody).Execute()
|
||||
|
||||
Check a permission
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
maxDepth := int64(789) // int64 | (optional)
|
||||
postCheckPermissionBody := *openapiclient.NewPostCheckPermissionBody() // PostCheckPermissionBody | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.PermissionApi.PostCheckPermission(context.Background()).MaxDepth(maxDepth).PostCheckPermissionBody(postCheckPermissionBody).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `PermissionApi.PostCheckPermission``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `PostCheckPermission`: CheckPermissionResult
|
||||
fmt.Fprintf(os.Stdout, "Response from `PermissionApi.PostCheckPermission`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiPostCheckPermissionRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**maxDepth** | **int64** | |
|
||||
**postCheckPermissionBody** | [**PostCheckPermissionBody**](PostCheckPermissionBody.md) | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CheckPermissionResult**](CheckPermissionResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## PostCheckPermissionOrError
|
||||
|
||||
> CheckPermissionResult PostCheckPermissionOrError(ctx).MaxDepth(maxDepth).PostCheckPermissionOrErrorBody(postCheckPermissionOrErrorBody).Execute()
|
||||
|
||||
Check a permission
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
maxDepth := int64(789) // int64 | (optional)
|
||||
postCheckPermissionOrErrorBody := *openapiclient.NewPostCheckPermissionOrErrorBody() // PostCheckPermissionOrErrorBody | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.PermissionApi.PostCheckPermissionOrError(context.Background()).MaxDepth(maxDepth).PostCheckPermissionOrErrorBody(postCheckPermissionOrErrorBody).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `PermissionApi.PostCheckPermissionOrError``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `PostCheckPermissionOrError`: CheckPermissionResult
|
||||
fmt.Fprintf(os.Stdout, "Response from `PermissionApi.PostCheckPermissionOrError`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiPostCheckPermissionOrErrorRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**maxDepth** | **int64** | |
|
||||
**postCheckPermissionOrErrorBody** | [**PostCheckPermissionOrErrorBody**](PostCheckPermissionOrErrorBody.md) | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CheckPermissionResult**](CheckPermissionResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
160
internal/httpclient/docs/PostCheckPermissionBody.md
generated
Normal file
160
internal/httpclient/docs/PostCheckPermissionBody.md
generated
Normal file
@@ -0,0 +1,160 @@
|
||||
# PostCheckPermissionBody
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespace** | Pointer to **string** | Namespace to query | [optional]
|
||||
**Object** | Pointer to **string** | Object to query | [optional]
|
||||
**Relation** | Pointer to **string** | Relation to query | [optional]
|
||||
**SubjectId** | Pointer to **string** | SubjectID to query Either SubjectSet or SubjectID can be provided. | [optional]
|
||||
**SubjectSet** | Pointer to [**SubjectSet**](SubjectSet.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewPostCheckPermissionBody
|
||||
|
||||
`func NewPostCheckPermissionBody() *PostCheckPermissionBody`
|
||||
|
||||
NewPostCheckPermissionBody instantiates a new PostCheckPermissionBody object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewPostCheckPermissionBodyWithDefaults
|
||||
|
||||
`func NewPostCheckPermissionBodyWithDefaults() *PostCheckPermissionBody`
|
||||
|
||||
NewPostCheckPermissionBodyWithDefaults instantiates a new PostCheckPermissionBody object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespace
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetNamespace() string`
|
||||
|
||||
GetNamespace returns the Namespace field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespaceOk
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetNamespaceOk() (*string, bool)`
|
||||
|
||||
GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespace
|
||||
|
||||
`func (o *PostCheckPermissionBody) SetNamespace(v string)`
|
||||
|
||||
SetNamespace sets Namespace field to given value.
|
||||
|
||||
### HasNamespace
|
||||
|
||||
`func (o *PostCheckPermissionBody) HasNamespace() bool`
|
||||
|
||||
HasNamespace returns a boolean if a field has been set.
|
||||
|
||||
### GetObject
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetObject() string`
|
||||
|
||||
GetObject returns the Object field if non-nil, zero value otherwise.
|
||||
|
||||
### GetObjectOk
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetObjectOk() (*string, bool)`
|
||||
|
||||
GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetObject
|
||||
|
||||
`func (o *PostCheckPermissionBody) SetObject(v string)`
|
||||
|
||||
SetObject sets Object field to given value.
|
||||
|
||||
### HasObject
|
||||
|
||||
`func (o *PostCheckPermissionBody) HasObject() bool`
|
||||
|
||||
HasObject returns a boolean if a field has been set.
|
||||
|
||||
### GetRelation
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetRelation() string`
|
||||
|
||||
GetRelation returns the Relation field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationOk
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetRelationOk() (*string, bool)`
|
||||
|
||||
GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelation
|
||||
|
||||
`func (o *PostCheckPermissionBody) SetRelation(v string)`
|
||||
|
||||
SetRelation sets Relation field to given value.
|
||||
|
||||
### HasRelation
|
||||
|
||||
`func (o *PostCheckPermissionBody) HasRelation() bool`
|
||||
|
||||
HasRelation returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectId
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetSubjectId() string`
|
||||
|
||||
GetSubjectId returns the SubjectId field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectIdOk
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetSubjectIdOk() (*string, bool)`
|
||||
|
||||
GetSubjectIdOk returns a tuple with the SubjectId field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectId
|
||||
|
||||
`func (o *PostCheckPermissionBody) SetSubjectId(v string)`
|
||||
|
||||
SetSubjectId sets SubjectId field to given value.
|
||||
|
||||
### HasSubjectId
|
||||
|
||||
`func (o *PostCheckPermissionBody) HasSubjectId() bool`
|
||||
|
||||
HasSubjectId returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectSet
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetSubjectSet() SubjectSet`
|
||||
|
||||
GetSubjectSet returns the SubjectSet field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectSetOk
|
||||
|
||||
`func (o *PostCheckPermissionBody) GetSubjectSetOk() (*SubjectSet, bool)`
|
||||
|
||||
GetSubjectSetOk returns a tuple with the SubjectSet field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectSet
|
||||
|
||||
`func (o *PostCheckPermissionBody) SetSubjectSet(v SubjectSet)`
|
||||
|
||||
SetSubjectSet sets SubjectSet field to given value.
|
||||
|
||||
### HasSubjectSet
|
||||
|
||||
`func (o *PostCheckPermissionBody) HasSubjectSet() bool`
|
||||
|
||||
HasSubjectSet returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
160
internal/httpclient/docs/PostCheckPermissionOrErrorBody.md
generated
Normal file
160
internal/httpclient/docs/PostCheckPermissionOrErrorBody.md
generated
Normal file
@@ -0,0 +1,160 @@
|
||||
# PostCheckPermissionOrErrorBody
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespace** | Pointer to **string** | Namespace to query | [optional]
|
||||
**Object** | Pointer to **string** | Object to query | [optional]
|
||||
**Relation** | Pointer to **string** | Relation to query | [optional]
|
||||
**SubjectId** | Pointer to **string** | SubjectID to query Either SubjectSet or SubjectID can be provided. | [optional]
|
||||
**SubjectSet** | Pointer to [**SubjectSet**](SubjectSet.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewPostCheckPermissionOrErrorBody
|
||||
|
||||
`func NewPostCheckPermissionOrErrorBody() *PostCheckPermissionOrErrorBody`
|
||||
|
||||
NewPostCheckPermissionOrErrorBody instantiates a new PostCheckPermissionOrErrorBody object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewPostCheckPermissionOrErrorBodyWithDefaults
|
||||
|
||||
`func NewPostCheckPermissionOrErrorBodyWithDefaults() *PostCheckPermissionOrErrorBody`
|
||||
|
||||
NewPostCheckPermissionOrErrorBodyWithDefaults instantiates a new PostCheckPermissionOrErrorBody object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespace
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetNamespace() string`
|
||||
|
||||
GetNamespace returns the Namespace field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespaceOk
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetNamespaceOk() (*string, bool)`
|
||||
|
||||
GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespace
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) SetNamespace(v string)`
|
||||
|
||||
SetNamespace sets Namespace field to given value.
|
||||
|
||||
### HasNamespace
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) HasNamespace() bool`
|
||||
|
||||
HasNamespace returns a boolean if a field has been set.
|
||||
|
||||
### GetObject
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetObject() string`
|
||||
|
||||
GetObject returns the Object field if non-nil, zero value otherwise.
|
||||
|
||||
### GetObjectOk
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetObjectOk() (*string, bool)`
|
||||
|
||||
GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetObject
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) SetObject(v string)`
|
||||
|
||||
SetObject sets Object field to given value.
|
||||
|
||||
### HasObject
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) HasObject() bool`
|
||||
|
||||
HasObject returns a boolean if a field has been set.
|
||||
|
||||
### GetRelation
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetRelation() string`
|
||||
|
||||
GetRelation returns the Relation field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationOk
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetRelationOk() (*string, bool)`
|
||||
|
||||
GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelation
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) SetRelation(v string)`
|
||||
|
||||
SetRelation sets Relation field to given value.
|
||||
|
||||
### HasRelation
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) HasRelation() bool`
|
||||
|
||||
HasRelation returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectId
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetSubjectId() string`
|
||||
|
||||
GetSubjectId returns the SubjectId field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectIdOk
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetSubjectIdOk() (*string, bool)`
|
||||
|
||||
GetSubjectIdOk returns a tuple with the SubjectId field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectId
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) SetSubjectId(v string)`
|
||||
|
||||
SetSubjectId sets SubjectId field to given value.
|
||||
|
||||
### HasSubjectId
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) HasSubjectId() bool`
|
||||
|
||||
HasSubjectId returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectSet
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetSubjectSet() SubjectSet`
|
||||
|
||||
GetSubjectSet returns the SubjectSet field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectSetOk
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) GetSubjectSetOk() (*SubjectSet, bool)`
|
||||
|
||||
GetSubjectSetOk returns a tuple with the SubjectSet field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectSet
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) SetSubjectSet(v SubjectSet)`
|
||||
|
||||
SetSubjectSet sets SubjectSet field to given value.
|
||||
|
||||
### HasSubjectSet
|
||||
|
||||
`func (o *PostCheckPermissionOrErrorBody) HasSubjectSet() bool`
|
||||
|
||||
HasSubjectSet returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
160
internal/httpclient/docs/RelationQuery.md
generated
Normal file
160
internal/httpclient/docs/RelationQuery.md
generated
Normal file
@@ -0,0 +1,160 @@
|
||||
# RelationQuery
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespace** | Pointer to **string** | Namespace to query | [optional]
|
||||
**Object** | Pointer to **string** | Object to query | [optional]
|
||||
**Relation** | Pointer to **string** | Relation to query | [optional]
|
||||
**SubjectId** | Pointer to **string** | SubjectID to query Either SubjectSet or SubjectID can be provided. | [optional]
|
||||
**SubjectSet** | Pointer to [**SubjectSet**](SubjectSet.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewRelationQuery
|
||||
|
||||
`func NewRelationQuery() *RelationQuery`
|
||||
|
||||
NewRelationQuery instantiates a new RelationQuery object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewRelationQueryWithDefaults
|
||||
|
||||
`func NewRelationQueryWithDefaults() *RelationQuery`
|
||||
|
||||
NewRelationQueryWithDefaults instantiates a new RelationQuery object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespace
|
||||
|
||||
`func (o *RelationQuery) GetNamespace() string`
|
||||
|
||||
GetNamespace returns the Namespace field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespaceOk
|
||||
|
||||
`func (o *RelationQuery) GetNamespaceOk() (*string, bool)`
|
||||
|
||||
GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespace
|
||||
|
||||
`func (o *RelationQuery) SetNamespace(v string)`
|
||||
|
||||
SetNamespace sets Namespace field to given value.
|
||||
|
||||
### HasNamespace
|
||||
|
||||
`func (o *RelationQuery) HasNamespace() bool`
|
||||
|
||||
HasNamespace returns a boolean if a field has been set.
|
||||
|
||||
### GetObject
|
||||
|
||||
`func (o *RelationQuery) GetObject() string`
|
||||
|
||||
GetObject returns the Object field if non-nil, zero value otherwise.
|
||||
|
||||
### GetObjectOk
|
||||
|
||||
`func (o *RelationQuery) GetObjectOk() (*string, bool)`
|
||||
|
||||
GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetObject
|
||||
|
||||
`func (o *RelationQuery) SetObject(v string)`
|
||||
|
||||
SetObject sets Object field to given value.
|
||||
|
||||
### HasObject
|
||||
|
||||
`func (o *RelationQuery) HasObject() bool`
|
||||
|
||||
HasObject returns a boolean if a field has been set.
|
||||
|
||||
### GetRelation
|
||||
|
||||
`func (o *RelationQuery) GetRelation() string`
|
||||
|
||||
GetRelation returns the Relation field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationOk
|
||||
|
||||
`func (o *RelationQuery) GetRelationOk() (*string, bool)`
|
||||
|
||||
GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelation
|
||||
|
||||
`func (o *RelationQuery) SetRelation(v string)`
|
||||
|
||||
SetRelation sets Relation field to given value.
|
||||
|
||||
### HasRelation
|
||||
|
||||
`func (o *RelationQuery) HasRelation() bool`
|
||||
|
||||
HasRelation returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectId
|
||||
|
||||
`func (o *RelationQuery) GetSubjectId() string`
|
||||
|
||||
GetSubjectId returns the SubjectId field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectIdOk
|
||||
|
||||
`func (o *RelationQuery) GetSubjectIdOk() (*string, bool)`
|
||||
|
||||
GetSubjectIdOk returns a tuple with the SubjectId field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectId
|
||||
|
||||
`func (o *RelationQuery) SetSubjectId(v string)`
|
||||
|
||||
SetSubjectId sets SubjectId field to given value.
|
||||
|
||||
### HasSubjectId
|
||||
|
||||
`func (o *RelationQuery) HasSubjectId() bool`
|
||||
|
||||
HasSubjectId returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectSet
|
||||
|
||||
`func (o *RelationQuery) GetSubjectSet() SubjectSet`
|
||||
|
||||
GetSubjectSet returns the SubjectSet field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectSetOk
|
||||
|
||||
`func (o *RelationQuery) GetSubjectSetOk() (*SubjectSet, bool)`
|
||||
|
||||
GetSubjectSetOk returns a tuple with the SubjectSet field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectSet
|
||||
|
||||
`func (o *RelationQuery) SetSubjectSet(v SubjectSet)`
|
||||
|
||||
SetSubjectSet sets SubjectSet field to given value.
|
||||
|
||||
### HasSubjectSet
|
||||
|
||||
`func (o *RelationQuery) HasSubjectSet() bool`
|
||||
|
||||
HasSubjectSet returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
145
internal/httpclient/docs/Relationship.md
generated
Normal file
145
internal/httpclient/docs/Relationship.md
generated
Normal file
@@ -0,0 +1,145 @@
|
||||
# Relationship
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespace** | **string** | Namespace of the Relation Tuple |
|
||||
**Object** | **string** | Object of the Relation Tuple |
|
||||
**Relation** | **string** | Relation of the Relation Tuple |
|
||||
**SubjectId** | Pointer to **string** | SubjectID of the Relation Tuple Either SubjectSet or SubjectID can be provided. | [optional]
|
||||
**SubjectSet** | Pointer to [**SubjectSet**](SubjectSet.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewRelationship
|
||||
|
||||
`func NewRelationship(namespace string, object string, relation string, ) *Relationship`
|
||||
|
||||
NewRelationship instantiates a new Relationship object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewRelationshipWithDefaults
|
||||
|
||||
`func NewRelationshipWithDefaults() *Relationship`
|
||||
|
||||
NewRelationshipWithDefaults instantiates a new Relationship object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespace
|
||||
|
||||
`func (o *Relationship) GetNamespace() string`
|
||||
|
||||
GetNamespace returns the Namespace field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespaceOk
|
||||
|
||||
`func (o *Relationship) GetNamespaceOk() (*string, bool)`
|
||||
|
||||
GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespace
|
||||
|
||||
`func (o *Relationship) SetNamespace(v string)`
|
||||
|
||||
SetNamespace sets Namespace field to given value.
|
||||
|
||||
|
||||
### GetObject
|
||||
|
||||
`func (o *Relationship) GetObject() string`
|
||||
|
||||
GetObject returns the Object field if non-nil, zero value otherwise.
|
||||
|
||||
### GetObjectOk
|
||||
|
||||
`func (o *Relationship) GetObjectOk() (*string, bool)`
|
||||
|
||||
GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetObject
|
||||
|
||||
`func (o *Relationship) SetObject(v string)`
|
||||
|
||||
SetObject sets Object field to given value.
|
||||
|
||||
|
||||
### GetRelation
|
||||
|
||||
`func (o *Relationship) GetRelation() string`
|
||||
|
||||
GetRelation returns the Relation field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationOk
|
||||
|
||||
`func (o *Relationship) GetRelationOk() (*string, bool)`
|
||||
|
||||
GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelation
|
||||
|
||||
`func (o *Relationship) SetRelation(v string)`
|
||||
|
||||
SetRelation sets Relation field to given value.
|
||||
|
||||
|
||||
### GetSubjectId
|
||||
|
||||
`func (o *Relationship) GetSubjectId() string`
|
||||
|
||||
GetSubjectId returns the SubjectId field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectIdOk
|
||||
|
||||
`func (o *Relationship) GetSubjectIdOk() (*string, bool)`
|
||||
|
||||
GetSubjectIdOk returns a tuple with the SubjectId field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectId
|
||||
|
||||
`func (o *Relationship) SetSubjectId(v string)`
|
||||
|
||||
SetSubjectId sets SubjectId field to given value.
|
||||
|
||||
### HasSubjectId
|
||||
|
||||
`func (o *Relationship) HasSubjectId() bool`
|
||||
|
||||
HasSubjectId returns a boolean if a field has been set.
|
||||
|
||||
### GetSubjectSet
|
||||
|
||||
`func (o *Relationship) GetSubjectSet() SubjectSet`
|
||||
|
||||
GetSubjectSet returns the SubjectSet field if non-nil, zero value otherwise.
|
||||
|
||||
### GetSubjectSetOk
|
||||
|
||||
`func (o *Relationship) GetSubjectSetOk() (*SubjectSet, bool)`
|
||||
|
||||
GetSubjectSetOk returns a tuple with the SubjectSet field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetSubjectSet
|
||||
|
||||
`func (o *Relationship) SetSubjectSet(v SubjectSet)`
|
||||
|
||||
SetSubjectSet sets SubjectSet field to given value.
|
||||
|
||||
### HasSubjectSet
|
||||
|
||||
`func (o *Relationship) HasSubjectSet() bool`
|
||||
|
||||
HasSubjectSet returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
429
internal/httpclient/docs/RelationshipApi.md
generated
Normal file
429
internal/httpclient/docs/RelationshipApi.md
generated
Normal file
@@ -0,0 +1,429 @@
|
||||
# \RelationshipApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**CheckOplSyntax**](RelationshipApi.md#CheckOplSyntax) | **Post** /opl/syntax/check | Check the syntax of an OPL file
|
||||
[**CreateRelationship**](RelationshipApi.md#CreateRelationship) | **Put** /admin/relation-tuples | Create a Relationship
|
||||
[**DeleteRelationships**](RelationshipApi.md#DeleteRelationships) | **Delete** /admin/relation-tuples | Delete Relationships
|
||||
[**GetRelationships**](RelationshipApi.md#GetRelationships) | **Get** /relation-tuples | Query relationships
|
||||
[**ListRelationshipNamespaces**](RelationshipApi.md#ListRelationshipNamespaces) | **Get** /namespaces | Query namespaces
|
||||
[**PatchRelationships**](RelationshipApi.md#PatchRelationships) | **Patch** /admin/relation-tuples | Patch Multiple Relationships
|
||||
|
||||
|
||||
|
||||
## CheckOplSyntax
|
||||
|
||||
> CheckOplSyntaxResult CheckOplSyntax(ctx).Body(body).Execute()
|
||||
|
||||
Check the syntax of an OPL file
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
body := "body_example" // string | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.RelationshipApi.CheckOplSyntax(context.Background()).Body(body).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `RelationshipApi.CheckOplSyntax``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `CheckOplSyntax`: CheckOplSyntaxResult
|
||||
fmt.Fprintf(os.Stdout, "Response from `RelationshipApi.CheckOplSyntax`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiCheckOplSyntaxRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | **string** | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**CheckOplSyntaxResult**](CheckOplSyntaxResult.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: text/plain
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## CreateRelationship
|
||||
|
||||
> Relationship CreateRelationship(ctx).CreateRelationshipBody(createRelationshipBody).Execute()
|
||||
|
||||
Create a Relationship
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
createRelationshipBody := *openapiclient.NewCreateRelationshipBody() // CreateRelationshipBody | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.RelationshipApi.CreateRelationship(context.Background()).CreateRelationshipBody(createRelationshipBody).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `RelationshipApi.CreateRelationship``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `CreateRelationship`: Relationship
|
||||
fmt.Fprintf(os.Stdout, "Response from `RelationshipApi.CreateRelationship`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiCreateRelationshipRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**createRelationshipBody** | [**CreateRelationshipBody**](CreateRelationshipBody.md) | |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Relationship**](Relationship.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## DeleteRelationships
|
||||
|
||||
> DeleteRelationships(ctx).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).Execute()
|
||||
|
||||
Delete Relationships
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
namespace := "namespace_example" // string | Namespace of the Relationship (optional)
|
||||
object := "object_example" // string | Object of the Relationship (optional)
|
||||
relation := "relation_example" // string | Relation of the Relationship (optional)
|
||||
subjectId := "subjectId_example" // string | SubjectID of the Relationship (optional)
|
||||
subjectSetNamespace := "subjectSetNamespace_example" // string | Namespace of the Subject Set (optional)
|
||||
subjectSetObject := "subjectSetObject_example" // string | Object of the Subject Set (optional)
|
||||
subjectSetRelation := "subjectSetRelation_example" // string | Relation of the Subject Set (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.RelationshipApi.DeleteRelationships(context.Background()).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `RelationshipApi.DeleteRelationships``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiDeleteRelationshipsRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**namespace** | **string** | Namespace of the Relationship |
|
||||
**object** | **string** | Object of the Relationship |
|
||||
**relation** | **string** | Relation of the Relationship |
|
||||
**subjectId** | **string** | SubjectID of the Relationship |
|
||||
**subjectSetNamespace** | **string** | Namespace of the Subject Set |
|
||||
**subjectSetObject** | **string** | Object of the Subject Set |
|
||||
**subjectSetRelation** | **string** | Relation of the Subject Set |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## GetRelationships
|
||||
|
||||
> Relationships GetRelationships(ctx).PageSize(pageSize).PageToken(pageToken).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).Execute()
|
||||
|
||||
Query relationships
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
pageSize := int64(789) // int64 | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (optional) (default to 250)
|
||||
pageToken := "pageToken_example" // string | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (optional)
|
||||
namespace := "namespace_example" // string | Namespace of the Relationship (optional)
|
||||
object := "object_example" // string | Object of the Relationship (optional)
|
||||
relation := "relation_example" // string | Relation of the Relationship (optional)
|
||||
subjectId := "subjectId_example" // string | SubjectID of the Relationship (optional)
|
||||
subjectSetNamespace := "subjectSetNamespace_example" // string | Namespace of the Subject Set (optional)
|
||||
subjectSetObject := "subjectSetObject_example" // string | Object of the Subject Set (optional)
|
||||
subjectSetRelation := "subjectSetRelation_example" // string | Relation of the Subject Set (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.RelationshipApi.GetRelationships(context.Background()).PageSize(pageSize).PageToken(pageToken).Namespace(namespace).Object(object).Relation(relation).SubjectId(subjectId).SubjectSetNamespace(subjectSetNamespace).SubjectSetObject(subjectSetObject).SubjectSetRelation(subjectSetRelation).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `RelationshipApi.GetRelationships``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `GetRelationships`: Relationships
|
||||
fmt.Fprintf(os.Stdout, "Response from `RelationshipApi.GetRelationships`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiGetRelationshipsRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pageSize** | **int64** | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). | [default to 250]
|
||||
**pageToken** | **string** | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). |
|
||||
**namespace** | **string** | Namespace of the Relationship |
|
||||
**object** | **string** | Object of the Relationship |
|
||||
**relation** | **string** | Relation of the Relationship |
|
||||
**subjectId** | **string** | SubjectID of the Relationship |
|
||||
**subjectSetNamespace** | **string** | Namespace of the Subject Set |
|
||||
**subjectSetObject** | **string** | Object of the Subject Set |
|
||||
**subjectSetRelation** | **string** | Relation of the Subject Set |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Relationships**](Relationships.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## ListRelationshipNamespaces
|
||||
|
||||
> RelationshipNamespaces ListRelationshipNamespaces(ctx).Execute()
|
||||
|
||||
Query namespaces
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.RelationshipApi.ListRelationshipNamespaces(context.Background()).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `RelationshipApi.ListRelationshipNamespaces``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `ListRelationshipNamespaces`: RelationshipNamespaces
|
||||
fmt.Fprintf(os.Stdout, "Response from `RelationshipApi.ListRelationshipNamespaces`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiListRelationshipNamespacesRequest struct via the builder pattern
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**RelationshipNamespaces**](RelationshipNamespaces.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
|
||||
## PatchRelationships
|
||||
|
||||
> PatchRelationships(ctx).RelationshipPatch(relationshipPatch).Execute()
|
||||
|
||||
Patch Multiple Relationships
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "./openapi"
|
||||
)
|
||||
|
||||
func main() {
|
||||
relationshipPatch := []openapiclient.RelationshipPatch{*openapiclient.NewRelationshipPatch()} // []RelationshipPatch | (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.RelationshipApi.PatchRelationships(context.Background()).RelationshipPatch(relationshipPatch).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `RelationshipApi.PatchRelationships``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiPatchRelationshipsRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**relationshipPatch** | [**[]RelationshipPatch**](RelationshipPatch.md) | |
|
||||
|
||||
### Return type
|
||||
|
||||
(empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
||||
[[Back to Model list]](../README.md#documentation-for-models)
|
||||
[[Back to README]](../README.md)
|
||||
|
||||
56
internal/httpclient/docs/RelationshipNamespaces.md
generated
Normal file
56
internal/httpclient/docs/RelationshipNamespaces.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# RelationshipNamespaces
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespaces** | Pointer to [**[]Namespace**](Namespace.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewRelationshipNamespaces
|
||||
|
||||
`func NewRelationshipNamespaces() *RelationshipNamespaces`
|
||||
|
||||
NewRelationshipNamespaces instantiates a new RelationshipNamespaces object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewRelationshipNamespacesWithDefaults
|
||||
|
||||
`func NewRelationshipNamespacesWithDefaults() *RelationshipNamespaces`
|
||||
|
||||
NewRelationshipNamespacesWithDefaults instantiates a new RelationshipNamespaces object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespaces
|
||||
|
||||
`func (o *RelationshipNamespaces) GetNamespaces() []Namespace`
|
||||
|
||||
GetNamespaces returns the Namespaces field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespacesOk
|
||||
|
||||
`func (o *RelationshipNamespaces) GetNamespacesOk() (*[]Namespace, bool)`
|
||||
|
||||
GetNamespacesOk returns a tuple with the Namespaces field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespaces
|
||||
|
||||
`func (o *RelationshipNamespaces) SetNamespaces(v []Namespace)`
|
||||
|
||||
SetNamespaces sets Namespaces field to given value.
|
||||
|
||||
### HasNamespaces
|
||||
|
||||
`func (o *RelationshipNamespaces) HasNamespaces() bool`
|
||||
|
||||
HasNamespaces returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
82
internal/httpclient/docs/RelationshipPatch.md
generated
Normal file
82
internal/httpclient/docs/RelationshipPatch.md
generated
Normal file
@@ -0,0 +1,82 @@
|
||||
# RelationshipPatch
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Action** | Pointer to **string** | | [optional]
|
||||
**RelationTuple** | Pointer to [**Relationship**](Relationship.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewRelationshipPatch
|
||||
|
||||
`func NewRelationshipPatch() *RelationshipPatch`
|
||||
|
||||
NewRelationshipPatch instantiates a new RelationshipPatch object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewRelationshipPatchWithDefaults
|
||||
|
||||
`func NewRelationshipPatchWithDefaults() *RelationshipPatch`
|
||||
|
||||
NewRelationshipPatchWithDefaults instantiates a new RelationshipPatch object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetAction
|
||||
|
||||
`func (o *RelationshipPatch) GetAction() string`
|
||||
|
||||
GetAction returns the Action field if non-nil, zero value otherwise.
|
||||
|
||||
### GetActionOk
|
||||
|
||||
`func (o *RelationshipPatch) GetActionOk() (*string, bool)`
|
||||
|
||||
GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetAction
|
||||
|
||||
`func (o *RelationshipPatch) SetAction(v string)`
|
||||
|
||||
SetAction sets Action field to given value.
|
||||
|
||||
### HasAction
|
||||
|
||||
`func (o *RelationshipPatch) HasAction() bool`
|
||||
|
||||
HasAction returns a boolean if a field has been set.
|
||||
|
||||
### GetRelationTuple
|
||||
|
||||
`func (o *RelationshipPatch) GetRelationTuple() Relationship`
|
||||
|
||||
GetRelationTuple returns the RelationTuple field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationTupleOk
|
||||
|
||||
`func (o *RelationshipPatch) GetRelationTupleOk() (*Relationship, bool)`
|
||||
|
||||
GetRelationTupleOk returns a tuple with the RelationTuple field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelationTuple
|
||||
|
||||
`func (o *RelationshipPatch) SetRelationTuple(v Relationship)`
|
||||
|
||||
SetRelationTuple sets RelationTuple field to given value.
|
||||
|
||||
### HasRelationTuple
|
||||
|
||||
`func (o *RelationshipPatch) HasRelationTuple() bool`
|
||||
|
||||
HasRelationTuple returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
82
internal/httpclient/docs/Relationships.md
generated
Normal file
82
internal/httpclient/docs/Relationships.md
generated
Normal file
@@ -0,0 +1,82 @@
|
||||
# Relationships
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**NextPageToken** | Pointer to **string** | The opaque token to provide in a subsequent request to get the next page. It is the empty string iff this is the last page. | [optional]
|
||||
**RelationTuples** | Pointer to [**[]Relationship**](Relationship.md) | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewRelationships
|
||||
|
||||
`func NewRelationships() *Relationships`
|
||||
|
||||
NewRelationships instantiates a new Relationships object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewRelationshipsWithDefaults
|
||||
|
||||
`func NewRelationshipsWithDefaults() *Relationships`
|
||||
|
||||
NewRelationshipsWithDefaults instantiates a new Relationships object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNextPageToken
|
||||
|
||||
`func (o *Relationships) GetNextPageToken() string`
|
||||
|
||||
GetNextPageToken returns the NextPageToken field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNextPageTokenOk
|
||||
|
||||
`func (o *Relationships) GetNextPageTokenOk() (*string, bool)`
|
||||
|
||||
GetNextPageTokenOk returns a tuple with the NextPageToken field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNextPageToken
|
||||
|
||||
`func (o *Relationships) SetNextPageToken(v string)`
|
||||
|
||||
SetNextPageToken sets NextPageToken field to given value.
|
||||
|
||||
### HasNextPageToken
|
||||
|
||||
`func (o *Relationships) HasNextPageToken() bool`
|
||||
|
||||
HasNextPageToken returns a boolean if a field has been set.
|
||||
|
||||
### GetRelationTuples
|
||||
|
||||
`func (o *Relationships) GetRelationTuples() []Relationship`
|
||||
|
||||
GetRelationTuples returns the RelationTuples field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationTuplesOk
|
||||
|
||||
`func (o *Relationships) GetRelationTuplesOk() (*[]Relationship, bool)`
|
||||
|
||||
GetRelationTuplesOk returns a tuple with the RelationTuples field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelationTuples
|
||||
|
||||
`func (o *Relationships) SetRelationTuples(v []Relationship)`
|
||||
|
||||
SetRelationTuples sets RelationTuples field to given value.
|
||||
|
||||
### HasRelationTuples
|
||||
|
||||
`func (o *Relationships) HasRelationTuples() bool`
|
||||
|
||||
HasRelationTuples returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
82
internal/httpclient/docs/SourcePosition.md
generated
Normal file
82
internal/httpclient/docs/SourcePosition.md
generated
Normal file
@@ -0,0 +1,82 @@
|
||||
# SourcePosition
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Line** | Pointer to **int64** | | [optional]
|
||||
**Column** | Pointer to **int64** | | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewSourcePosition
|
||||
|
||||
`func NewSourcePosition() *SourcePosition`
|
||||
|
||||
NewSourcePosition instantiates a new SourcePosition object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewSourcePositionWithDefaults
|
||||
|
||||
`func NewSourcePositionWithDefaults() *SourcePosition`
|
||||
|
||||
NewSourcePositionWithDefaults instantiates a new SourcePosition object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetLine
|
||||
|
||||
`func (o *SourcePosition) GetLine() int64`
|
||||
|
||||
GetLine returns the Line field if non-nil, zero value otherwise.
|
||||
|
||||
### GetLineOk
|
||||
|
||||
`func (o *SourcePosition) GetLineOk() (*int64, bool)`
|
||||
|
||||
GetLineOk returns a tuple with the Line field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetLine
|
||||
|
||||
`func (o *SourcePosition) SetLine(v int64)`
|
||||
|
||||
SetLine sets Line field to given value.
|
||||
|
||||
### HasLine
|
||||
|
||||
`func (o *SourcePosition) HasLine() bool`
|
||||
|
||||
HasLine returns a boolean if a field has been set.
|
||||
|
||||
### GetColumn
|
||||
|
||||
`func (o *SourcePosition) GetColumn() int64`
|
||||
|
||||
GetColumn returns the Column field if non-nil, zero value otherwise.
|
||||
|
||||
### GetColumnOk
|
||||
|
||||
`func (o *SourcePosition) GetColumnOk() (*int64, bool)`
|
||||
|
||||
GetColumnOk returns a tuple with the Column field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetColumn
|
||||
|
||||
`func (o *SourcePosition) SetColumn(v int64)`
|
||||
|
||||
SetColumn sets Column field to given value.
|
||||
|
||||
### HasColumn
|
||||
|
||||
`func (o *SourcePosition) HasColumn() bool`
|
||||
|
||||
HasColumn returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
93
internal/httpclient/docs/SubjectSet.md
generated
Normal file
93
internal/httpclient/docs/SubjectSet.md
generated
Normal file
@@ -0,0 +1,93 @@
|
||||
# SubjectSet
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Namespace** | **string** | Namespace of the Subject Set |
|
||||
**Object** | **string** | Object of the Subject Set |
|
||||
**Relation** | **string** | Relation of the Subject Set |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewSubjectSet
|
||||
|
||||
`func NewSubjectSet(namespace string, object string, relation string, ) *SubjectSet`
|
||||
|
||||
NewSubjectSet instantiates a new SubjectSet object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewSubjectSetWithDefaults
|
||||
|
||||
`func NewSubjectSetWithDefaults() *SubjectSet`
|
||||
|
||||
NewSubjectSetWithDefaults instantiates a new SubjectSet object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetNamespace
|
||||
|
||||
`func (o *SubjectSet) GetNamespace() string`
|
||||
|
||||
GetNamespace returns the Namespace field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNamespaceOk
|
||||
|
||||
`func (o *SubjectSet) GetNamespaceOk() (*string, bool)`
|
||||
|
||||
GetNamespaceOk returns a tuple with the Namespace field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetNamespace
|
||||
|
||||
`func (o *SubjectSet) SetNamespace(v string)`
|
||||
|
||||
SetNamespace sets Namespace field to given value.
|
||||
|
||||
|
||||
### GetObject
|
||||
|
||||
`func (o *SubjectSet) GetObject() string`
|
||||
|
||||
GetObject returns the Object field if non-nil, zero value otherwise.
|
||||
|
||||
### GetObjectOk
|
||||
|
||||
`func (o *SubjectSet) GetObjectOk() (*string, bool)`
|
||||
|
||||
GetObjectOk returns a tuple with the Object field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetObject
|
||||
|
||||
`func (o *SubjectSet) SetObject(v string)`
|
||||
|
||||
SetObject sets Object field to given value.
|
||||
|
||||
|
||||
### GetRelation
|
||||
|
||||
`func (o *SubjectSet) GetRelation() string`
|
||||
|
||||
GetRelation returns the Relation field if non-nil, zero value otherwise.
|
||||
|
||||
### GetRelationOk
|
||||
|
||||
`func (o *SubjectSet) GetRelationOk() (*string, bool)`
|
||||
|
||||
GetRelationOk returns a tuple with the Relation field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetRelation
|
||||
|
||||
`func (o *SubjectSet) SetRelation(v string)`
|
||||
|
||||
SetRelation sets Relation field to given value.
|
||||
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
56
internal/httpclient/docs/Version.md
generated
Normal file
56
internal/httpclient/docs/Version.md
generated
Normal file
@@ -0,0 +1,56 @@
|
||||
# Version
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Version** | Pointer to **string** | Version is the service's version. | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewVersion
|
||||
|
||||
`func NewVersion() *Version`
|
||||
|
||||
NewVersion instantiates a new Version object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewVersionWithDefaults
|
||||
|
||||
`func NewVersionWithDefaults() *Version`
|
||||
|
||||
NewVersionWithDefaults instantiates a new Version object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetVersion
|
||||
|
||||
`func (o *Version) GetVersion() string`
|
||||
|
||||
GetVersion returns the Version field if non-nil, zero value otherwise.
|
||||
|
||||
### GetVersionOk
|
||||
|
||||
`func (o *Version) GetVersionOk() (*string, bool)`
|
||||
|
||||
GetVersionOk returns a tuple with the Version field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetVersion
|
||||
|
||||
`func (o *Version) SetVersion(v string)`
|
||||
|
||||
SetVersion sets Version field to given value.
|
||||
|
||||
### HasVersion
|
||||
|
||||
`func (o *Version) HasVersion() bool`
|
||||
|
||||
HasVersion returns a boolean if a field has been set.
|
||||
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user