API docs by Redocly

Kafka message dispatcher for A1 interface (0.0.1)

Download OpenAPI specification:Download

License: Copyright (C) 2022 Nordix Foundation. Licensed under the Apache License.

Kafka message dispatcher server.

RestFUL APIs that create and dispatch Kafka messages to Kafka brokers

The mapping from policy type to kafka topic request and response object

dispatcher.get_policy_type_to_topic_mapping

Get the kafka request and response topic map corresponding to policy type

path Parameters
policyTypeId
required
string (PolicyTypeId)

Policy type identifier assigned by the A1-P Provider

Responses

Response samples

Content type
application/json
{
  • "policy_type": {
    }
}

Individual policy Object

dispatcher.put_policy

Dispatch create and update operation as kafka message to kafka cluster

path Parameters
policyTypeId
required
string (PolicyTypeId)

Policy type identifier assigned by the A1-P Provider

policyId
required
string (A1PolicyId)

A1 policy identifier.

Request Body schema: application/json
object (A1PolicyObject)

A generic policy object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

dispatcher.delete_policy

Dispatch policy delete opertion as kafka message to kafka cluster

path Parameters
policyTypeId
required
string (PolicyTypeId)

Policy type identifier assigned by the A1-P Provider

policyId
required
string (A1PolicyId)

A1 policy identifier.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}

Individual A1 Policy Status Object

dispatcher.get_policy_status

Dispatch policy status query opertion as kafka message to kafka cluster

path Parameters
policyTypeId
required
string (PolicyTypeId)

Policy type identifier assigned by the A1-P Provider

policyId
required
string (A1PolicyId)

A1 policy identifier.

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string"
}