Invenio-Records-REST¶

https://img.shields.io/github/license/inveniosoftware/invenio-records-rest.svg https://github.com/inveniosoftware/invenio-records-rest/workflows/CI/badge.svg https://img.shields.io/coveralls/inveniosoftware/invenio-records-rest.svg https://img.shields.io/pypi/v/invenio-records-rest.svg

REST API for Invenio-Records.

Further documentation is available on https://invenio-records-rest.readthedocs.io/.

User’s Guide¶

This part of the documentation will show you how to get started in using Invenio-Records-REST.

  • Installation
  • Configuration
    • RECORDS_REST_DEFAULT_CREATE_PERMISSION_FACTORY()
    • RECORDS_REST_DEFAULT_DELETE_PERMISSION_FACTORY()
    • RECORDS_REST_DEFAULT_LIST_PERMISSION_FACTORY()
    • RECORDS_REST_DEFAULT_LOADERS
    • RECORDS_REST_DEFAULT_READ_PERMISSION_FACTORY()
    • RECORDS_REST_DEFAULT_RESULTS_SIZE
    • RECORDS_REST_DEFAULT_SORT
    • RECORDS_REST_DEFAULT_UPDATE_PERMISSION_FACTORY()
    • RECORDS_REST_ENDPOINTS
    • RECORDS_REST_FACETS
    • RECORDS_REST_SORT_OPTIONS
  • Usage
    • Basics
    • Initialization
    • Configuration
    • Searching
    • Serialization
    • Tombstones and redirection
    • Access control
    • Deserialization

API Reference¶

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

  • API Docs
    • InvenioRecordsREST
    • Facets
    • Sorter
    • Links
    • Query
    • Serializers
    • Loaders
    • Schemas
    • Utils
    • Errors
    • Views
    • Permissions

Additional Notes¶

Notes on how to contribute, legal information and changes are here for the interested.

  • Contributing
  • Changes
  • License
  • Contributors

Invenio-Records-REST

REST API for invenio-records.

Navigation

  • Installation
  • Configuration
  • Usage
  • API Docs
  • Contributing
  • Changes
  • License
  • Contributors

  • invenio-records-rest@GitHub
  • invenio-records-rest@PyPI

Related Topics

  • Documentation overview
    • Next: Installation

Quick search

©2017, CERN. | Page source
Fork me on GitHub