Fluximus - Private API v1 documentation

Fluximus - Private API v1

Fluximus Internal Use Only
application/json
Fluximus - Private API
[email protected]
ID: https://fluximus.dev/asyncapi.yaml

Download AsyncAPI Specification:

YAML - asyncapi.yaml
JSON - asyncapi.json

#channels

Servers

fluximus-message-service:9092kafkadevelopment
Dev Message Service using Kafka
Security:
API key
Developer Credentials

security.protocol:SASL_PLAINTEXT
sasl.mechanism:PLAIN

Operations

EVENT fluximus.events.channel.created
A new Channel was created.

Channel Created
Operation IDchannelCreated
Available only on servers:
- development
- #channels
Accepts the following message:
Channel CreatedchannelCreated
Channel Created
application/json
Message IDchannelCreated
Correlation ID$message.header#/traceId
Trace Id

Channel Created

object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "name": "string", "url": "http://example.com", "api": { "type": "bigcommerce", "endpointId": "string", "key": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.
EVENT fluximus.events.channel.updated
A Channel was updated.

Channel Updated
Operation IDchannelUpdated
Available only on servers:
- development
- #channels
Accepts the following message:
Channel UpdatedchannelUpdated
Channel Updated
application/json
Message IDchannelUpdated
Correlation ID$message.header#/traceId
Trace Id

Channel Updated

object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "name": "string", "url": "http://example.com", "api": { "type": "bigcommerce", "endpointId": "string", "key": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.
EVENT fluximus.events.channel.deleted
A Channel was deleted.

Channel Deleted
Operation IDchannelDeleted
Available only on servers:
- development
- #channels
Accepts the following message:
Channel DeletedchannelDeleted
Channel Deleted
application/json
Message IDchannelDeleted
Correlation ID$message.header#/traceId
Trace Id

Channel Deleted

object
channelId
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "channelId": "1234abcd-12ab-34cd-56ef-123456abcdef" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.
ACTION fluximus.actions.channel.create
Create a new Channel.

Create Channel
Operation IDcreateChannel
Available only on servers:
- development
- #channels
Accepts the following message:
Create ChannelcreateChannel
Create Channel
application/json
Message IDcreateChannel
Correlation ID$message.header#/traceId
Trace Id

Create Channel

object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "name": "string", "url": "http://example.com", "api": { "type": "bigcommerce", "endpointId": "string", "key": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.
ACTION fluximus.actions.channel.read
Read a Channel.

Read Channel
Operation IDreadChannel
Available only on servers:
- development
- #channels
Accepts the following message:
Read ChannelreadChannel
Read Channel
application/json
Message IDreadChannel
Correlation ID$message.header#/traceId
Trace Id

Read Channel

object
channelId
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "channelId": "1234abcd-12ab-34cd-56ef-123456abcdef" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.
ACTION fluximus.actions.channel.update
Update a Channel.

Update Channel
Operation IDupdateChannel
Available only on servers:
- development
- #channels
Accepts the following message:
Update ChannelupdateChannel
Update Channel
application/json
Message IDupdateChannel
Correlation ID$message.header#/traceId
Trace Id

Update Channel

object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "id": "1234abcd-12ab-34cd-56ef-123456abcdef", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "name": "string", "url": "http://example.com", "api": { "type": "bigcommerce", "endpointId": "string", "key": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.
ACTION fluximus.actions.channel.delete
Delete a Channel.

Delete Channel
Operation IDdeleteChannel
Available only on servers:
- development
- #channels
Accepts the following message:
Delete ChanneldeleteChannel
Delete Channel
application/json
Message IDdeleteChannel
Correlation ID$message.header#/traceId
Trace Id

Delete Channel

object
channelId
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
Examples
{ "channelId": "1234abcd-12ab-34cd-56ef-123456abcdef" }

This example has been generated automatically.
{ "traceId": "abcd1234abcd1234abcd1234abcd1234" }

This example has been generated automatically.

Messages

#1Channel CreatedchannelCreated
Channel Created
- application/json
Message IDchannelCreated
Correlation ID$message.header#/traceId
Trace Id

Channel Created
object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
#2Channel UpdatedchannelUpdated
Channel Updated
- application/json
Message IDchannelUpdated
Correlation ID$message.header#/traceId
Trace Id

Channel Updated
object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels
#3Channel DeletedchannelDeleted
Channel Deleted
- application/json
Message IDchannelDeleted
Correlation ID$message.header#/traceId
Trace Id

Channel Deleted

object
channelId
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

Additional properties are allowed.
object
traceId
required
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
#channels

Schemas

object
A Channel object

id
read-only
string
format: uuid
The Channel Id.

organizationId
required
string
format: uuid
The Organization this Channel belongs to.

name
required
string
A friendly name for the Channel.

url
string
format: uri
The Channel's public URL.

object
A Channel API object.

type
required
string
Supported Channel Types.

Allowed values:
"bigcommerce"
"shopify"
"unknown"
endpointId
required
string
The unique identifier for the API endpoint.

key
required
string
The API Key.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Channel was last modified.

Additional properties are allowed.
object
Count Object

count
required
read-only
integer
format: int64
The count

Additional properties are allowed.
object
A Feed object

id
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Feed was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Feed was last modified.

Additional properties are allowed.
Id
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.
object
An Organization object

id
required
read-only
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

name
required
string
Organization Name

ownerId
required
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Organization was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Organization was last modified.

Additional properties are allowed.
object
A Product object

id
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Product was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the Product was last modified.

Additional properties are allowed.
object
An HTTP Problem Details object, as defined in IETF RFC 7807

type
required
string
format: uri
A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provides human-readable documentation for the problem type.

title
required
string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

status
integer
format: int32[ 100 .. 599 ]
The HTTP status code generated by the origin server for this occurrence of the problem.

detail
string
A human-readable explanation specific to this occurrence of the problem.

instance
string
format: uri
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

traceId
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io

Additional properties are allowed.
TraceId
string
must match: ^[A-Fa-f0-9]{32}$32 characters
A 32-hex-character lowercase string. More information available at opentelemetry.io
object
A User object

id
string
format: uuid
A version 4 UUID (Universally Unique Identifier) as defined by RFC4122.

username
string
createdAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the User was created.

updatedAt
read-only
string
format: date-time
The date and time (ISO 8601 format) when the User was last modified.

Additional properties are allowed.

Download AsyncAPI Specification:

Servers

Security:

Operations

EVENT fluximus.events.channel.created

Examples

This example has been generated automatically.

This example has been generated automatically.

EVENT fluximus.events.channel.updated

Examples

This example has been generated automatically.

This example has been generated automatically.

EVENT fluximus.events.channel.deleted

Examples

This example has been generated automatically.

This example has been generated automatically.

ACTION fluximus.actions.channel.create

Examples

This example has been generated automatically.

This example has been generated automatically.

ACTION fluximus.actions.channel.read

Examples

This example has been generated automatically.

This example has been generated automatically.

ACTION fluximus.actions.channel.update

Examples

This example has been generated automatically.

This example has been generated automatically.

ACTION fluximus.actions.channel.delete

Examples

This example has been generated automatically.

This example has been generated automatically.

Messages

Schemas