feat(30125): split openAPI specs (automatic split/bundling - redocly)

ext/openAPI/components/headers/ETag.yaml

@@ -0,0 +1,3 @@
+description: Identifier for a specific version of a resource
+schema:
+  type: string

ext/openAPI/components/schemas/Adapter.yaml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  config:
+    $ref: ./JsonNode.yaml
+  id:
+    type: string
+    format: string
+    description: >-
+      The adapter id, must be unique and only contain alpha numeric characters
+      with spaces and hyphens.
+    maxLength: 500
+    minLength: 1
+    pattern: ^([a-zA-Z_0-9-_])*$
+  status:
+    $ref: ./Status.yaml
+  type:
+    type: string
+    description: The adapter type associated with this instance
+required:
+  - id

ext/openAPI/components/schemas/AdapterConfig.yaml

@@ -0,0 +1,19 @@
+type: object
+properties:
+  config:
+    $ref: ./Adapter.yaml
+  northboundMappings:
+    type: array
+    description: The northbound mappings for this adapter
+    items:
+      $ref: ./NorthboundMapping.yaml
+  southboundMappings:
+    type: array
+    description: The southbound mappings for this adapter
+    items:
+      $ref: ./SouthboundMapping.yaml
+  tags:
+    type: array
+    description: The tags defined for this adapter
+    items:
+      $ref: ./DomainTag.yaml

ext/openAPI/components/schemas/AdaptersList.yaml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  items:
+    type: array
+    description: List of result items that are returned by this endpoint
+    items:
+      $ref: ./Adapter.yaml
+required:
+  - items

ext/openAPI/components/schemas/ApiBearerToken.yaml

@@ -0,0 +1,5 @@
+type: object
+properties:
+  token:
+    type: string
+    description: The token associated a set of authenticated credentials

ext/openAPI/components/schemas/BehaviorPolicy.yaml

@@ -0,0 +1,34 @@
+type: object
+description: >-
+  A policy which is used to validate and execute certain actions based on the
+  validation result.
+properties:
+  behavior:
+    $ref: ./BehaviorPolicyBehavior.yaml
+  createdAt:
+    type: string
+    format: date-time
+    description: The formatted UTC timestamp indicating when the policy was created.
+    readOnly: true
+  deserialization:
+    $ref: ./BehaviorPolicyDeserialization.yaml
+  id:
+    type: string
+    description: The unique identifier of the policy.
+  lastUpdatedAt:
+    type: string
+    format: date-time
+    description: >-
+      The formatted UTC timestamp indicating when the policy was updated the
+      last time.
+    readOnly: true
+  matching:
+    $ref: ./BehaviorPolicyMatching.yaml
+  onTransitions:
+    type: array
+    items:
+      $ref: ./BehaviorPolicyOnTransition.yaml
+required:
+  - behavior
+  - id
+  - matching

ext/openAPI/components/schemas/BehaviorPolicyBehavior.yaml

@@ -0,0 +1,11 @@
+type: object
+description: The behavior referenced by the policy, that is validated by the policy.
+properties:
+  arguments:
+    type: object
+    description: The  arguments that the referenced validator type requires.
+  id:
+    type: string
+    description: The unique identifier of a pre-defined behavior.
+required:
+  - id

ext/openAPI/components/schemas/BehaviorPolicyDeserialization.yaml

@@ -0,0 +1,9 @@
+type: object
+description: >-
+  The deserializers used by the policy for particular message and/or payload
+  types.
+properties:
+  publish:
+    $ref: ./BehaviorPolicyDeserializer.yaml
+  will:
+    $ref: ./BehaviorPolicyDeserializer.yaml

ext/openAPI/components/schemas/BehaviorPolicyDeserializer.yaml

@@ -0,0 +1,7 @@
+type: object
+description: The deserializer applied to a particular message or payload type.
+properties:
+  schema:
+    $ref: ./SchemaReference.yaml
+required:
+  - schema

ext/openAPI/components/schemas/BehaviorPolicyList.yaml

@@ -0,0 +1,10 @@
+type: object
+description: A listing of behavior policies.
+properties:
+  _links:
+    $ref: ./PaginationCursor.yaml
+  items:
+    type: array
+    description: List of result items that are returned by this endpoint
+    items:
+      $ref: ./BehaviorPolicy.yaml

ext/openAPI/components/schemas/BehaviorPolicyMatching.yaml

@@ -0,0 +1,8 @@
+type: object
+description: The matching rules the policy applies.
+properties:
+  clientIdRegex:
+    type: string
+    description: The regex pattern to match the client id against.
+required:
+  - clientIdRegex

ext/openAPI/components/schemas/BehaviorPolicyOnEvent.yaml

@@ -0,0 +1,11 @@
+type: object
+description: >-
+  One or more operations that are triggered on the event. When this field is
+  empty, the transition does not trigger any operations.
+properties:
+  pipeline:
+    type: array
+    items:
+      $ref: ./PolicyOperation.yaml
+required:
+  - pipeline

ext/openAPI/components/schemas/BehaviorPolicyOnTransition.yaml

@@ -0,0 +1,28 @@
+type: object
+description: The actions that are executed for the specified transition.
+properties:
+  Connection.OnDisconnect:
+    $ref: ./BehaviorPolicyOnEvent.yaml
+  Event.OnAny:
+    $ref: ./BehaviorPolicyOnEvent.yaml
+  Mqtt.OnInboundConnect:
+    $ref: ./BehaviorPolicyOnEvent.yaml
+  Mqtt.OnInboundDisconnect:
+    $ref: ./BehaviorPolicyOnEvent.yaml
+  Mqtt.OnInboundPublish:
+    $ref: ./BehaviorPolicyOnEvent.yaml
+  Mqtt.OnInboundSubscribe:
+    $ref: ./BehaviorPolicyOnEvent.yaml
+  fromState:
+    type: string
+    description: >-
+      The exact state from which the transition happened. Alternatively a state
+      filter can be used.
+  toState:
+    type: string
+    description: >-
+      The exact state to which the transition happened. Alternatively a state
+      filter can be used.
+required:
+  - fromState
+  - toState

ext/openAPI/components/schemas/Bridge.yaml

@@ -0,0 +1,103 @@
+type: object
+properties:
+  cleanStart:
+    type: boolean
+    format: boolean
+    default: true
+    description: The cleanStart value associated the the MQTT connection.
+  clientId:
+    type: string
+    format: string
+    description: The client identifier associated the the MQTT connection.
+    example: my-example-client-id
+    maxLength: 65535
+    nullable: true
+  host:
+    type: string
+    description: >-
+      The host the bridge connects to - a well formed hostname, ipv4 or ipv6
+      value.
+    maxLength: 255
+  id:
+    type: string
+    format: string
+    description: >-
+      The bridge id, must be unique and only contain alpha numeric characters
+      with spaces and hyphens.
+    maxLength: 500
+    minLength: 1
+    pattern: ^([a-zA-Z_0-9-_])*$
+  keepAlive:
+    type: integer
+    format: int32
+    default: 240
+    description: The keepAlive associated the the MQTT connection.
+    maximum: 65535
+    minimum: 0
+  localSubscriptions:
+    type: array
+    description: localSubscriptions associated with the bridge
+    items:
+      $ref: ./LocalBridgeSubscription.yaml
+  loopPreventionEnabled:
+    type: boolean
+    format: boolean
+    default: true
+    description: Is loop prevention enabled on the connection
+  loopPreventionHopCount:
+    type: integer
+    format: int32
+    default: 1
+    description: Loop prevention hop count
+    maximum: 100
+    minimum: 0
+  password:
+    type: string
+    format: string
+    description: The password value associated the the MQTT connection.
+    maxLength: 65535
+    nullable: true
+  persist:
+    type: boolean
+    description: >-
+      If this flag is set to true, any outgoing mqtt messages with QoS-1 or
+      QoS-2 will be persisted on disc in case disc persistence is active.If this
+      flag is set to false, the QoS of any outgoing mqtt messages will be set to
+      QoS-0 and no traffic will be persisted on disc.
+    nullable: true
+  port:
+    type: integer
+    format: int32
+    description: The port number to connect to
+    maximum: 65535
+    minimum: 1
+  remoteSubscriptions:
+    type: array
+    description: remoteSubscriptions associated with the bridge
+    items:
+      $ref: ./BridgeSubscription.yaml
+  sessionExpiry:
+    type: integer
+    format: int64
+    default: 3600
+    description: The sessionExpiry associated the the MQTT connection.
+    minimum: 0
+  status:
+    $ref: ./Status.yaml
+  tlsConfiguration:
+    $ref: ./TlsConfiguration.yaml
+  username:
+    type: string
+    format: string
+    description: The username value associated the the MQTT connection.
+    maxLength: 65535
+    nullable: true
+  websocketConfiguration:
+    $ref: ./WebsocketConfiguration.yaml
+required:
+  - cleanStart
+  - host
+  - id
+  - keepAlive
+  - port
+  - sessionExpiry

ext/openAPI/components/schemas/BridgeCustomUserProperty.yaml

@@ -0,0 +1,14 @@
+type: object
+description: The customUserProperties for this subscription
+properties:
+  key:
+    type: string
+    format: string
+    description: The key the from the property
+  value:
+    type: string
+    format: string
+    description: The value the from the property
+required:
+  - key
+  - value

ext/openAPI/components/schemas/BridgeList.yaml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  items:
+    type: array
+    description: List of result items that are returned by this endpoint
+    items:
+      $ref: ./Bridge.yaml
+required:
+  - items

ext/openAPI/components/schemas/BridgeSubscription.yaml

@@ -0,0 +1,38 @@
+type: object
+description: remoteSubscriptions associated with the bridge
+properties:
+  customUserProperties:
+    type: array
+    description: The customUserProperties for this subscription
+    items:
+      $ref: ./BridgeCustomUserProperty.yaml
+  destination:
+    type: string
+    description: The destination topic for this filter set.
+    example: some/topic/value
+  filters:
+    type: array
+    description: The filters for this subscription.
+    example: some/topic/value
+    items:
+      type: string
+      description: The filters for this subscription.
+      example: some/topic/value
+  maxQoS:
+    type: integer
+    format: int32
+    default: 0
+    description: The maxQoS for this subscription.
+    enum:
+      - 0
+      - 1
+      - 2
+    maximum: 2
+    minimum: 0
+  preserveRetain:
+    type: boolean
+    description: The preserveRetain for this subscription
+required:
+  - destination
+  - filters
+  - maxQoS

ext/openAPI/components/schemas/Capability.yaml

@@ -0,0 +1,18 @@
+type: object
+description: List of result items that are returned by this endpoint
+properties:
+  description:
+    type: string
+    description: A description for the capability
+  displayName:
+    type: string
+    description: A human readable name, intended to be used to display at front end.
+  id:
+    type: string
+    enum:
+      - config-writeable
+      - bi-directional protocol adapters
+      - control-plane-connectivity
+      - data-hub
+      - mqtt-persistence
+    description: The identifier of this capability

ext/openAPI/components/schemas/CapabilityList.yaml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  items:
+    type: array
+    description: List of result items that are returned by this endpoint
+    items:
+      $ref: ./Capability.yaml
+required:
+  - items

ext/openAPI/components/schemas/DataPoint.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  sampleTime:
+    type: string
+    format: date-time
+    description: Time the data-point was generated
+    nullable: true
+  value:
+    type: integer
+    format: int64
+    description: The value of the data point