Skip to content

Latest commit

 

History

History
86 lines (65 loc) · 2.65 KB

glossary.rst

File metadata and controls

86 lines (65 loc) · 2.65 KB
Raw

Glossary

.. glossary::

    Kinto-Core HTTP API
        A system of rules that explains the way to interact with the HTTP API
        :term:`endpoints` (utilities, synchronization, headers etc.), and how data
        is organized (JSON responses etc.).

    CRUD
        Acronym for Create, Read, Update, Delete

    endpoint
    endpoints
        An endpoint handles a particular HTTP verb at a particular URL.

    extensible
        «Extensible» means that the component behaviour can be overriden via
        lines of code. It differs from «:term:`pluggable`».

    Firefox Accounts
        Account account system run by Mozilla (https://accounts.firefox.com).

    HTTP API
        Multiple publicly exposed endpoints that accept HTTP requests and
        respond with the requested data, in the form of JSON.

    KISS
        «Keep it simple, stupid» is a design priciple which states that most
        systems work best if they are kept simple rather than made complicated.

    pluggable
        «Pluggable» means that the component can be replaced via configuration.
        It differs from «:term:`extensible`».

    resource
        A resource is a collection of records. A resource has two URLs, one for
        the collection and one for individual records.

    user id
    user identifier
    user identifiers
        A string that identifies a user. When using the built-in *Basic Auth*
        authentication, *Kinto-Core* uses cryptography (HMAC) to generate an
        identification string.

        See `Pyramid authentication`_.

    object
    objects
        Also refered as «records», objects are stored by *Kinto-Core* resources.

    tombstone
    tombstones
        When a record is deleted in a resource, a tombstone is created to keep
        track of the deletion when polling for changes. A tombstone only contains
        the ``id`` and ``last_modified`` fields, everything else is really deleted.

    principal
    principals
        An entity that can be authenticated. Principals can be individual people,
        computers, services, or any group of such things.

    permission
    permissions
        An action that can be authorized or denied. read, write, create are
        permissions.

    Semantic Versioning
        A standard MAJOR.MINOR.PATCH versioning scheme.
        See http://semver.org/.

    ACE
    ACEs
    Access Control Entity
        An association of a principal, an object and a permission. For instance,
        (Alexis, article, write).

    ACL
    ACLs
    Access Control List
        A list of Access Control Entities (ACE).