neutron/neutron/extensions/standardattrdescription.py
Kevin Benton 465d22180e Add common way to extend standard attribute models
This adds a way for standard attribute models to declare
the API resources they show up in. It then adds a utility
function to the standard_attr module to grab a map of all
API resources and their corresponding models.

This can be used by any processing code that wants to add
fields to standard attribute resources.

This also adjusts the existing extensions to leverage this
new functionality.

Partially-Implements: blueprint add-neutron-extension-resource-timestamp
Change-Id: Idc8923d0e983fcb0690f8cb5b55a5aff8690154f
2016-09-15 01:42:24 +00:00

54 lines
1.7 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
from neutron.db import standard_attr
DESCRIPTION_BODY = {
'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 {}
rs_map = standard_attr.get_standard_attr_resource_model_map()
return {resource: DESCRIPTION_BODY for resource in rs_map}