High Level Architecture - Module
Name of the High Level Architecture Module this repository refers to. Pick one of the names listed in the Confluence page HLA - modules description.
Summary
Brief description of the functionalities provided by this piece of software in the context of the Smart Component.
Available interfaces
Keep the available interface types among the following list:
- Command-Line Interface (CLI)
- Graphical-User Interface (GUI)
- GraphQL API (use OpenAPI 3.0.2 specification)
- Message/Event-Based API (use AsyncAPI 1.2.0 specification)
- REST API (use OpenAPI 3.0.2 specification)
- SOAP API (use WSDL 2.0 specification)
Link to the interface agreements
For each available interface, list the pair
type - agreement
where:
type
is one the values selected aboveagreement
is the URI to the local file or the Confluence page that describes the Interface Agreement of each available interfaceBelow you can find an example of the table to fill in.
Interface Type | Interface Agreement |
---|---|
Command-Line Interface (CLI) | path/to/repo/file |
REST API | https://sdp.finconsgroup.com/confluence/specs/my-project-api |