OpenSocial Embedded Experience Media Types
draft-snell-embed-document-01.txt

Abstract

An Embedded Experience Document is a component of the OpenSocial Core Gadget Specification. This Internet Draft defines and registers the MIME Media Types for the JSON and XML forms of the Embedded Experience Document.

Status of this Memo

This Internet-Draft is submitted to IETF 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 http://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 21, 2012.

Copyright Notice

Copyright (c) 2011 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 (http://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.

Table of Contents

• 1. Introduction
• 2. Notational Conventions
• 3. Embedded Experience XML Documents
• 4. Embedded Experience JSON Documents
• 5. Security Considerations
• 6. IANA Considerations
• 7. References
• Author's Address

1. Introduction

An Embedded Experience Document is a component of the OpenSocial Core Gadget Specification as defined in section C.15 of [OpenSocial]. This Internet Draft defines and registers the MIME Media Types for the JSON and XML forms of the Embedded Experience Document.

2. Notational Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14, [RFC2119]

3. Embedded Experience XML Documents

An Embedded Experience Document, when serialized as XML 1.0, can be identified with the following media type:

   Type name: application
   Subtype name: embed+xml
   Required parameters: None.
   Optional parameters:
     "charset": This parameter has smantics identical
       to the charset parameter of the "application/xml"
       media type as specified in [RFC3023].
   Encoding considerations:
     Identical to those of "application/xml" as described 
     in [RFC3023], Section 3.2.
   Security considerations:
     As defined in this specification. In addition, as this 
     media type uses the "+xml" convention, it shares the 
     same security considerations as described in [RFC3023], 
     Section 10.
   Interoperability considerations:
     There are no known interoperability issues.
   Published specification:
     This specification.
   Applications that use this media type:
     OpenSocial 2.0 (http://opensocial.org)
     Apache Shindig (http://shindig.apache.org)
   Additional information:
     Magic number(s):
       As specified for "application/xml" in [RFC3023],
       Section 3.2.
     File extension(s):
       .embed
     Macintosh file type code(s):
       TEXT
   Person & email address to contact for further information:
     James M Snell (jasnell@us.ibm.com)
   Intended usage:
     COMMON
   Restrictions on usage:
     None
   Author:
     James M Snell (jasnell@us.ibm.com)     
   Change controller:
     IESG
 

4. Embedded Experience JSON Documents

An Embedded Experience Document, when serialized as JSON, can be identified with the following media type:

   Type name: 
     application
   Subtype name: 
     embed+json
   Required parameters: 
     None.
   Optional parameters:
     None.
   Encoding considerations:
     Identical to those of "application/json" as described 
     in [RFC4627], Section 6.
   Security considerations:
     As defined in this specification. In addition, as 
     this media type uses the "+json" convention, it 
     shares the same security considerations as described 
     in [RFC4627], Section 6.
   Interoperability considerations:
     There are no known interoperability issues.
   Published specification:
     This specification.
   Applications that use this media type:
     OpenSocial 2.0 (http://opensocial.org)
     Apache Shindig (http://shindig.apache.org)
   Additional information:
     Magic number(s):
       As specified for "application/json" in [RFC4627],
       Section 6.
     File extension(s):
       .embed
     Macintosh file type code(s):
       TEXT
   Person & email address to contact for further information:
     James M Snell (jasnell@us.ibm.com)
   Intended usage:
     COMMON
   Restrictions on usage:
     None
   Author:
     James M Snell (jasnell@us.ibm.com)     
   Change controller:
     IESG

5. Security Considerations

As specified within the OpenSocial Core Gadget Specification, section C.15.5.

6. IANA Considerations

IANA is asked to register the two MIME media types defined in Section 3 and Section 4.

7. References

Author's Address