WISdoM OSS - Water Usage REST Adapter

Overview

This microservice is responsible for starting water usage forecasts. It is a part of the WISdoM OSS project. It uses the microservice template for the WISdoM OSS project.

Using the service

The service is included in every WISdoM OSS deployment by default and does not require the user to do anything.

A documentation for the API can be found in the openapi.yaml file in the repository.

Request Flow

The following diagram shows the request flow of the service.

sequenceDiagram
    actor U as User
    participant G as API Gateway
    participant S as Water Usage Forecast Adapter
    participant D as Database
    participant B as AMQP Message Broker
    participant C as Calculation Module

    U->>G: New Request
    activate G
    G->>G: Check authentication
    alt authentication failed
        note over U,G: Authentication may fail due to<br/>invalid credentials or missing<br/>headers
        G->>U: Error Response
    else authentication successful
        G->>S: Proxy request
        activate S
    end
    S-->S: Check authentication information for explicit group
    critical Validate incoming request 
        activate D
        S-->D: Query the supplied municipal keys
        S-->D: Query the supplied consumer groups
        deactivate D
    end
    activate B
    S-)B: Publish Request for Forecast
    B-->>S: Confirm Publish Event
    loop Wait for response 
        S->>B: Poll for response
    end
    B-)C: Deliver Message
    activate C
    C-->>B: Confirm delivery
    C->C: Calculate Forecast
    C-)B: Publish Result
    B-->>C: Confirm Publish Event
    deactivate C
    B-)S: Deliver Response
    S-->>B: Confirm delivery
    deactivate B
    S-->>G: Deliver response
    deactivate S
    G-->>U: Deliver response
    deactivate G

Loading

Development

Prerequisites

• Go 1.20

Important notices

• Since the service is usually deployed behind an API gateway which authenticates the user, the service does reject all requests which do not contain the X-Authenticated-Groups and X-Authenticated-User header.

  You need to set those headers manually when testing the service locally.