From c965b1892f71c286a8a1c9f1df25447aeef53943 Mon Sep 17 00:00:00 2001 From: Slawek Kaplonski Date: Mon, 26 Jun 2023 10:46:10 +0200 Subject: [PATCH] Add short warning about UUIDs in the SG rule templates api SG rule template API accepts any string (any uuid) as remote group id or remote address group id. It may be something what's not existing in the time of the creation of template and that's fine. But if it will be not existing when regular SG will be created for project it will fail making SG for that project. This patch adds small warning about this to the default SG rules template api-ref. Additionally this patch updated some small issues in the "create default security group rule" section. Related-Bug: #1983053 Change-Id: I9bad07d8ed11796047883f87b45a7da0799cdcb1 --- api-ref/source/v2/security_groups_default_rules.inc | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/api-ref/source/v2/security_groups_default_rules.inc b/api-ref/source/v2/security_groups_default_rules.inc index 1d8ae01ff..1d1c36796 100644 --- a/api-ref/source/v2/security_groups_default_rules.inc +++ b/api-ref/source/v2/security_groups_default_rules.inc @@ -80,7 +80,7 @@ Create security group default rule .. rest_method:: POST /v2.0/default-security-group-rules -Creates an OpenStack Networking templale of the security group rule. +Creates an Openstack Networking security group rule template. Normal response codes: 201 @@ -134,6 +134,15 @@ Response Example .. literalinclude:: samples/security-group-default-rules/security-group-default-rule-create-response.json :language: javascript +.. warning:: + + The security group rule template APIs do not validate the UUID of the resources + like ``remote address group id`` or ``remote group ID``. Any string can be + provided here, but please note that it will be used to create real security + group rules for projects, and if the UUID of a non-existing ``security + group`` or ``remote address group`` is used, it will cause errors during + creation of the security groups. + Show security group default rule ================================