Skip to content

The enigma expectancy

Andrée Hansson edited this page Nov 30, 2017 · 2 revisions

This page outlines what we expect from a library calling itself enigma.*.

Principles

  1. It should generate an API based on a QIX Engine schema
  2. It should return generated APIs (API instances) whenever it sees a qHandle and qType reference
  3. It should allow an end user to extend and/or override the generated APIs (mixins)
  4. It does not handle authentication
  5. A session has only one websocket, it is considered expended when closed
  6. A session does not open websocket on instantiation, it is a separate action
  7. A session should have these events: opened, closed, traffic
  8. A generated API should have these events: changed, closed
  9. Configuration should have at least: url, createSocket
Clone this wiki locally