Codebase list python-faraday / master doc / reference.rst
master

Tree @master (Download .tar.gz)

reference.rst @master — view markup · raw · history · blame

API Reference

Generic views

Use this ones to expose API endpoints that don't depend of a workspace, such as users, vuln templates, or the workspaces API itself

System Message: INFO/1 (<string>, line 10)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 10)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.GenericView
    :members: model_class,schema_class,route_prefix,base_args,representations,
              lookup_field,lookup_field_type,get_joinedloads, get_undefer,
              _get_schema_class, _get_lookup_field, _validate_object_id,
              _get_base_query, _get_eagerloaded_query, _filter_query,
              _get_object, _dump, _parse_data, register

    :private-members:

System Message: INFO/1 (<string>, line 19)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 19)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.ListMixin
    :members: _envelope_list,_get_order_field,_paginate

System Message: INFO/1 (<string>, line 22)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 22)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.RetrieveMixin

System Message: INFO/1 (<string>, line 23)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 23)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.SortableMixin

System Message: INFO/1 (<string>, line 24)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 24)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.ReadOnlyView

System Message: INFO/1 (<string>, line 25)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 25)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.CreateMixin
    :members: _perform_create

System Message: INFO/1 (<string>, line 27)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 27)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.UpdateMixin
    :members: _update_object, _perform_update

System Message: INFO/1 (<string>, line 30)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 30)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.DeleteMixin

System Message: INFO/1 (<string>, line 31)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 31)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.ReadWriteView

Generic workspaced views

Use this type of views to make workspace-sensitive API endpoints. All views created by this class need the user to specify a valid workspace name in the URL.

This is the most common type of views in Faraday.

System Message: INFO/1 (<string>, line 42)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 42)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.GenericWorkspacedView

System Message: INFO/1 (<string>, line 43)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 43)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.ListWorkspacedMixin

System Message: INFO/1 (<string>, line 44)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 44)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.RetrieveWorkspacedMixin

System Message: INFO/1 (<string>, line 45)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 45)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.ReadWriteWorkspacedView

System Message: INFO/1 (<string>, line 46)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 46)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.CreateWorkspacedMixin
    :members: _perform_create

System Message: INFO/1 (<string>, line 49)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 49)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.UpdateWorkspacedMixin
    :members: _update_object, _perform_update

System Message: INFO/1 (<string>, line 52)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 52)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.DeleteWorkspacedMixin

System Message: INFO/1 (<string>, line 53)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 53)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.CountWorkspacedMixin

System Message: INFO/1 (<string>, line 54)

No directive entry for "autoclass" in module "docutils.parsers.rst.languages.en". Trying "autoclass" as canonical directive name.

System Message: ERROR/3 (<string>, line 54)

Unknown directive type "autoclass".

.. autoclass:: server.api.base.ReadWriteWorkspacedView