From 1157060ce6b78ff1c9b5145c832bb4801fe9e1b3 Mon Sep 17 00:00:00 2001 From: Denis Makogon Date: Mon, 23 Jan 2017 15:46:34 +0200 Subject: [PATCH] Add topic related to private and public functions Change-Id: Ibe92d4eecc7579e60706491aa51fe13948a2fe5e --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 5dedf69..c3f1440 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,21 @@ API docs are discoverable via Swagger. Just launch the Picasso API and browse to http://:/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: + + :/r/{project}/{app}/{route} for private functions + :/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)