API Reference
Packages
formance.com/v1beta1
Package v1beta1 contains API Schema definitions for the formance v1beta1 API group
Resource Types
- Auth
- AuthClient
- Benthos
- BenthosStream
- BrokerTopic
- BrokerTopicConsumer
- Database
- Gateway
- GatewayHTTPAPI
- Ledger
- Orchestration
- Payments
- Reconciliation
- ResourceReference
- Search
- Settings
- Stack
- Stargate
- Versions
- Wallets
- Webhooks
Auth
Auth is the Schema for the auths API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Auth |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec AuthSpec |
AuthClient
AuthClient is the Schema for the authclients API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | AuthClient |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec AuthClientSpec |
AuthClientSpec
AuthClientSpec defines the desired state of AuthClient
Appears in:
Field | Description |
---|---|
stack string | |
id string | |
public boolean | |
description string | |
redirectUris string array | |
postLogoutRedirectUris string array | |
scopes string array | |
secret string |
AuthConfig
Appears in:
Field | Description |
---|---|
readKeySetMaxRetries integer | |
checkScopes boolean |
AuthSpec
AuthSpec defines the desired state of Auth
Appears in:
Field | Description |
---|---|
debug boolean | |
dev boolean | |
version string | |
stack string | |
delegatedOIDCServer DelegatedOIDCServerConfiguration | |
signingKey string | |
signingKeyFromSecret SecretKeySelector | |
enableScopes boolean |
Batching
Appears in:
Field | Description |
---|---|
count integer | |
period string |
Benthos
Benthos is the Schema for the benthos API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Benthos |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec BenthosSpec |
BenthosSpec
BenthosSpec defines the desired state of Benthos
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
resourceRequirements ResourceRequirements | |
batching Batching | |
initContainers Container array |
BenthosStream
BenthosStream is the Schema for the benthosstreams API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | BenthosStream |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec BenthosStreamSpec |
BenthosStreamSpec
BenthosStreamSpec defines the desired state of BenthosStream
Appears in:
Field | Description |
---|---|
stack string | |
data string | |
name string |
BrokerTopic
BrokerTopic is the Schema for the brokertopics API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | BrokerTopic |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec BrokerTopicSpec |
BrokerTopicConsumer
BrokerTopicConsumer is the Schema for the brokertopicconsumers API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | BrokerTopicConsumer |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec BrokerTopicConsumerSpec |
BrokerTopicConsumerSpec
BrokerTopicConsumerSpec defines the desired state of BrokerTopicConsumer
Appears in:
Field | Description |
---|---|
stack string | |
service string | |
queriedBy string |
BrokerTopicSpec
BrokerTopicSpec defines the desired state of BrokerTopic
Appears in:
Field | Description |
---|---|
stack string | |
service string |
CommonStatus
Appears in:
- AuthClientStatus
- AuthStatus
- BenthosStatus
- BenthosStreamStatus
- BrokerTopicConsumerStatus
- BrokerTopicStatus
- DatabaseStatus
- GatewayHTTPAPIStatus
- GatewayStatus
- LedgerStatus
- ModuleStatus
- OrchestrationStatus
- PaymentsStatus
- ReconciliationStatus
- ResourceReferenceStatus
- SearchStatus
- StackStatus
- StargateStatus
- StatusWithConditions
- WalletsStatus
- WebhooksStatus
Field | Description |
---|---|
ready boolean | |
info string |
Condition
Appears in:
- AuthStatus
- BenthosStatus
- GatewayStatus
- LedgerStatus
- ModuleStatus
- OrchestrationStatus
- PaymentsStatus
- ReconciliationStatus
- SearchStatus
- StargateStatus
- StatusWithConditions
- WalletsStatus
- WebhooksStatus
Field | Description |
---|---|
type string | type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) |
observedGeneration integer | observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. |
lastTransitionTime Time | lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. |
message string | message is a human readable message indicating details about the transition. This may be an empty string. |
reason string | reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. |
Database
Database is the Schema for the databases API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Database |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec DatabaseSpec |
DatabaseSpec
DatabaseSpec defines the desired state of Database
Appears in:
Field | Description |
---|---|
stack string | |
service string |
DelegatedOIDCServerConfiguration
Appears in:
Field | Description |
---|---|
issuer string | |
clientID string | |
clientSecret string |
DeploymentStrategy
Underlying type: string
Appears in:
DevProperties
Appears in:
- AuthSpec
- BenthosSpec
- GatewaySpec
- LedgerSpec
- ModuleProperties
- OrchestrationSpec
- PaymentsSpec
- ReconciliationSpec
- SearchSpec
- StackSpec
- StargateSpec
- WalletsSpec
- WebhooksSpec
Field | Description |
---|---|
debug boolean | |
dev boolean |
Gateway
Gateway is the Schema for the gateways API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Gateway |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec GatewaySpec |
GatewayHTTPAPI
GatewayHTTPAPI is the Schema for the HTTPAPIs API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | GatewayHTTPAPI |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec GatewayHTTPAPISpec |
GatewayHTTPAPIRule
Appears in:
Field | Description |
---|---|
path string | |
methods string array | |
secured boolean |
GatewayHTTPAPISpec
GatewayHTTPAPISpec defines the desired state of GatewayHTTPAPI
Appears in:
Field | Description |
---|---|
stack string | |
name string | Name indicates prefix api |
rules GatewayHTTPAPIRule array | Rules |
healthCheckEndpoint string | Health check endpoint |
GatewayIngress
Appears in:
Field | Description |
---|---|
host string | |
scheme string | |
annotations object (keys:string, values:string) | |
tls GatewayIngressTLS |
GatewayIngressTLS
Appears in:
Field | Description |
---|---|
secretName string |
GatewaySpec
GatewaySpec defines the desired state of Gateway
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
version string | |
ingress GatewayIngress |
Ledger
Ledger is the Schema for the ledgers API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Ledger |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec LedgerSpec |
LedgerSpec
LedgerSpec defines the desired state of Ledger
Appears in:
Field | Description |
---|---|
debug boolean | |
dev boolean | |
version string | |
stack string | |
auth AuthConfig | |
deploymentStrategy DeploymentStrategy | |
locking LockingStrategy | Locking is intended for ledger v1 only |
LockingStrategy
Appears in:
Field | Description |
---|---|
strategy string | |
redis LockingStrategyRedisConfig |
LockingStrategyRedisConfig
Appears in:
Field | Description |
---|---|
uri string | |
tls boolean | |
insecure boolean | |
duration Duration | |
retry Duration |
ModuleProperties
Appears in:
- AuthSpec
- GatewaySpec
- LedgerSpec
- OrchestrationSpec
- PaymentsSpec
- ReconciliationSpec
- SearchSpec
- StargateSpec
- WalletsSpec
- WebhooksSpec
Field | Description |
---|---|
debug boolean | |
dev boolean | |
version string |
ModuleStatus
Appears in:
- AuthStatus
- GatewayStatus
- LedgerStatus
- OrchestrationStatus
- PaymentsStatus
- ReconciliationStatus
- SearchStatus
- StargateStatus
- WalletsStatus
- WebhooksStatus
Field | Description |
---|---|
ready boolean | |
info string | |
conditions Condition array |
Orchestration
Orchestration is the Schema for the orchestrations API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Orchestration |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec OrchestrationSpec |
OrchestrationSpec
OrchestrationSpec defines the desired state of Orchestration
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
version string | |
auth AuthConfig |
Payments
Payments is the Schema for the payments API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Payments |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec PaymentsSpec |
PaymentsSpec
PaymentsSpec defines the desired state of Payments
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
version string | |
encryptionKey string | |
auth AuthConfig |
Reconciliation
Reconciliation is the Schema for the reconciliations API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Reconciliation |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec ReconciliationSpec |
ReconciliationSpec
ReconciliationSpec defines the desired state of Reconciliation
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
version string | |
auth AuthConfig |
ResourceReference
ResourceReference is the Schema for the resourcereferences API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | ResourceReference |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec ResourceReferenceSpec |
ResourceReferenceSpec
ResourceReferenceSpec defines the desired state of ResourceReference
Appears in:
Field | Description |
---|---|
stack string | |
gvk GroupVersionKind | |
name string |
Search
Search is the Schema for the searches API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Search |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec SearchSpec |
SearchSpec
SearchSpec defines the desired state of Search
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
version string | |
batching Batching | |
auth AuthConfig |
Settings
Settings is the Schema for the settings API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Settings |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec SettingsSpec |
SettingsSpec
SettingsSpec defines the desired state of Settings
Appears in:
Field | Description |
---|---|
stacks string array | |
key string | |
value string |
Stack
Stack is the Schema for the stacks API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Stack |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec StackSpec |
StackDependency
Appears in:
- AuthClientSpec
- AuthSpec
- BenthosSpec
- BenthosStreamSpec
- BrokerTopicConsumerSpec
- BrokerTopicSpec
- DatabaseSpec
- GatewayHTTPAPISpec
- GatewaySpec
- LedgerSpec
- OrchestrationSpec
- PaymentsSpec
- ReconciliationSpec
- ResourceReferenceSpec
- SearchSpec
- StargateSpec
- WalletsSpec
- WebhooksSpec
Field | Description |
---|---|
stack string |
StackSpec
StackSpec defines the desired state of Stack The version of the stack can be specified using either the field version
or the versionsFromFile
field. The version
field will have priority over versionFromFile
If versions
and versionsFromFile
are not specified, "latest" will be used.
Appears in:
Field | Description |
---|---|
debug boolean | |
dev boolean | |
version string | Version allow to specify the version of the components Must be a valid docker tag |
versionsFromFile string | VersionsFromFile allow to specify a formance.com/Versions object which contains individual versions for each component. Must reference a valid formance.com/Versions object |
enableAudit boolean | |
disabled boolean |
Stargate
Stargate is the Schema for the stargates API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Stargate |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec StargateSpec |
StargateAuthSpec
Appears in:
Field | Description |
---|---|
clientID string | |
clientSecret string | |
issuer string |
StargateSpec
StargateSpec defines the desired state of Stargate
Appears in:
Field | Description |
---|---|
debug boolean | |
dev boolean | |
version string | |
stack string | |
serverURL string | |
organizationID string | |
stackID string | |
auth StargateAuthSpec |
StatusWithConditions
Appears in:
- AuthStatus
- BenthosStatus
- GatewayStatus
- LedgerStatus
- ModuleStatus
- OrchestrationStatus
- PaymentsStatus
- ReconciliationStatus
- SearchStatus
- StargateStatus
- WalletsStatus
- WebhooksStatus
Field | Description |
---|---|
ready boolean | |
info string | |
conditions Condition array |
URI
Appears in:
Versions
Versions is the Schema for the versions API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Versions |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec object (keys:string, values:string) |
Wallets
Wallets is the Schema for the wallets API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Wallets |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec WalletsSpec |
WalletsSpec
WalletsSpec defines the desired state of Wallets
Appears in:
Field | Description |
---|---|
debug boolean | |
dev boolean | |
version string | |
stack string | |
auth AuthConfig |
Webhooks
Webhooks is the Schema for the webhooks API
Field | Description |
---|---|
apiVersion string | formance.com/v1beta1 |
kind string | Webhooks |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . |
spec WebhooksSpec |
WebhooksSpec
WebhooksSpec defines the desired state of Webhooks
Appears in:
Field | Description |
---|---|
stack string | |
debug boolean | |
dev boolean | |
version string | |
auth AuthConfig |