From dd5f526cfbe8a7e83ff03b5d5c2a6e9c645928c4 Mon Sep 17 00:00:00 2001
From: gnaponie <gnaponie@redhat.com>
Date: Aug 21 2019 12:17:11 +0000
Subject: Document decision should have max X artifacts


Document that clients should batch requests to X amount of artifacts
or Greenwave won't probably be able to successfully complete the
request.

ref: FACTORY-4930

Signed-off-by: gnaponie <gnaponie@redhat.com>

---

diff --git a/greenwave/api_v1.py b/greenwave/api_v1.py
index 92ee00c..5a39186 100644
--- a/greenwave/api_v1.py
+++ b/greenwave/api_v1.py
@@ -274,6 +274,30 @@ def make_decision():
            ],
        }
 
+    **Sample request 2**:
+
+    It is possible to use this additional format that allows the user to ask for
+    multiple artifacts within a single request. The subject_identifier (= ``item``)
+    and subject_type (= ``type``) are listed multiple times under the ``subject``
+    parameter.
+
+    NB: this mode will affect Greenwave performances, especially it is recommended
+    not to ask for more than 100 decision subjects at the same time, or Greenwave
+    won't probably manage to complete the request successfully.
+
+    .. sourcecode:: http
+
+       POST /api/v1.0/decision HTTP/1.1
+       Accept: application/json
+       Content-Type: application/json
+
+       {
+           "decision_context": "bodhi_update_push_stable",
+           "product_version": "fedora-26",
+           "subject": [{"item": "cross-gcc-7.0.1-0.3.fc26", "type": "koji_build"}],
+           "verbose": true
+       }
+
     **Sample On-demand policy request**:
 
     Note: Greenwave would not publish a message on the message bus when an on-demand