search

apache / openwhisk

Apache OpenWhisk is an open source serverless cloud platform
https://openwhisk.apache.org/
Apache License 2.0
6.54k stars 1.17k forks source link

promote REST API documentation to first class #1286

Closed sjfink closed 7 years ago

sjfink commented 8 years ago

We get a lot of questions about how to use the REST API for OW.

Right now we have limited documentation, and it's nested in https://github.com/openwhisk/openwhisk/blob/master/docs/reference.md

Instead, promote it to a new top-level chapter (using the OW REST API) and fill in missing details.

fe01134 commented 8 years ago

It would be helpful when using the REST API authentication additional getting started guidance would be given on how to authenticate to OpenWhisk from a real app IE NodeJS or Java or Python. I tried creating a custom Alexa Skill from AWS to Open Whisk. I was unable to figure it out how to configure the authentication format to get Alex Skill to call the Open Whisk API. How do I create the authentication request ( headers etc) The current directions immediately describe how to use the API without providing the crucial first step of authentication/securing.

csantanapr commented 8 years ago

Thanks @fe01134 for the feedback

The section should address your concern on getting started using the API, from creating and invoking/firing actions/triggers and also use the CLI -v flag to inspect the http request that is doing under the hood.