Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.36 KB

extension.md

File metadata and controls

52 lines (30 loc) · 1.36 KB

Title of the Extension

Briefly describe the functionality this extension introduces.

Background

Briefly describe the relevance and need of this extension.

Scope

Describe what this extension should be used for, e.g., for what kind of data transfers or data sharing scenarios.

Use Cases

Explain one or multiple use cases that could be realized using this extension.

Technical Details

Interfaces

Provide a detailed description of provided and consumed interfaces, e.g., name http endpoints and values, or classes/methods and parameter, and add details on the purpose. You may use the table below or add an OpenAPI description or similar.

Interface Parameters Description

Dependencies

Provide some information about dependencies, e.g., used extensions.

Name Description
extensions:api:management-api this is an example

Configurations

If available, describe what configuration properties this extension comes with or expects as a prerequisite.

Terminology

If necessary, introduce important terms and concepts.

Design Principles

If available, clearly describe what design principles your implementation follows.

Decisions

Clearly describe any decisions you made regarding architectural design or similar, and try to justify them.