def doc_param_search_query(name=search.SearchConfig.SEARCH_QUERY_PARAM, search_params_doc=None, required=None):
description = u"The search query."
if search_params_doc is not None:
description += u"<br>".join([
u"<dt>{}:</dt><dd>{}</dd>".format(k or DEFAULT_SEARCH_TERM_LABEL, v)
for k, v in sorted(search_params_doc.items())])
return swagger.doc_param(name, description, required=required)
def doc_param_selectors(name=search.SearchConfig.FIELD_SELECTORS_PARAM, description=None, required=None):
if description is None:
description = u"Describes which fields will be included in resource response."
return swagger.doc_param(name, description, required=required)
def doc_param_id(name='id', resource_name=None, required=True):
description = u"The {} identifier.".format(resource_name or 'resource')
return swagger.doc_param(name, description, required=required)
