OpenWhisk returns whole response object instead of just the data

Question

I have an OpenWhisk action that returns a response object, because I want to be able to control the headers and HTTP status code. My action returns something like this:

 return {
    statusCode: 200,
    headers: { 'Content-Type': 'application/json' },
    body: { x: 1 }
  };

I deploy the action in a package from the command-line with:

wsk action update myproj/myaction --kind nodejs:6 myaction.zip --web true

And expose it as API on IBM Cloud Functions with:

wsk api create /myproj /myaction get myproj/myaction

But when I visit the API call with curl, I get the whole response object, not just the data:

curl '.../myproj/myaction'

{
  "statusCode": 200,
  "headers": {
    "Content-Type": "application/json"
  },
  "body": { x: 1 }
}

I was expecting to get just { x: 1 }.

What do I need to do to fix this?

When no http extension is passed to “wsk api” the default type is json like passing “--response-type json” ser the two options to fix in answer below — csantanapr, Nov 20 '17 at 11:49

score 2 · Accepted Answer · answered Nov 20 '17 at 09:56

The default API Gateway service behaviour expects body data to be returned from the action, not the full HTTP response parameters.

Change the return statement to the following to resolve this issue.

return {
    x: 1
};

Controlling the full HTTP response using the returned action parameters needs the --response-type http flag setting on the web action.

$ wsk api create /myproj /myaction get myproj/myaction --response-type http

OpenWhisk returns whole response object instead of just the data

1 Answers1