x/picasso
Code Issues Proposed changes

Add topic related to private and public functions

Browse Source 
Change-Id: Ibe92d4eecc7579e60706491aa51fe13948a2fe5e
This commit is contained in:
Denis Makogon 2017-01-23 15:46:34 +02:00 committed by Derek Schultz
parent b3c5aa1b8d
commit 1157060ce6
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -132,6 +132,21 @@ API docs are discoverable via Swagger. Just launch the Picasso API and browse to
http://<picasso-host>:<picasso-port>/api
### Picasso provides private and public functions
Using the Picasso API, it is possible to create two type of functions - private and public.
* Private functions are defined as functions that belong to a specific OpenStack project,
and the execution of the function requires passing in authorization headers.
* Public functions belong to a specific OpenStack project ID, but do not require any authorization
headers to execute, allowing the function to be shared with anyone.
Private and public functions are handled by different URL handlers:
<picasso-api-host>:<picasso-api-port>/r/{project}/{app}/{route} for private functions
<picasso-api-host>:<picasso-api-port>/r/{app}/{route} for public functions
See [OpenStack alarming example](examples/openstack-alarms/README.md) for more details.
### Testing Picasso
See [Testing.md](TESTING.md)