Merge pull request #53 from automationator/master

Updates documentation
IntegralDefense · Mar 20, 2019 · 5860f7e · 5860f7e
2 parents 430ca65 + d8fc0e8
commit 5860f7e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/services/web/docs/api/indicator.rst b/services/web/docs/api/indicator.rst
@@ -18,10 +18,12 @@ Create
 
 Required parameters are in **bold**.
 
-*NOTE*: While only **type**, **username**, and **value** are listed as required parameters,
+*NOTE*: While only **type** and **value** are listed as required parameters,
 **confidence**, **impact**, and **status** are also required. However, these three parameters
 are omitted from the required list of fields because SIP will use the default values
-you chose when you initially setup and configured SIP.
+you chose when you initially setup and configured SIP. The final requirement not listed in the
+schema is that you must either supply the **username** parameter OR your API key in the
+Authorization header. This is what is used to link the indicator to the user who created it.
 
 SIP comes with a list of reasonable values that are added to the database during
 its initial setup. For example, the default confidence chosen is "LOW", impact is "LOW",

diff --git a/services/web/docs/api/intel_reference.rst b/services/web/docs/api/intel_reference.rst
@@ -18,6 +18,11 @@ Create
 
 Required parameters are in **bold**.
 
+*NOTE*: While only **reference** and **source** are listed as required parameters,
+there is a requirement not listed in the schema. You must either supply the **username**
+parameter OR your API key in the Authorization header. This is what is used to link
+the intel reference to the user who created it.
+
 .. jsonschema:: ../../project/api/schemas/intel_reference_create.json
 
 |