BonFIRE logo and link to main BonFIRE site

Table Of Contents

Previous topic

BonFIRE API Specification

Next topic

Testbed Specificities

This Page

Media Type

A Media Type (also called MIME Type, or Content-Type) is an identifier for file formats on the Internet. When a Client (we’ll call it a User-Agent in the rest of the documentation) receives an HTTP response from a Server, it needs to know the content-type of the response to be able to interpret it, and make use of it. For instance, your browser knows how to deal with formats such as text/html (HTML source file), image/jpeg (JPEG Image), application/pdf (PDF Document), etc.

The Media Type we are using in BonFIRE is a custom type called BonFIRE+XML, identified by the application/vnd.bonfire+xml Media Type. As the name implies, it is based on the XML format, but application/vnd.bonfire+xml payloads have elements and attributes with specific semantics that we’ll describe below.

A User-Agent that knows about these specifics will then be able to handle that kind of payloads, and interact with the BonFIRE API.

Elements

Please refer to the XML Schema Definition file.

Attributes

Please refer to the XML Schema Definition file.

Extensibility

This document describes the BonFIRE+XML markup vocabulary. Markup from other vocabularies (“foreign markup”) can be used in a BonFIRE+XML document. Any extensions to the BonFIRE+XML vocabulary MUST not redefine any elements, attributes, or link relations defined in this document. Clients that do not recognize extensions to the BonFIRE+XML vocabulary SHOULD ignore them.

The details of designing and implementing BonFIRE+XML is beyond the scope of this document.

Note

It is possible that future forward-compatible modifications to this specification will include new elements, attributes, and link-relations. Extension designers should take care to prevent future modifications from breaking or redefining those extensions. The safest way to do this is to use a unique XML Namespace for each extension.