Save work on openapi doc

inverse-inc · Oct 29, 2018 · 5e84f55 · 5e84f55
1 parent 7a765a9
commit 5e84f55
Show file tree

Hide file tree

Showing 137 changed files with 1,556 additions and 121 deletions.
diff --git a/docs/PacketFence_Installation_Guide.asciidoc b/docs/PacketFence_Installation_Guide.asciidoc
@@ -2624,7 +2624,7 @@ Configuring a Regex Syslog Parser
 Regex Syslog Parser Rule
 
 - Name - The name of the rule
-- Regex - The regex to match against a log entry. The regex may have http://perldoc.perl.org/perlre.html#(%3f'NAME'pattern[named captures] which can be used for parameter replacement start a '$'.
+- Regex - The regex to match against a log entry. The regex may have https://github.com/google/re2/wiki/Syntax[named captures] which can be used for parameter replacement start a '$'.
 - Actions - A list of actions to take when the regex matches
 - IP to MAC - Perform automatic translation of IPs to MACs and the other way around
 - Last if matches - Stop processing the other rules if this rule matched
@@ -2640,7 +2640,7 @@ Example Action
 
 Regex -
 
-    mac\s*:\s*(?&lt;mac&gt;[a-zA-Z0-9]{2}(:[a-zA-Z0-9]{2}){5}), notes\s*:\s*(?&lt;notes&gt;.*)
+    mac\s*:\s*(?P&lt;mac&gt;[a-zA-Z0-9]{2}(:[a-zA-Z0-9]{2}){5}), notes\s*:\s*(P?&lt;notes&gt;.*)
 
 Action -
 
@@ -2669,7 +2669,7 @@ Here is the configuration of the syslog regex parser:
     Rule - New:
 
     Name *: ET P2P Kaaza Media desktop p2pnetworking.exe
-    Regex *: (?<date>\d{2}\/\d{2}\/\d{4}-\d{2}:\d{2}:\d{2}.*?)  \[\*\*\] \[\d+:(?<sid>\d+):\d+\] (?<message>.*?) \[\*\*\].* (?<srcip>\d{1,3}(\.\d{1,3}){3}):(?<srcport>\d+) -> (?<ip>\d{1,3}(\.\d{1,3}){3}):(?<port>\d+)
+    Regex *: (?P<date>\d{2}\/\d{2}\/\d{4}-\d{2}:\d{2}:\d{2}.*?)  \[\*\*\] \[\d+:(?P<sid>\d+):\d+\] (?P<message>.*?) \[\*\*\].* (?P<srcip>\d{1,3}(\.\d{1,3}){3}):(?P<srcport>\d+) -> (?P<ip>\d{1,3}(\.\d{1,3}){3}):(?P<port>\d+)
     Action: trigger_violation mac, $mac, tid, $sid, type, detect
     Last if match: unchecked
     IP to MAC: checked

diff --git a/docs/api/spec/components/parameters/base.yaml b/docs/api/spec/components/parameters/base.yaml
@@ -49,13 +49,6 @@ sort:
       type: string
   description: A list of fields to sort on along with the ordering way (ASC or DESC).
 
-search_params:
-  - $ref: '#/components/parameters/cursor'
-  - $ref: '#/components/parameters/limit'
-  - $ref: '#/components/parameters/search_query'
-  - $ref: '#/components/parameters/fields'
-  - $ref: '#/components/parameters/sort'
-
 local:
   in: query
   name: local

diff --git a/docs/api/spec/components/schemas/apiuser.yaml b/docs/api/spec/components/schemas/apiuser.yaml
@@ -12,5 +12,4 @@ ApiUser:
       type: string
     valid_from:
       type: string
-  required: []
   type: object
diff --git a/docs/api/spec/components/schemas/apiuserslist.yaml b/docs/api/spec/components/schemas/apiuserslist.yaml
@@ -3,6 +3,7 @@ ApiUsersList:
   - $ref: '#/components/schemas/Iterable'
   - properties:
       items:
+        description: Items
         items:
           $ref: '#/components/schemas/ApiUser'
         type: array

diff --git a/docs/api/spec/components/schemas/configadminroleslist.yaml b/docs/api/spec/components/schemas/configadminroleslist.yaml
@@ -3,7 +3,9 @@ ConfigAdminRolesList:
   - $ref: '#/components/schemas/Iterable'
   - properties:
       items:
+        description: List
         items:
           $ref: '#/components/schemas/ConfigAdminRole'
         type: array
     type: object
+  description: List