Design Decisions

Overview

Below are agreed upon decision choices regarding the usage of the API. Please note that certain decisions may be agreed upon before implementation. Whether or not a particular choice is implemented will be marked for each decision record.

Some decisions may also be a proposal and marked appropriately.

Warning

We area of the duplicate number. During the initial creation of these ADRs there was a misconfiguration of the doc build that prevented developers from being correctly aware of the various issues of mismatch.

Decisions

• Api Versioning
• Data Versioning (rejected, remains for historical context.)
• Catalogs and Search
• Versioning
• Authorization Middleware
• CDA Authorization Filtering
• Access Management Clients
• Timeseries CSV Format
• Handling Releases
• Vertical Datum Policy
• JMS Queue Message Structure
• Patch (Superseded by 0017)
• Vertical Datum Storage
• Catalogs
• CDA User Lists
• Data Event Message Formats - Forecasts
• Data Event Message Formats - Ratings
• Data Event Message Formats - Levels
• PATCH Handling Across CDA Endpoints
• Duplicate Time-Series Values
• Generated SDK Lifecycle
• Composite Time Series
• Data Event Message Formats - Streams
• Data Event Message Formats - Entities
• Data Event Message Formats - Embankments
• Data Event Message Formats - Overflows
• Data Event Message Formats - Locks
• Data Event Message Formats - Gates
• Data Event Message Formats - Turbines
• Data Event Message Formats - Pumps
• ADR Template