Skip to content

Latest commit

 

History

History
8 lines (5 loc) · 707 Bytes

DEVEL.md

File metadata and controls

8 lines (5 loc) · 707 Bytes

API Development Guidelines

  • All interfaces in the 'api' module should contain the version in which they were introduced using a @since tag in the interface's Javadoc
  • Interfaces which are expected to be exposed in the OSGi registry by the API users should be annotated with the org.opennms.integration.api.v1.annotations.Exposable annotation
  • Interfaces which are expected to be consumed from the OSGi registry by the API users should be annotated with the org.opennms.integration.api.v1.annotations.Consumable annotation
  • Interfaces which have associated builder implementations in the common module should be annotated with the 'org.opennms.integration.api.v1.annotations.Model' annotation