pyramid_jsonapi.metadata package

Subpackages

• pyramid_jsonapi.metadata.JSONSchema package
  • Module contents
    • Configuration
    • Endpoint View
• pyramid_jsonapi.metadata.OpenAPI package
  • Module contents
    • Configuration

Module contents

This package contains metadata ‘plugin’ modules that provide extra information related to the API being generated, such as documentation, schemas etc.

Such plugins can optionally be offered as pyramid routes and views under the ‘metadata’ endpoint.

class pyramid_jsonapi.metadata.MetaData(api)

Bases: object

Adds routes and views for all metadata modules.

Metadata modules are added by inclusion in the metadata_modules option in settings. Modules should be space or newline separated, and must be installed such that they can be imported by python.

All modules MUST have a class with the same name as the package. This class MAY contain a ‘views’ attribute, which contains a list of ‘VIEWS’ namedtuple instances, which will be converted into pyramid routes and views.

make_routes_views()

Generate routes and views for plugin modules.

pyramid_jsonapi.metadata.VIEWS

alias of pyramid_jsonapi.metadata.Views