Categorygithub.com/kiprotect/kodexapi

package

0.1.14

Repository: https://github.com/kiprotect/kodex.git

Documentation: pkg.go.dev

# README

KIProtect - KIProtect API

KIProtect provides an API to the KIProtect tool, allowing users to transform data via a RESTful API.

Building

To build the API, run the following commands in the parent directory:

make
make install

Running the tests

Run the following in the parent directory:

make test-api

Running the API command

First, define the KODEX_SETTINGS environment variable. Then, run

kodex api run

# Packages

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

# Functions

No description provided by the author

ApplyChangesWithObject

Applies a sequence of changes to an object.

No description provided by the author

No description provided by the author

Returns the difference between two data structures as a sequence of changes.

DiffWithOptions

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

MakeAccessToken

No description provided by the author

No description provided by the author

MakeOrganizationRoles

No description provided by the author

No description provided by the author

MakeUserOrganization

No description provided by the author

MergeDefinitions

No description provided by the author

No description provided by the author

# Constants

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

PublishedComment

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

RequestApproved

No description provided by the author

RequestRejected

No description provided by the author

ReviewRequested

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

# Variables

AccessTokenForm

No description provided by the author

BlueprintConfigForm

No description provided by the author

BlueprintUserForm

No description provided by the author

BPObjectRoleForm

No description provided by the author

BPOrganizationForm

No description provided by the author

ChangeRequestForm

No description provided by the author

ChangeRequestReviewForm

No description provided by the author

No description provided by the author

DefaultObjectRoleForm

No description provided by the author

No description provided by the author

OrganizationForm

No description provided by the author

No description provided by the author

No description provided by the author

# Structs

No description provided by the author

BaseChangeRequest

No description provided by the author

BaseChangeRequestReview

No description provided by the author

No description provided by the author

No description provided by the author

BaseDefaultObjectRole

BaseDefaultObjectRole contains useful common functionality that should be shared by all implementations of the interface, such as validation.

BaseObjectRole contains useful common functionality that should be shared by all implementations of the interface, such as validation.

BaseOrganization

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

IsChangeRequestReviewStatus

No description provided by the author

IsChangeRequestStatus

No description provided by the author

IsCommentStatus

No description provided by the author

No description provided by the author

OrganizationRoles

No description provided by the author

No description provided by the author

No description provided by the author

UserOrganization

No description provided by the author

UserProviderDefinition

No description provided by the author

UserProviderSettings

No description provided by the author

# Interfaces

No description provided by the author

AssociateAdaptor

No description provided by the author

No description provided by the author

ChangeRequestReview

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

CreateObjectAdaptor

No description provided by the author

CreateUserProvider

No description provided by the author

DefaultObjectRole

No description provided by the author

ListAllObjectAdaptor

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

UpdateObjectAdaptor

No description provided by the author

No description provided by the author

No description provided by the author

UserProviderPlugin

No description provided by the author

# Type aliases

APIControllerDefinitions

No description provided by the author

APIControllerMaker

No description provided by the author

ChangeRequestReviewStatus

No description provided by the author

ChangeRequestStatus

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

No description provided by the author

SettingsValidator

No description provided by the author

UserProviderDefinitions

No description provided by the author

UserProviderMaker

No description provided by the author