Rest API response is not right about kalliope HOT 11 CLOSED

jsonify in this case transform the content of the yaml into a json output (and add headers and a few things).
But whatever yaml file you jsonify, the result will be a correct json.
The content however, is where the jsonapi standards indicate what the json must contains.

eg:, for /synapses, kalliope API returns an array of synapses like

{
  "synapses": [
    {
      "name": "say-hello-fr", 
      "neurons": [
        {
          "say": {
            "message": [
              "Bonjour monsieur"
            ]
          }
        }
      ], 
      "signals": [
        {
          "order": "bonjour"
        }
      ]
    }
  ]
}

whereas with the jsonapi standard, the content should be something like:

{
  "links": {
    "self": "http://kalliopeHost:5000/synapses"
  },
  "data": [{
    "type": "synapses",
    "id": "1",
    "attributes": {
      "name": "say-hello-fr", 
      "neurons": [
        {
          "say": {
            "message": [
              "Bonjour monsieur"
            ]
          }
        }
      ], 
      "signals": [
        {
          "order": "bonjour"
        }
      ]
    }
  }]
}

That being said, it is not that important to follow it but JS frontend can work with very limited amount of custom code if the API follow it (eg: https://github.com/jakubrohleder/angular-jsonapi for angularjs or http://emberjs.com/api/data/classes/DS.JSONAPIAdapter.html in core of emberjs).

But

from kalliope.

Does it returns all synapses in included yaml or just the "include" pointer?

from kalliope.

I found the problem. I chose to send the loaded yaml file directly instead of serialize object per object.
I need to update this part...

from kalliope.

As a more global remark on the API, I think the API should:

• be JsonAPI compliant (so easier to create backend using angularjs or emberjs frontend)
• Be configurable to authorize cors request in case frontend has not the same origine as kalliope (origine being host + port + scheme). It might often be the case as a JS app might not run on the same port as kalliope.

from kalliope.

yes I agree, we did not spend much time on the API, we need to investigate deeper on those 2 points.

from kalliope.

Ok, so I did a quick hack to test something.
By adding the flask-cors library, and adding the 2 lines as per the following diff, I can make my emberjs app working (on port 4200, my node server) and with kalliope on port 5000.

Is this something worth investigating? I could try to set this up as optional (as the authentication part) so that only people allowing CORS request will have this feature?
(obviously the code below is just a quick hack that need better config, eg: for origin acceptance)

diff --git i/kalliope/core/RestAPI/FlaskAPI.py w/kalliope/core/RestAPI/FlaskAPI.py
index 01c3856..298a0bc 100644
--- i/kalliope/core/RestAPI/FlaskAPI.py
+++ w/kalliope/core/RestAPI/FlaskAPI.py
@@ -4,6 +4,8 @@ from flask import jsonify
 from flask import request
 from flask_restful import abort

+from flask_cors import CORS, cross_origin
+
 from kalliope.core import OrderAnalyser
 from kalliope.core.RestAPI.utils import requires_auth
 from kalliope.core.SynapseLauncher import SynapseLauncher
@@ -23,6 +25,8 @@ class FlaskAPI(threading.Thread):
         self.port = port
         self.brain = brain

+        cors = CORS(app, resources={r"/*": {"origins": "*"}}, supports_credentials=True)
+
         self.app.add_url_rule('/synapses/', view_func=self.get_synapses, methods=['GET'])
         self.app.add_url_rule('/synapses/<synapse_name>', view_func=self.get_synapse, methods=['GET'])
         self.app.add_url_rule('/synapses/<synapse_name>', view_func=self.run_synapse, methods=['POST'])

edit: Also, simply adding the line:

self.app.add_url_rule('/synapses', view_func=self.get_synapses, methods=['GET'])

seems to work fine to add a more standard routes to retrieve synapses (GET /synapses)

from kalliope.

be JsonAPI compliant

We are not JSON compliant here?

from kalliope.

The API return json but is not really jsonapi compliant (which is a new standard for api that return json for url and response content)

from kalliope.

Actually we are using the jsonify lib to return from the yaml so it seems compliant ... or the lib itself is not

from kalliope.

Ok, thanks for the example.
It seems it's not really implemented a lot yet. Even in professional projects. So, we'll see if we implement it from our side when we will review the Web App for Kalliope client config. It will be in Angular 2 I think.

from kalliope.

Fixed in the v0.4.0.

Now included brains are returned and we've also allowed the remove the last slaches in URL.

from kalliope.