Versions Compared

Key

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

Document status: 

Status
colourYellow
titleDRAFT

Contents


Table of Contents
maxLevel2

Context and objective

This document is a working draft for a recommendation of what a "1.0 Stable" version of a Symphony API Language Binding should cover. The goal is that new language bindings have a central document to orient themselves when starting the project, and that projects that are getting close to "1.0 Stable" release have a checklist they can use to finalize.

The primary focus is to allow users of such SDKs to be very clear on what to expect when starting to build on them. This would cover both functional and non-functional expectations.

Current projects recap

SDKProjectStatusProject owner
Java

V1.0.0 (SNAPSHOT)

.NET

0.4.0

Python


Clojure

0.1.0Peter Monks

PHP

Jira Legacy
serverJIRA (symphonyoss.atlassian.net)
serverId1a238f36-abc1-369b-9e20-eb8cf05423c5
keyCONTRIB-41


Florian de Miramon

Users expectations

As users of a "1.0" SDK, I would expect the following:

...

More precisely, this means:

Readiness checklist

  • Foundation contribution criteria
  • Functional coverage meets, at time of release
    • 0 Blockers on any functions
    • 0 Critical on any functions
    • 0 Major on any functions
    • Need to discuss specific criticality definition
  • Non-functional definition
    • Need to discuss what we recommend here, notably regarding:
      • load balancing, HA
      • supported topologies
      • performance/latency
  • Functional integrity
    • Other WG members/LLC to perform deep dive
    • LLC to publish Set Presence endpoint
  • Documentation integrity

Launch activities

  • All users of the Symphony Platform should be made aware of this significant milestone. For example: