summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api/schemas/latest/patchwork.yaml7
-rw-r--r--docs/api/schemas/patchwork.j29
-rw-r--r--docs/api/schemas/v1.2/patchwork.yaml7
-rw-r--r--docs/usage/overview.rst3
4 files changed, 26 insertions, 0 deletions
diff --git a/docs/api/schemas/latest/patchwork.yaml b/docs/api/schemas/latest/patchwork.yaml
index 6c7564b..fc23cdb 100644
--- a/docs/api/schemas/latest/patchwork.yaml
+++ b/docs/api/schemas/latest/patchwork.yaml
@@ -1649,6 +1649,13 @@ components:
type: string
format: iso8601
readOnly: true
+ actor:
+ type: object
+ title: Actor
+ description: The user that caused/created this event.
+ readOnly: true
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
payload:
type: object
EventCoverCreated:
diff --git a/docs/api/schemas/patchwork.j2 b/docs/api/schemas/patchwork.j2
index e2c8a8c..85f3977 100644
--- a/docs/api/schemas/patchwork.j2
+++ b/docs/api/schemas/patchwork.j2
@@ -1679,6 +1679,15 @@ components:
type: string
format: iso8601
readOnly: true
+{% if version >= (1, 2) %}
+ actor:
+ type: object
+ title: Actor
+ description: The user that caused/created this event.
+ readOnly: true
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
+{% endif %}
payload:
type: object
EventCoverCreated:
diff --git a/docs/api/schemas/v1.2/patchwork.yaml b/docs/api/schemas/v1.2/patchwork.yaml
index 7dc9579..b4d1cf6 100644
--- a/docs/api/schemas/v1.2/patchwork.yaml
+++ b/docs/api/schemas/v1.2/patchwork.yaml
@@ -1649,6 +1649,13 @@ components:
type: string
format: iso8601
readOnly: true
+ actor:
+ type: object
+ title: Actor
+ description: The user that caused/created this event.
+ readOnly: true
+ allOf:
+ - $ref: '#/components/schemas/UserEmbedded'
payload:
type: object
EventCoverCreated:
diff --git a/docs/usage/overview.rst b/docs/usage/overview.rst
index e84e13d..273c792 100644
--- a/docs/usage/overview.rst
+++ b/docs/usage/overview.rst
@@ -228,6 +228,9 @@ properties:
``date``
When this event was created
+``actor``
+ The user, if any, that caused/created this event
+
``payload``
Additional information