Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Data Movement as a Platform APIsDMaaP message sub/pub related APIs which will be used by Holmes to collect the data from and publish data to DMaaP topics.

Data Movement as a Platform Message Router 

DMaaP Message Router API

Resource QueryQuery different resource information from A&AI. All A&AI operations are implemented in the form of RESTful APIs. I'm using "Resource Query" as a general name for the APIs in case there will be too many APIs listed here.

AAI API
Event Sending API provided by PolicySend an event (or other legal data) to the Policy engine.

Policy API

Control Loop Operational Policy

CLAMP APIsAPIs used to interact with CLAMP (rule deployment, transferring execution results, etc.)

<<DocRef: CLAMP API Documents>>
DCAE APIsAPIs used for service registration and discovery.

<<DocRef:DCAE API Documents>>

API Outgoing Dependencies

API this release is delivering to other releases.

API NameAPI DescriptionAPI Definition DateAPI Delivery dateAPI Definition link (i.e.swagger)
Rule CreatingThis API is intended for creating a rule in the database.

 

August, 24th, 2017Rule Management
Rule ModifyingThis API is intended for modifying a rule in the database.

 

August, 24th, 2017Rule Management
Rule DeletingThis API is intended for deleting a rule from the database.

 

August, 24th, 2017Rule Management
Rule QueryThis API is intended for querying rules from the database.

 

August, 24th, 2017Rule Management
Rule DeployingThis API is intended for deploying the rule(s) into the rule engine.

 

August, 24th, 2017Engine Management
Rule Deleting from the Rule EngineThis API is intended for removing the rule(s) from the rule engine.

 

August, 24th, 2017Engine Management
Rule VerifyingThis API is intended for verifying a rule.

 

August, 24th, 2017Engine Management
Health-checkThis API is used by other components to check whether Holmes is working.TBDAugust, 24th, 2017TBD
Statistic Data QueryThis API is used by the client projects to query statistics data provided by Holmes.TBDAugust, 24th, 2017TBD

Third Party Products Dependencies

...