httpdomain.httpdomain Namespace Reference

Data Structures
class	DocRef
class	RFC2616Ref
class	IETFRef
class	EventSourceRef
class	CORSRef
class	HTTPResource
class	HTTPOptions
class	HTTPHead
class	HTTPPatch
class	HTTPPost
class	HTTPGet
class	HTTPPut
class	HTTPDelete
class	HTTPTrace
class	HTTPConnect
class	HTTPCopy
class	HTTPAny
class	HTTPXRefRole
class	HTTPXRefMethodRole
class	HTTPXRefStatusRole
class	HTTPXRefHeaderRole
class	HTTPIndex
class	HTTPDomain
class	HTTPLexer

Functions
def	sort_by_method (entries)
def	http_resource_anchor (method, path)
def	setup (app)

Variables
dictionary	_doctree_cache = {}
dictionary	METHOD_REFS
dictionary	HEADER_REFS
dictionary	HTTP_STATUS_CODES
list	WEBDAV_STATUS_CODES = [207, 422, 423, 424, 507]
	http_sig_param_re

Detailed Description

    sphinxcontrib.httpdomain
    ~~~~~~~~~~~~~~~~~~~~~~~~

    The HTTP domain for documenting RESTful HTTP APIs.

    :copyright: Copyright 2011 by Hong Minhee
    :license: BSD, see LICENSE for details.

Function Documentation

sort_by_method()

def httpdomain.httpdomain.sort_by_method

(

entries

)

Definition at line 243 of file httpdomain.py.

def sort_by_method(entries):
    def cmp(item):
        order = ['HEAD', 'GET', 'POST', 'PUT', 'DELETE', 'PATCH',
                 'OPTIONS', 'TRACE', 'CONNECT', 'COPY', 'ANY']
        method = item[0].split(' ', 1)[0]
        if method in order:
            return order.index(method)
        return 100
    return sorted(entries, key=cmp)
 
 

Referenced by httpdomain.httpdomain.HTTPIndex.generate().

Here is the caller graph for this function:

http_resource_anchor()

def httpdomain.httpdomain.http_resource_anchor	(		method,
			path
	)

Definition at line 254 of file httpdomain.py.

def http_resource_anchor(method, path):
    path = re.sub(r'[{}]', '', re.sub(r'[<>:/]', '-', path))
    return method.lower() + '-' + path
 
 

Referenced by httpdomain.httpdomain.HTTPResource.add_target_and_index(), httpdomain.httpdomain.HTTPIndex.generate(), httpdomain.httpdomain.HTTPDomain.get_objects(), and httpdomain.httpdomain.HTTPDomain.resolve_xref().

Here is the caller graph for this function:

setup()

def httpdomain.httpdomain.setup

(

app

)

Definition at line 762 of file httpdomain.py.

def setup(app):
    app.add_domain(HTTPDomain)
 
    try:
        get_lexer_by_name('http')
    except ClassNotFound:
        app.add_lexer('http', HTTPLexer())
    app.add_config_value('http_index_ignore_prefixes', [], None)
    app.add_config_value('http_index_shortname', 'routing table', True)
    app.add_config_value('http_index_localname', 'HTTP Routing Table', True)
    app.add_config_value('http_strict_mode', True, None)
    app.add_config_value('http_headers_ignore_prefixes', ['X-'], None)

Variable Documentation

_doctree_cache

dictionary httpdomain.httpdomain._doctree_cache = {}

private

Definition at line 36 of file httpdomain.py.

METHOD_REFS

dictionary httpdomain.httpdomain.METHOD_REFS

Initial value:

=  {
    'patch': IETFRef(5789, 2),
    'options': IETFRef(7231, '4.3.7'),
    'get': IETFRef(7231, '4.3.1'),
    'head': IETFRef(7231, '4.3.2'),
    'post': IETFRef(7231, '4.3.3'),
    'put': IETFRef(7231, '4.3.4'),
    'delete': IETFRef(7231, '4.3.5'),
    'trace': IETFRef(7231, '4.3.8'),
    'connect': IETFRef(7231, '4.3.6'),
    'copy': IETFRef(2518, 8.8),
    'any': ''
}

Definition at line 89 of file httpdomain.py.

HEADER_REFS

dictionary httpdomain.httpdomain.HEADER_REFS

Definition at line 106 of file httpdomain.py.

HTTP_STATUS_CODES

dictionary httpdomain.httpdomain.HTTP_STATUS_CODES

Definition at line 179 of file httpdomain.py.

WEBDAV_STATUS_CODES

list httpdomain.httpdomain.WEBDAV_STATUS_CODES = [207, 422, 423, 424, 507]

Definition at line 237 of file httpdomain.py.

http_sig_param_re

httpdomain.httpdomain.http_sig_param_re

Initial value:

=  re.compile(r'\‍((?:(?P<type>[^:)]+):)?(?P<name>[\w_]+)\‍)',
                               re.VERBOSE)

Definition at line 239 of file httpdomain.py.