Application-Level Profile Semantics (ALPS)
draft-amundsen-richardson-foster-alps-03

Document Type Active Internet-Draft (individual)
Last updated 2020-08-24
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf htmlized (tools) htmlized bibtex
Additional Resources
- GitHub Repository
- Additional Web Page
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                        M. Amundsen
Internet-Draft
Intended status: Informational                             L. Richardson
Expires: February 25, 2021
                                                               M. Foster
                                                         August 24, 2020

               Application-Level Profile Semantics (ALPS)
                draft-amundsen-richardson-foster-alps-03

Abstract

   This document describes ALPS, a data format for defining simple
   descriptions of application-level semantics, similar in complexity to
   HTML microformats.  An ALPS document can be used as a profile to
   explain the application semantics of a document with an application-
   agnostic media type (such as HTML, HAL, Collection+JSON, Siren,
   etc.).  This increases the reusability of profile documents across
   media types.

Editorial Note (To be removed by RFC Editor)

   Distribution of this document is unlimited.  Comments should be sent
   to the IETF Media-Types mailing list (see
   <https://www.ietf.org/mailman/listinfo/media-types>).

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at https://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on February 25, 2021.

Amundsen, et al.        Expires February 25, 2021               [Page 1]
Internet-Draft     Application-Level Profile Semantics       August 2020

Copyright Notice

   Copyright (c) 2020 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
     1.1.  Notational Conventions  . . . . . . . . . . . . . . . . .   3
     1.2.  Motivation  . . . . . . . . . . . . . . . . . . . . . . .   4
       1.2.1.  Describing Domain-Specific Semantics  . . . . . . . .   4
       1.2.2.  ALPS-based Server Implementations . . . . . . . . . .   4
       1.2.3.  ALPS-based Client Implementations . . . . . . . . . .   4
     1.3.  A Simple ALPS Example . . . . . . . . . . . . . . . . . .   5
     1.4.  Identifying an ALPS Document  . . . . . . . . . . . . . .   9
   2.  ALPS Documents  . . . . . . . . . . . . . . . . . . . . . . .  10
     2.1.  Compliance  . . . . . . . . . . . . . . . . . . . . . . .  10
     2.2.  ALPS Document Properties  . . . . . . . . . . . . . . . .  10
       2.2.1.  'alps'  . . . . . . . . . . . . . . . . . . . . . . .  10
       2.2.2.  'doc' . . . . . . . . . . . . . . . . . . . . . . . .  10
       2.2.3.  'descriptor'  . . . . . . . . . . . . . . . . . . . .  11
       2.2.4.  'ext' . . . . . . . . . . . . . . . . . . . . . . . .  13
       2.2.5.  'format'  . . . . . . . . . . . . . . . . . . . . . .  13
       2.2.6.  'href'  . . . . . . . . . . . . . . . . . . . . . . .  14
       2.2.7.  'id'  . . . . . . . . . . . . . . . . . . . . . . . .  14
       2.2.8.  'link'  . . . . . . . . . . . . . . . . . . . . . . .  16
       2.2.9.  'name'  . . . . . . . . . . . . . . . . . . . . . . .  16
       2.2.10. 'rel' . . . . . . . . . . . . . . . . . . . . . . . .  17
       2.2.11. 'rt'  . . . . . . . . . . . . . . . . . . . . . . . .  17
       2.2.12. 'type'  . . . . . . . . . . . . . . . . . . . . . . .  17
       2.2.13. 'value' . . . . . . . . . . . . . . . . . . . . . . .  18
       2.2.14. 'version' . . . . . . . . . . . . . . . . . . . . . .  18
     2.3.  ALPS Representations  . . . . . . . . . . . . . . . . . .  18
       2.3.1.  Sample HTML . . . . . . . . . . . . . . . . . . . . .  18
       2.3.2.  XML Representation Example  . . . . . . . . . . . . .  19
       2.3.3.  JSON Representation Example . . . . . . . . . . . . .  20
   3.  Applying ALPS documents to Existing Media Types . . . . . . .  22
     3.1.  Linking to ALPS Documents . . . . . . . . . . . . . . . .  23

Amundsen, et al.        Expires February 25, 2021               [Page 2]
Show full document text