Page MenuHomePhabricator

Define a stable API for scap plugins
Closed, DeclinedPublic

Description

Make scap plugins more useful and usable outside the core scap team by defining (mainly documenting) which scap APIs can be considered stable and safe to rely on from plugin code.

The main thing I had in mind here was to clearly differentiate the stable parts from the internal APIs which should be considered use-at-your-own-risk or possibly even private.

Event Timeline

I don't remember what "useful" meant.

I think it meant more docs and a set of APIs which are 'blessed' as stable and usable.

The main thing I had in mind here was to clearly differentiate the stable parts from the internal APIs which should be considered use-at-your-own-risk or possibly even private.

mmodell renamed this task from Make scap plugins generally useful to Define a stable API for scap plugins.Feb 28 2017, 2:47 AM
mmodell added a project: Documentation.
mmodell updated the task description. (Show Details)
mmodell moved this task from Experiments to Debt on the Scap board.
hashar added a subscriber: hashar.

After all those years:

  • we are migrating toward Helm/Kubernetes
  • repositories on scap most probably don't use scap plugins
  • mediawiki-config scap plugins got removed
  • scap doesn't have much features added nor any refactoring changes

So I don't think there is any need to define a stable API. It is defacto stable.