diff options
| author | Johan Herland <johan@herland.net> | 2019-12-01 02:49:54 +0100 |
|---|---|---|
| committer | Stephen Finucane <stephen@that.guru> | 2019-12-01 11:59:37 +0000 |
| commit | de36300a2f78c7d22e9f6879342b99ad1c4586b2 (patch) | |
| tree | c220359922999185bd87f87a8c74eba28cb98f4d /docs | |
| parent | 79a3efb63a3ac2dea0382a4d6ec1b675a7b154c9 (diff) | |
| download | patchwork-de36300a2f78c7d22e9f6879342b99ad1c4586b2.tar patchwork-de36300a2f78c7d22e9f6879342b99ad1c4586b2.tar.gz | |
REST: Add 'actor' field to '/events' model
Signed-off-by: Johan Herland <johan@herland.net>
Reviewed-by: Stephen Finucane <stephen@that.guru>
Acked-by: Daniel Axtens <dja@axtens.net>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Closes: #73
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/schemas/latest/patchwork.yaml | 7 | ||||
| -rw-r--r-- | docs/api/schemas/patchwork.j2 | 9 | ||||
| -rw-r--r-- | docs/api/schemas/v1.2/patchwork.yaml | 7 | ||||
| -rw-r--r-- | docs/usage/overview.rst | 3 |
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 |