Merge pull request #33 from automationator/master

Documentation ahoy!

README.rst

@@ -1,6 +1,8 @@
 SIP: Simple Intel Platform
 ==========================
 
+Read the full documentation at `Read the Docs <https://simple-intel-platform.readthedocs.io/en/latest/>`_.
+
 Run the included setup script to begin configuration.
 
 ::

services/web/docs/api.rst

@@ -6,4 +6,25 @@ API
    :caption: Contents:
 
    Alert <api/alert>
-   AlertType <api/alert_type>
+   AlertType <api/alert_type>
+   Campaign <api/campaign>
+   CampaignAlias <api/campaign_alias>
+   Event <api/event>
+   EventAttackVector <api/event_attack_vector>
+   EventDisposition <api/event_disposition>
+   EventPreventionTool <api/event_prevention_tool>
+   EventRemediation <api/event_remediation>
+   EventStatus <api/event_status>
+   EventType <api/event_type>
+   Indicator <api/indicator>
+   IndicatorConfidence <api/indicator_confidence>
+   IndicatorImpact <api/indicator_impact>
+   IndicatorStatus <api/indicator_status>
+   IndicatorType <api/indicator_type>
+   IntelReference <api/intel_reference>
+   IntelSource <api/intel_source>
+   Malware <api/malware>
+   MalwareType <api/malware_type>
+   Role <api/role>
+   Tag <api/tag>
+   User <api/user>

services/web/docs/api/campaign.rst

@@ -0,0 +1,58 @@
+Campaign
+********
+
+.. contents::
+  :backlinks: none
+
+Summary
+-------
+
+.. qrefflask:: project:create_app()
+  :endpoints: api.create_campaign, api.read_campaign, api.read_campaigns, api.update_campaign, api.delete_campaign
+  :order: path
+
+Create
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/campaign_create.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.create_campaign
+
+Read Single
+-----------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_campaign
+
+Read Multiple
+-------------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_campaigns
+
+Update
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/campaign_update.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.update_campaign
+
+Delete
+------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.delete_campaign

services/web/docs/api/campaign_alias.rst

@@ -0,0 +1,58 @@
+CampaignAlias
+*************
+
+.. contents::
+  :backlinks: none
+
+Summary
+-------
+
+.. qrefflask:: project:create_app()
+  :endpoints: api.create_campaign_alias, api.read_campaign_alias, api.read_campaign_aliases, api.update_campaign_alias, api.delete_campaign_alias
+  :order: path
+
+Create
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/campaign_alias_create.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.create_campaign_alias
+
+Read Single
+-----------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_campaign_alias
+
+Read Multiple
+-------------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_campaign_aliases
+
+Update
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/campaign_alias_update.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.update_campaign_alias
+
+Delete
+------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.delete_campaign_alias

services/web/docs/api/event.rst

@@ -0,0 +1,67 @@
+Event
+*****
+
+.. contents::
+  :backlinks: none
+
+Summary
+-------
+
+.. qrefflask:: project:create_app()
+  :endpoints: api.create_event, api.read_event, api.read_events, api.update_event, api.delete_event
+  :order: path
+
+Create
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+*NOTE*: While only **name** and **username** are listed as required parameters,
+**disposition** and **status** are also required. However, these two 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.
+
+SIP comes with a list of reasonable values that are added to the database during
+its initial setup. For example, the default disposition chosen is "DELIVERY", and
+the default status is "OPEN".
+
+.. jsonschema:: ../../project/api/schemas/event_create.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.create_event
+
+Read Single
+-----------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_event
+
+Read Multiple
+-------------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_events
+
+Update
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/event_update.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.update_event
+
+Delete
+------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.delete_event

services/web/docs/api/event_attack_vector.rst

@@ -0,0 +1,58 @@
+EventAttackVector
+*****************
+
+.. contents::
+  :backlinks: none
+
+Summary
+-------
+
+.. qrefflask:: project:create_app()
+  :endpoints: api.create_event_attack_vector, api.read_event_attack_vector, api.read_event_attack_vectors, api.update_event_attack_vector, api.delete_event_attack_vector
+  :order: path
+
+Create
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/value_create.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.create_event_attack_vector
+
+Read Single
+-----------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_event_attack_vector
+
+Read Multiple
+-------------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_event_attack_vectors
+
+Update
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/value_update.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.update_event_attack_vector
+
+Delete
+------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.delete_event_attack_vector

services/web/docs/api/event_disposition.rst

@@ -0,0 +1,58 @@
+EventDisposition
+****************
+
+.. contents::
+  :backlinks: none
+
+Summary
+-------
+
+.. qrefflask:: project:create_app()
+  :endpoints: api.create_event_disposition, api.read_event_disposition, api.read_event_dispositions, api.update_event_disposition, api.delete_event_disposition
+  :order: path
+
+Create
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/value_create.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.create_event_disposition
+
+Read Single
+-----------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_event_disposition
+
+Read Multiple
+-------------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.read_event_dispositions
+
+Update
+------
+
+**JSON Schema**
+
+Required parameters are in **bold**.
+
+.. jsonschema:: ../../project/api/schemas/value_update.json
+
+|
+
+.. autoflask:: project:create_app()
+  :endpoints: api.update_event_disposition
+
+Delete
+------
+
+.. autoflask:: project:create_app()
+  :endpoints: api.delete_event_disposition