batch endpoint for guillotina
Project description
# Guillotina Batch Docs
This package simple provides a `@batch` endpoint to Guillotina which
allows you to group multiple requests into one.
## Configuration
Just add a few lines to your config.yml::
{"applications": ["guillotina_batch"]}
## Usage
The `@batch` endpoint takes a array of batch definitions taking the following parameters:
- method:str
- endpoint:str
- headers:object[str, str]
- payload:object
For example::
```
POST /db/container/@batch [{
"method": "POST",
"endpoint": "path/to/object/@sharing",
"payload": {
"prinperm": [{
"principal": "user1",
"permission": "guillotina.AccessContent",
"setting": "AllowSingle"
}]
}
},{
"method": "POST",
"endpoint": "path/to/object2/@sharing",
"payload": {
"prinperm": [{
"principal": "user1",
"permission": "guillotina.AccessContent",
"setting": "AllowSingle"
}]
}
}]
```
1.0.3 (2018-06-27)
------------------
- Including parent request's security in batched view [lferran]
1.0.2 (2018-06-27)
------------------
- try again
1.0.1 (2018-06-13)
- markdown fix
## 1.0.0 (2018-06-11)
- Initial release
[vangheem]
This package simple provides a `@batch` endpoint to Guillotina which
allows you to group multiple requests into one.
## Configuration
Just add a few lines to your config.yml::
{"applications": ["guillotina_batch"]}
## Usage
The `@batch` endpoint takes a array of batch definitions taking the following parameters:
- method:str
- endpoint:str
- headers:object[str, str]
- payload:object
For example::
```
POST /db/container/@batch [{
"method": "POST",
"endpoint": "path/to/object/@sharing",
"payload": {
"prinperm": [{
"principal": "user1",
"permission": "guillotina.AccessContent",
"setting": "AllowSingle"
}]
}
},{
"method": "POST",
"endpoint": "path/to/object2/@sharing",
"payload": {
"prinperm": [{
"principal": "user1",
"permission": "guillotina.AccessContent",
"setting": "AllowSingle"
}]
}
}]
```
1.0.3 (2018-06-27)
------------------
- Including parent request's security in batched view [lferran]
1.0.2 (2018-06-27)
------------------
- try again
1.0.1 (2018-06-13)
- markdown fix
## 1.0.0 (2018-06-11)
- Initial release
[vangheem]
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file guillotina_batch-1.0.3.tar.gz
.
File metadata
- Download URL: guillotina_batch-1.0.3.tar.gz
- Upload date:
- Size: 5.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b45b13d209bb77176c87c6620f4183be7d86b26c4e157e0941ad05ea161deeb |
|
MD5 | 360d694cc35e6318b459a176684a6327 |
|
BLAKE2b-256 | c065e69c5a411f947456d1ebf6731a41787363f5d9ebf3676b5d3654fe5af005 |
File details
Details for the file guillotina_batch-1.0.3-py3-none-any.whl
.
File metadata
- Download URL: guillotina_batch-1.0.3-py3-none-any.whl
- Upload date:
- Size: 7.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7594b3ff45ba9c91f653242499138dfc16de19a500db67837fe2f87cc5983e10 |
|
MD5 | 508c9133180cc4269f73df335232f134 |
|
BLAKE2b-256 | 0e6ce9d2b0e7cffdca1938f91bbce92d5d1ebd6c4434cbd7348a71302d8ddd97 |