Api Gateway Microservice 1.0.0

The API Gateway Microservice of the Smart Operating Block project.

Features:

  • Manage the requests from clients
  • Receive and send automation scenario events
  • #automation scenarios

Servers

  • http://broker:29092kafkaproduction

    The event broker

    Security:
    security.protocol:PLAINTEXT
  • http://api-gateway-microservice:3001wssautomation-scenario

    The Api Gateway Web Socket for automation scenario proposals.

Operations

  • PUB automation-proposal-events

    The topic on which the automation scenario proposals are consumed.

    Consume automation scenario proposals.

    Operation IDgetAutomationScenarioProposals

    Accepts the following message:

    Medical Technology Automation Proposal eventmedicalTechnologyAutomationProposalEvent

    The event with which the microservice proposes an automation scenario to support the usage of a Medical Technology.

    Message IDmedicalTechnologyAutomationProposalEvent
    object
    uid: medicalTechnologyAutomationProposalEventSchema

    Examples

  • SUB automation-requests-events

    The topic on which the microservice send requests for automation scenarios already proposed or not.

    Request an automation scenario to the microservice.

    Operation IDrequestAutomationScenario

    Accepts one of the following messages:

    • #0Medical Technology Automation Request eventmedicalTechnologyAutomationRequestEvent

      The event needed to request an automation scenario to adapt the environment to a medical technology usage. It's not needed a beforehand proposal, but the medical technology must be in use.

      Message IDmedicalTechnologyAutomationRequestEvent
      object
      uid: medicalTechnologyAutomationRequestEventSchema

      Examples

    • #1Custom Light Request eventcustomLightRequest

      The event needed to request a custom setup for the lights inside an operating room.

      Message IDcustomLightRequest
      object
      uid: customLightRequestEventSchema

      Examples

    • #2Custom Light Stop eventcustomLightStop

      The event needed to stop the usage of the custom setup for the lights inside an operating room.

      Message IDcustomLightStop
      object
      uid: customLightStopEventSchema

      Examples

  • SUB web-socket-events

    The web socket channel in which the automation proposals are sent.

    Send automation scenario proposals to web socket channel.

    Operation IDsendAutomationProposal

    Accepts the following message:

    Automation Proposal Web Socket messagewebSocketMessage

    The automation proposal message sent to the websocket.

    Message IDwebSocketMessage
    object
    uid: medicalTechnologyAutomationProposalPayload

    Examples

Messages

  • #1Medical Technology Automation Proposal eventmedicalTechnologyAutomationProposalEvent

    The event with which the microservice proposes an automation scenario to support the usage of a Medical Technology.

    Message IDmedicalTechnologyAutomationProposalEvent
    object
    uid: medicalTechnologyAutomationProposalEventSchema
  • #2Medical Technology Automation Request eventmedicalTechnologyAutomationRequestEvent

    The event needed to request an automation scenario to adapt the environment to a medical technology usage. It's not needed a beforehand proposal, but the medical technology must be in use.

    Message IDmedicalTechnologyAutomationRequestEvent
    object
    uid: medicalTechnologyAutomationRequestEventSchema
  • #3Custom Light Request eventcustomLightRequest

    The event needed to request a custom setup for the lights inside an operating room.

    Message IDcustomLightRequest
    object
    uid: customLightRequestEventSchema
  • #4Custom Light Stop eventcustomLightStop

    The event needed to stop the usage of the custom setup for the lights inside an operating room.

    Message IDcustomLightStop
    object
    uid: customLightStopEventSchema
  • #5Automation Proposal Web Socket messagewebSocketMessage

    The automation proposal message sent to the websocket.

    Message IDwebSocketMessage
    object
    uid: medicalTechnologyAutomationProposalPayload

Schemas

  • object
    uid: medicalTechnologyAutomationProposalEventSchema
  • object
    uid: medicalTechnologyAutomationProposalPayload
  • object
    uid: medicalTechnologyAutomationRequestEventSchema
  • object
    uid: medicalTechnologyAutomationRequestPayload
  • object
    uid: customLightRequestEventSchema
  • object
    uid: customLightRequestPayload
  • object
    uid: customLightStopEventSchema
  • object
    uid: customLightStopPayload