Skip to content

Establish deprecation policy for architectural APIs #1794

Closed
@anvabr

Description

@anvabr

Problem description

There are a number of architectural APIs in the Guardian that have been designed to enable users to easily 'plug-in' their own components. Notable example is wallets API, which is used to enable integration with key management Vaults. These need to align with the rest of the Guardian APIs in terms of clarity of the rules for changing/maintaining backward compatibility. Otherwise users can be faced with random breaking change upon upgrade, which would render their system inoperable.

Requirements

  • Identify and enumerate all architectural APIs significant to end users
  • Extend API deprecation policy coverage to include the above APIs

Definition of done

Policy describes the rules for deprecation/removal of the functionality from the API

Acceptance criteria

See DOD above

Metadata

Metadata

Assignees

Labels

EpicNext PhaseWill be worked in Next Phase

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions