Browse Source

Add topic related to private and public functions

Change-Id: Ibe92d4eecc7579e60706491aa51fe13948a2fe5e
Denis Makogon 2 years ago
parent
commit
1157060ce6
1 changed files with 15 additions and 0 deletions
  1. 15
    0
      README.md

+ 15
- 0
README.md View File

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

Loading…
Cancel
Save