swh.web.api package

Subpackages

• swh.web.api.views package
  • Submodules
    • swh.web.api.views.citation module
    • swh.web.api.views.content module
    • swh.web.api.views.directory module
    • swh.web.api.views.extid module
    • swh.web.api.views.graph module
    • swh.web.api.views.identifiers module
    • swh.web.api.views.metadata module
    • swh.web.api.views.origin module
    • swh.web.api.views.ping module
    • swh.web.api.views.raw module
    • swh.web.api.views.release module
    • swh.web.api.views.revision module
    • swh.web.api.views.snapshot module
    • swh.web.api.views.stat module
    • swh.web.api.views.utils module
  • Module contents

Submodules

• swh.web.api.apidoc module
  • APIDocException
  • api_doc()
  • get_doc_data()
  • format_docstring()
• swh.web.api.apiresponse module
  • compute_link_header()
  • filter_by_fields()
  • transform()
  • make_api_response()
  • error_response()
  • error_response_handler()
• swh.web.api.apiurls module
  • APIUrls
    • APIUrls.apidoc_routes
    • APIUrls.get_app_endpoints()
    • APIUrls.add_doc_route()
  • api_route()
• swh.web.api.parsers module
  • YAMLParser
    • YAMLParser.media_type
    • YAMLParser.parse()
• swh.web.api.renderers module
  • YAMLRenderer
    • YAMLRenderer.media_type
    • YAMLRenderer.format
    • YAMLRenderer.charset
    • YAMLRenderer.ensure_ascii
    • YAMLRenderer.default_flow_style
    • YAMLRenderer.render()
  • PlainTextRenderer
    • PlainTextRenderer.media_type
    • PlainTextRenderer.format
    • PlainTextRenderer.charset
    • PlainTextRenderer.render()
• swh.web.api.serializers module
  • SoftLimitsIntegerField
    • SoftLimitsIntegerField.to_internal_value()
  • SWHIDField
    • SWHIDField.to_internal_value()
  • IRIField
    • IRIField.to_internal_value()
• swh.web.api.throttling module
  • SwhWebRateThrottle
    • SwhWebRateThrottle.scope
    • SwhWebRateThrottle.get_cache_key()
    • SwhWebRateThrottle.get_exempted_networks()
    • SwhWebRateThrottle.get_scope()
    • SwhWebRateThrottle.allow_request()
  • SwhWebUserRateThrottle
    • SwhWebUserRateThrottle.NUM_REQUESTS_FACTOR
    • SwhWebUserRateThrottle.get_cache_key()
    • SwhWebUserRateThrottle.parse_rate()
    • SwhWebUserRateThrottle.allow_request()
  • throttle_scope()
• swh.web.api.urls module
• swh.web.api.utils module
  • filter_field_keys()
  • person_to_string()
  • enrich_object()
  • enrich_release()
  • enrich_directory_entry()
  • enrich_metadata_endpoint()
  • enrich_content()
  • enrich_revision()
  • enrich_snapshot()
  • enrich_origin()
  • enrich_origin_search_result()
  • enrich_origin_visit()
  • enrich_extid()

Module contents