centurion-ui
    Preparing search index...

    Interface apiMetadata

    API metadata is provided by the backend and must be accessible via the URL used to access the backend in question. This object is obtained via a HTTP/OPTIONS request and must be returned as a JSON object that matches this interface.

    0.1.0

    interface apiMetadata {
        allowed_methods: [
            "DELETE"?,
            "GET"?,
            "HEAD"?,
            "PATCH"?,
            "POST"?,
            "PUT"?,
            "OPTIONS"?,
        ];
        description: string;
        documentation: String;
        fields: fieldRelationship[];
        layout: UILayout;
        name: string;
    }

    Hierarchy (View Summary)

    Index
    allowed_methods description documentation fields layout name
    allowed_methods: [
        "DELETE"?,
        "GET"?,
        "HEAD"?,
        "PATCH"?,
        "POST"?,
        "PUT"?,
        "OPTIONS"?,
    ]

    Allowed HTTP methods.

    The backend should update these as per the users permissions.

    description: string

    Value to use as the page description

    0.5.0

    documentation: String

    Link to the documentation pertaining to this endpoint.

    0.5.0

    fields: fieldRelationship[]

    Description of the backend fields

    layout: UILayout

    Type Declaration

    name: string

    Value to use as the page title.

    0.5.0

    Settings
    Member Visibility

    On This Page
    Properties