Update docs for audit & statistics api's
Update docs for audit & statistics api's to keep them in sync with the recent code changes in pap.
Issue-ID: POLICY-3528
Change-Id: I4ba8f5aacf0a0d63a727bee533e829bca9bab55b
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
diff --git a/docs/pap/pap.rst b/docs/pap/pap.rst
index d3cbf8b..4341c96 100644
--- a/docs/pap/pap.rst
+++ b/docs/pap/pap.rst
@@ -364,6 +364,7 @@
This operation allows the PDP statistics to be retrieved for all registered PDPs.
The result can be filtered based on PDP group, PDP subgroup & PDP instance.
+Along with record count, start time & end time as query parameters.
Here is a sample response:
@@ -376,7 +377,7 @@
This operation allows the audit records of policies to be listed together.
The result can be filtered based on pdp group name, policy name & version.
-Along with record count, from date & to date as query parameters.
+Along with record count, start time & end time as query parameters.
Here is a sample response:
diff --git a/docs/pap/swagger/pdp-statistics-pap.json b/docs/pap/swagger/pdp-statistics-pap.json
index 7b652ad..c2c7b4c 100644
--- a/docs/pap/swagger/pdp-statistics-pap.json
+++ b/docs/pap/swagger/pdp-statistics-pap.json
@@ -39,6 +39,30 @@
"required": false,
"type": "string",
"format": "uuid"
+ },
+ {
+ "name": "recordCount",
+ "in": "query",
+ "description": "Record count between 1-100",
+ "required": false,
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
}
],
"responses": {
@@ -118,6 +142,30 @@
"description": "PDP Group Name",
"required": true,
"type": "string"
+ },
+ {
+ "name": "recordCount",
+ "in": "query",
+ "description": "Record count between 1-100",
+ "required": false,
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
}
],
"responses": {
@@ -204,6 +252,30 @@
"description": "PDP SubGroup type",
"required": true,
"type": "string"
+ },
+ {
+ "name": "recordCount",
+ "in": "query",
+ "description": "Record count between 1-100",
+ "required": false,
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
}
],
"responses": {
@@ -301,11 +373,26 @@
{
"name": "recordCount",
"in": "query",
- "description": "Record Count",
+ "description": "Record count between 1-100",
"required": false,
"type": "integer",
- "default": 0,
"format": "int32"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End time in epoch timestamp",
+ "required": false,
+ "type": "integer",
+ "format": "int64"
}
],
"responses": {
diff --git a/docs/pap/swagger/policy-audit-pap.json b/docs/pap/swagger/policy-audit-pap.json
index 24b90c7..1fd9231 100644
--- a/docs/pap/swagger/policy-audit-pap.json
+++ b/docs/pap/swagger/policy-audit-pap.json
@@ -53,17 +53,17 @@
"format": "int32"
},
{
- "name": "fromDate",
+ "name": "startTime",
"in": "query",
- "description": "From date in epoch timestamp",
+ "description": "Start time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
},
{
- "name": "toDate",
+ "name": "endTime",
"in": "query",
- "description": "To date in epoch timestamp",
+ "description": "End time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
@@ -149,17 +149,17 @@
"format": "int32"
},
{
- "name": "fromDate",
+ "name": "startTime",
"in": "query",
- "description": "From date in epoch timestamp",
+ "description": "Start time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
},
{
- "name": "toDate",
+ "name": "endTime",
"in": "query",
- "description": "To date in epoch timestamp",
+ "description": "End time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
@@ -252,17 +252,17 @@
"format": "int32"
},
{
- "name": "fromDate",
+ "name": "startTime",
"in": "query",
- "description": "From date in epoch timestamp",
+ "description": "Start time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
},
{
- "name": "toDate",
+ "name": "endTime",
"in": "query",
- "description": "To date in epoch timestamp",
+ "description": "End time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
@@ -359,17 +359,17 @@
"format": "int32"
},
{
- "name": "fromDate",
+ "name": "startTime",
"in": "query",
- "description": "From date in epoch timestamp",
+ "description": "Start time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"
},
{
- "name": "toDate",
+ "name": "endTime",
"in": "query",
- "description": "To date in epoch timestamp",
+ "description": "End time in epoch timestamp",
"required": false,
"type": "integer",
"format": "int64"