From fedf55f7354fbd00ee60fb77cd11f26df5ef6e54 Mon Sep 17 00:00:00 2001 From: Balazs Gibizer Date: Wed, 18 Apr 2018 14:41:09 +0200 Subject: [PATCH] Suggest when to propose notification changes This patch adds couple of cases when the spec author should consider proposing changes to the versioned notification related to the proposed feature. Change-Id: Ide0b58003aee46bd41f4df4e52503e415cbfc04b --- specs/rocky-template.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/specs/rocky-template.rst b/specs/rocky-template.rst index 374a3891c..990d8484a 100644 --- a/specs/rocky-template.rst +++ b/specs/rocky-template.rst @@ -222,6 +222,18 @@ Notifications impact Please specify any changes to notifications. Be that an extra notification, changes to an existing notification, or removing a notification. +Consider proposing changes to the versioned notifications: + +* When the feature adds or removes fields to the API responses. For example + when the feature adds a new field to the ``GET /servers`` API response + consider adding similar information to the payload of the instance action + notifications +* When the feature adds a new action to the existing API entities. For example + adding a new action to the server might mean you want to emit a corresponding + new instance action notification +* When the feature adds a new resource (noun) to the REST API consider adding + new notifications about the creation and deletion of such resource + Other end user impact ---------------------