Code reference

Subpackages

• Search Algorithm
  • Reference resources
  • Terms
  • Technology
  • Text analysis/tokenization
  • Search execution
    • General “query” searching
    • Individual field querying
  • Document scoring
    • Provider supplied popularity
• catalog.api package
  • Concepts
    • Authentication and Throttling
      • Flow
      • ThrottledApplication
      • Rate limit models (tiers)
      • Throttles
  • Subpackages
    • catalog.api.constants package
      • Submodules
      • catalog.api.constants.media_types module
      • Module contents
    • catalog.api.controllers package
      • Submodules
      • catalog.api.controllers.search_controller module
      • Module contents
    • catalog.api.docs package
      • Submodules
      • catalog.api.docs.audio_docs module
      • catalog.api.docs.image_docs module
      • catalog.api.docs.media_docs module
      • Module contents
    • catalog.api.examples package
      • Submodules
      • catalog.api.examples.audio_requests module
      • catalog.api.examples.audio_responses module
      • catalog.api.examples.image_requests module
      • catalog.api.examples.image_responses module
      • Module contents
    • catalog.api.models package
      • Submodules
      • catalog.api.models.audio module
      • catalog.api.models.base module
      • catalog.api.models.image module
      • catalog.api.models.media module
      • catalog.api.models.mixins module
      • catalog.api.models.models module
      • catalog.api.models.oauth module
      • Module contents
    • catalog.api.serializers package
      • Submodules
      • catalog.api.serializers.audio_serializers module
      • catalog.api.serializers.error_serializers module
      • catalog.api.serializers.image_serializers module
      • catalog.api.serializers.media_serializers module
      • catalog.api.serializers.oauth2_serializers module
      • catalog.api.serializers.provider_serializers module
      • Module contents
    • catalog.api.utils package
      • Submodules
      • catalog.api.utils.ccrel module
      • catalog.api.utils.dead_link_mask module
      • catalog.api.utils.exceptions module
      • catalog.api.utils.oauth2_helper module
      • catalog.api.utils.pagination module
      • catalog.api.utils.scheduled_tasks module
      • catalog.api.utils.status_code_view module
      • catalog.api.utils.throttle module
      • catalog.api.utils.validate_images module
      • catalog.api.utils.watermark module
      • catalog.api.utils.waveform module
      • Module contents
    • catalog.api.views package
      • Submodules
      • catalog.api.views.audio_views module
      • catalog.api.views.health_views module
      • catalog.api.views.image_views module
      • catalog.api.views.media_views module
      • catalog.api.views.oauth2_views module
      • Module contents
  • Submodules
  • catalog.api.admin module
    • AudioAdmin
      • AudioAdmin.media
      • AudioAdmin.search_fields
    • AudioReportAdmin
      • AudioReportAdmin.media
      • AudioReportAdmin.media_specific_list_display
    • ImageAdmin
      • ImageAdmin.media
      • ImageAdmin.search_fields
    • ImageReportAdmin
      • ImageReportAdmin.media
      • ImageReportAdmin.media_specific_list_display
    • MediaReportAdmin
      • MediaReportAdmin.actions
      • MediaReportAdmin.autocomplete_fields
      • MediaReportAdmin.get_exclude()
      • MediaReportAdmin.get_list_display()
      • MediaReportAdmin.get_readonly_fields()
      • MediaReportAdmin.list_display
      • MediaReportAdmin.list_display_links
      • MediaReportAdmin.list_filter
      • MediaReportAdmin.media
      • MediaReportAdmin.media_specific_list_display
      • MediaReportAdmin.search_fields
    • MediaSubreportAdmin
      • MediaSubreportAdmin.exclude
      • MediaSubreportAdmin.has_add_permission()
      • MediaSubreportAdmin.media
      • MediaSubreportAdmin.readonly_fields
      • MediaSubreportAdmin.search_fields
    • ProviderAdmin
      • ProviderAdmin.exclude
      • ProviderAdmin.list_display
      • ProviderAdmin.media
      • ProviderAdmin.search_fields
  • catalog.api.apps module
    • ApiConfig
      • ApiConfig.default_auto_field
      • ApiConfig.name
  • catalog.api.licenses module
  • Module contents
• catalog.urls package
  • Submodules
  • catalog.urls.auth_tokens module
  • catalog.urls.swagger module
  • Module contents

Submodules

catalog.custom_auto_schema module

class catalog.custom_auto_schema.CustomAutoSchema(view, path, method, components, request, overrides, operation_keys=None)

Bases: SwaggerAutoSchema

get_operation(operation_keys=None)

Get an Operation for the given API endpoint (path, method). This includes query, body parameters and response schemas.

Parameters:

operation_keys (tuple[str]) – an array of keys describing the hierarchical layout of this view in the API; e.g. ('snippets', 'list'), ('snippets', 'retrieve'), etc.

Return type:

openapi.Operation

get_pagination_parameters()

Set pagination params to an empty list.

Since the pagination params are a part of the MediaSearchRequestSerializer, they need not be added again as pagination params.

catalog.example_responses module