5dacbba701
In order to give users and operators more flexibility in annotating the purpose of various Neutron resources, this patch adds a description field limited to 255 chars to all of the Neutron resources that reference the standard attribute table. The resource that reference the table are the following: security_group_rules, security_groups, ports, subnets, networks, routers, floatingips, subnetpools This patch adds a description table related to standard attributes and migrates over the existing security group description to the new table as well. Co-Authored-By: James Dempsey <jamesd@catalyst.net.nz> APIImpact DocImpact: Adds a description field to all resources outline in commit message. Closes-Bug: #1483480 Change-Id: I6e1ef53d7aae7d04a5485810cc1db0a8eb125953
56 lines
1.8 KiB
Python
56 lines
1.8 KiB
Python
# Copyright 2016 OpenStack Foundation
|
|
# All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from neutron.api import extensions
|
|
from neutron.api.v2 import attributes as attr
|
|
|
|
|
|
EXTENDED_ATTRIBUTES_2_0 = {}
|
|
|
|
for resource in ('security_group_rules', 'security_groups', 'ports', 'subnets',
|
|
'networks', 'routers', 'floatingips', 'subnetpools'):
|
|
EXTENDED_ATTRIBUTES_2_0[resource] = {
|
|
'description': {'allow_post': True, 'allow_put': True,
|
|
'validate': {'type:string': attr.DESCRIPTION_MAX_LEN},
|
|
'is_visible': True, 'default': ''},
|
|
}
|
|
|
|
|
|
class Standardattrdescription(extensions.ExtensionDescriptor):
|
|
|
|
@classmethod
|
|
def get_name(cls):
|
|
return "standard-attr-description"
|
|
|
|
@classmethod
|
|
def get_alias(cls):
|
|
return "standard-attr-description"
|
|
|
|
@classmethod
|
|
def get_description(cls):
|
|
return "Extension to add descriptions to standard attributes"
|
|
|
|
@classmethod
|
|
def get_updated(cls):
|
|
return "2016-02-10T10:00:00-00:00"
|
|
|
|
def get_optional_extensions(self):
|
|
return ['security-group', 'router']
|
|
|
|
def get_extended_resources(self, version):
|
|
if version == "2.0":
|
|
return dict(EXTENDED_ATTRIBUTES_2_0.items())
|
|
return {}
|