# octavia.api.common.utils

# Source code for octavia.api.common.utils

    #    Copyright 2022 Red Hat
    #
    #    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 oslo_middleware import request_id
    import webob

    from octavia.common import constants

    # Inspired by the OpenStack Placement service utils.py

    def json_error_formatter(body, status, title, environ):
        """A json_formatter for webob exceptions.

        Follows API-WG guidelines at
        http://specs.openstack.org/openstack/api-wg/guidelines/errors.html
        """
        # Clear out the html that webob sneaks in.
        body = webob.exc.strip_tags(body)
        # Get status code out of status message. webob's error formatter
        # only passes entire status string.
        status_code = int(status.split(None, 1)[0])
        error_dict = {
            constants.STATUS: status_code,
            constants.TITLE: title,
            constants.DETAIL: body
        }

        # If the request id middleware has had a chance to add an id,
        # put it in the error response.
        if request_id.ENV_REQUEST_ID in environ:
            error_dict[constants.REQUEST_ID] = environ[request_id.ENV_REQUEST_ID]

        return {constants.ERRORS: [error_dict]}

this page last updated: 2026-04-13 15:26:39

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug