API
  • API Index
  • Batch API
  • Content Negotiation
  • Dynamic Paths
  • Hierarchy API
  • List API
  • Quick Reference
  • Time Series API
  • Views
      • Configuration
  • Overview
  • Application Configuration
  • Documentation Configuration
  • Spec Configuration
      • Features
  • API Testing
  • Asynchronous Processing
  • Cassandra Time-Series Engine
  • Cassandra Integration
  • Default Controller Customisation
  • Documentation
  • Geospatial Filtering
  • Model Documentation
  • PostgreSQL Integration
  • Excel Spreadsheet Format
      • Tutorials
  • Step-by-Step Guide
  • Archetype Setup
  • Logging
  • Prometheus
  • Sentry Logging
      • UI Customisation
  • UI Customisation
  • SASS Build Chain
  • Shared Layout
  • API Documentation
  • Model Documentation
  • Results
    • sapi-nt v current

    Model Documentation

    The model documentation page is automatically generated by sapi-nt, based on the application’s default model spec). It displays information about the classes and properties defined in the model.

    The markup is generated by the model-doc library. You can find the default SASS templates and CSS for this content in the resources directory for the project. The default stylesheet can be overridden by creating a stylesheet of the same name in your sapi-nt resources directory.

    The model documentation page is comprised by the following sections:

    It uses the following common style classes:

    Class Usage
    model-doc The main container for the model documentation content.
    comment A generic class for descriptions of the elements of the model.

    Compact URIs

    The model documentation page renders URIs in their compact, or CURI, form wherever possible. The CURI element itself contains a link to the related documentation for that resource within the model documentation if it exists. In addition, it contains an external link to the URI itself. These CURIs are rendered consistently using common elements and styling.

    Each CURI uses the following style classes:

    Class Usage
    curi A generic element containing a compact URI.
    curi-full A full URI which could not be compacted with the configured prefix mapping.
    curi-compact A compact URI in prefix:name form.
    prefix The prefix part of a compact URI.
    name The name part of a compact URI.
    link The external link to the URI.

    Introduction

    The introduction section contains a brief description of the model.

    It uses the following style classes:

    Class Usage
    intro The introduction section.
    model-name The name of the data model.

    The navigation index contains a list of the main sections of the page, with links to each. In the sapi-nt page template, it is affixed to the side of the main body of the page for easy access.

    It uses the following style classes:

    Class Usage
    nav-index The navigation index section.
    nav-index-item A reference to another section of the model documentation page.

    Class Index

    The class index contains a list of all of the classes described by the data model, and a brief description of each.

    It uses the following style classes:

    Class Usage
    class-index The class index section.
    class-item The index item corresponding to an individual class.
    class-curi The compact URI of a class.

    Class Details

    The class details section contains the full details of each class, including a list of their properties in tabular format.

    It uses the following style classes:

    Class Usage
    classes The class details section.
    class-detail The container for information about an individual class.
    class-heading The heading for a class.
    class-name The name of a class.
    class-uri The compact URI of a class.
    subClassOf The list of super-classes of a class.
    scheme-comment A comment describing the membership of a class in a concept scheme, if it has one.
    property-empty A comment displayed in place of the property table when a class has no associated properties.

    Property Table

    The property table for a particular class displays information about each of the properties of that class. It has columns for the name, description, range, cardinality and uniqueness of each property.

    It uses the following style classes:

    Class Usage
    property-table The table of properties on a class.
    property-name The property name column.
    property-cardinality The property cardinality column.
    property-range The property range column.
    range The range URI for a property.
    scheme A description of the membership of a property’s range in a concept scheme.
    property-unique The property uniqueness column.
    comment The property description column.

    Prefix Mapping

    The prefix mapping section contains a table of the namespace prefix mappings that are specified for the data model. These are represented as a table.

    It uses the following style classes:

    Class Usage
    prefixes The prefix mapping section.

    Prefix Table

    The prefix table has two columns. The left column displays the compact form of each prefix, and the right column displays the full URI. It shares some style classes with the similar table which is rendered in the API documentation.

    It uses the following style clases:

    Class Usage
    prefix-table The table of namespace prefixes and their respective URIs.
    prefix-map-prefix The prefix column.
    prefix-map-uri The URI column.
    default-prefix The default, or empty prefix.