API Stability

• Piksel Developer
• Concepts
• API
• Stability

Piksel API endpoints provide a contract on their stability as outlined by the following states:

Experimental

This feature was introduced recently, and may change or be removed in future versions. Please try it out and provide feedback. If it addresses a use-case that is important to you, tell the core team.

Unstable

The API is in the process of settling, but has not yet had sufficient real-world testing to be considered stable. Backwards-compatibility will be maintained if reasonable.

Stable

The API has proven satisfactory. Backwards-compatibility is guaranteed.

Deprecated

This feature is known to be problematic, and changes are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should not be expected.