BrowserCompat API

The Browser Compatibility API will support compatibility data on the Mozilla Developer Network. This currently takes the form of browser compatibility tables, such as the one on the CSS display property page. The API will centralize this data, and allow it to be kept consistent across languages and presentations.

The project started in December 2013. The initial goals and requirements are documented on the MozillaWiki.

Status

The beta v1 API is being served at https://browsercompat.herokuapp.com/api/v1/. Alpha users are using the importer to find and fix data issues on MDN. A small number of pages on MDN have been converted to use API-backed compatibility tables. Beta users can view the new tables, and non-beta users see the traditional wiki-backed tables. As the beta is expanded to more pages and more users, the API is changed to handle new use cases. See the issues page for details of planned changes.

The v1 API uses release candidate 1 (RC1) of the JSON API specification, which was released July 2014, but is currently undocumented. See the v1 API docs for details of the API implementation.

Development

Code:

https://github.com/mdn/browsercompat

Server:

https://browsercompat.herokuapp.com (based on mdn/browsercompat-data)

Issues:

https://bugzilla.mozilla.org/buglist.cgi?quicksearch=compat-data (tracking bug)

https://bugzilla.mozilla.org/showdependencytree.cgi?id=996570&hide_resolved=1 (blocking issues for v1)

Dev Docs:

https://browsercompat.readthedocs.org

https://github.com/mdn/browsercompat/wiki

Mailing list:

https://lists.mozilla.org/listinfo/dev-mdn

IRC:

irc://irc.mozilla.org/mdndev

Contents:

Installation

Install Django Project

For detailed local installation instructions, including OS-specific instructions, see the Installation page on the wiki.

1. Install system packages and libraries. The required packages are Python (2.7, 3.4, or both), pip (latest), and virtualenv (latest). To match production and for a smooth installation of Python packages, install PostgreSQL (9.2 or later recommended) and Memcached (latest). virtualenvwrapper and autoenv will make your development life easier.
2. Optionally, provision a PostgreSQL database, recommended to match production. The default Django database settings will use a SQLite database named db.sqlite3.
3. Optionally, run Redis or Memcached for improved read performance (production uses Redis for caching and for the Celery backend) The default settings will run without a cache or asynchronous tasks.
4. Clone project locally.
5. Create a virtualenv.
6. Install dependencies with pip install -r requirements.txt -r requirements-dev.txt.
7. Customize the configuration with environment variables. See wpcsite/settings.py and env.dist for advice and available settings.
8. Initialize the database and a superuser account with ./manage.py migrate.
9. Verify that tests pass with ./manage.py test or make test.
10. Run it with ./manage.py runserver or ./manage.py runserver_plus.

Install in Heroku

Heroku allows you to quickly deploy browsercompat. Heroku hosts the beta version of the service at https://browsercompat.herokuapp.com, using the add-ons:

• heroku-postgresql (hobby-basic tier, $9/month, required for size of dataset)
• memcachier (free dev tier)
• heroku-redis (free hobby-dev tier)
• Mozilla’s New Relic account (Heroku New Relic available, including free Wayne tier)

For more details of the beta server, see Beta Server on the github wiki.

To deploy with Heroku, you’ll need to signup for a free account and install the Heroku Toolbelt. Then you can:

1. Clone project locally
2. heroku apps:create
3. git push heroku master
4. See the current config with heroku config, and then customize with environment variables using heroku config:set (see wpcsite/settings.py and env.dist)
5. Add superuser account (heroku run ./manage.py createsuperuser)

Configuring authentication

The project uses django-allauth as a framework for local and social authentication. The public service uses username and password for local authentication, and Firefox Accounts (FxA) for social authentication.

django-allauth supports multiple emails per user, with one primary email used for communication. Email addresses are validated by sending a confirmation link. For a public server, you’ll need to configure Django to send email, by configuring your mail server and setting environment variables. For local development, it is easiest to print emails to the console:

export EMAIL_BACKEND="django.core.mail.backends.console.EmailBackend"

django-allauth supports many social authentication providers. See the providers documentation for the current list and hints for configuration. Using an authentication provider is not required, especially for local development. Instead, use local authentication with a username and password.

If you need FxA integration, see the Firefox Accounts page on the wiki for install hints.

Load Data

There are several ways to get data into your API:

1. Load data from the github export
2. Load data from another browsercompat server
3. Load sample data from the WebPlatform project and MDN

Load from GitHub

The data on browsercompat.herokuapp.com is archived in the browsercompat-data github repo, and this is the fastest way to get data into your empty API:

1. Clone the github repo (git clone https://github.com/mdn/browsercompat-data.git)
2. Run the API (./manage.py runserver)
3. Import the data (tools/upload_data.py --data /path/to/browsercompat-data/data)

Load from another browsercompat server

If you have read access to a browsercompat server that you’d like to clone, you can grab the data for your own server.

1. Download the data (tools/download_data.py --api https://browsercompat.example.com)
2. Run the API (./manage.py runserver)
3. Import the data (tools/upload_data.py)

Load Sample Data

The WebPlatform project imported data from MDN, and stored the formatted compatibility data in a github project. There is a lot of data that was not imported, so it’s not a good data source for re-displaying on MDN. However, combining this data with specification data from MDN will create a good data set for testing the API at scale.

To load sample data:

1. Run the API (./manage.py runserver)
2. Load a subset of the WebPlatform data (tools/load_webcompat_data.py) or full set of data (tools/load_webcompat.py --all-data)
3. Load specification data (tools/load_spec_data.py)

Contributing

Contributions should follow the MDN Contribution Guidelines, and follow the standards of this project:

• You agree to license your contributions under MPL 2

• Discuss large changes on the dev-mdn mailing list or on a bugzilla bug before coding.

• Code should follow Python and JavaScript standards.

  • Python code style should conform to PEP8 standards, as well as PEP257 standards for documentation strings.
  • JavaScript code should follow the conventions of jslint.
  • Code can be checked locally with make lint, which must pass before a pull request will be considered.

• All commit messages must start with “bug NNNNNNN” or “fix bug NNNNNNN”

  • Reason: This makes it possible to read the commit log and find the bug that includes the original request and design conversation for all changes.
  • Exceptions: “Merge” and “Revert” commits
  • “fix bug NNNNNNN” - will trigger a github bot to automatically mark the bugzilla bug as “RESOLVED:FIXED”
  • Multiple commits are allowed, and authors are encouraged to split, merge, and rearrange commits in feature branches to make code review easier. Each commit must start with the “bug” or “fix bug” prefix.

• MDN module owner or peer must review and merge all pull requests.

  • Reason: Owner and peers are accountable for the quality of MDN code changes
  • Exceptions: Owners/peers may commit directly to master for critical security/down-time fixes; they must file a bug for follow-up review.

• MDN reviewers must verify 100% test coverage on all changes.

  • Reason: Automated tests reduce human error involved in reviews, and allow radical refactoring of the code.
  • Notes: The Django site has good testing docs, and Django REST framework has some additonal testing docs.
  • Coverage can be checked locally with make coverage.

What to work on

There is a tracking bug for this project, and a specific bug for the data store, the primary purpose of this project. The dependent bugs represent areas of work, and are not exhaustive. If you want to contribute at this phase in development, take a look at the bugs and linked documents, to familiarize yourself with the project, and then get in touch with the team on IRC (#mdndev or #browsercompat on irc.mozilla.org) to carve out a piece of the project.

GitHub workflow

1. Get your environment setup

2. Set up mozilla remote ($ git remote add mozilla git://github.com/mdn/browsercompat.git)

3. Create a branch for a bug ($ git checkout -b new-issue-888888)

4. Develop on bug branch.

   Time passes, the mdn/browsercompat repository accumulates new commits

5. Commit changes to bug branch ($ git add . ; git commit -m 'fix bug 888888 - commit message')

6. Fetch mozilla ($ git fetch mozilla)

7. Update local master ($ git checkout master; git pull mozilla master)

   Repeat steps 4-7 till dev is complete

8. Rebase issue branch ($ git checkout new-issue-888888; git rebase master)

9. Push branch to GitHub ($ git push origin new-issue-888888)

10. Issue pull request (Click Pull Request button)

Technologies

The technologies used to implement the API include:

• Django, a web framework
• Django REST Framework, an API framework
• django-simple-history, for recording changes to models
• django-mptt, for efficiently storing hierarchical data
• django-oauth2-provider, for script-based updates of content

See the source code for a detailed list.

Entrypoints

A developer-centered website is available at https://browserscompat.herokuapp.com/. This site includes

• /api/v1 - The legacy v1 API, conforming to the deprecated JSON API RC1 specification.
• /api/v2 - The current v2 API, conforming to the JSON API v1.0 specification.
• /browse - A data browser.
• /importer - A tool for scraping and validating data from MDN.

The APIs support two representations:

application/vnd.api+json (default)

JSON in the JSON API format.

text/html

The Django REST Framework browsable API.

The API supports user accounts with password and/or Persona authentication.

v1 BrowserCompat API

The v1 API was designed to store and maintain information about web technologies, such as HTML and CSS, in the manner used on MDN. This takes the form of Specification tables, which detail the specifications for technologies, and Browser Compatibility tables, which detail when browsers implemented those technologies. A simple example is for the HTML element <address>. A more complex example is the CSS property display.

The v1 API was designed in March 2014, and implemented over the next year. It was allowed to be partially implemented, and labeled as “draft”, so that the design could be modified as new problems were discovered. The API as designed is mostly implemented as of December 2015, but further changes will be made to the v1 API in 2016. See the issues page for details.

The v1 API was based on release candidate 1 (RC1) of the JSON API specification, which was released 2014-07-05. Starting with RC2 on 2015-02-18, The JSON API team rapidly iterated on the design, making significant changes informed by the experience of implementors. JSON API v1.0 was released May 2015, and is significantly different from RC1. The JSON API team does not preserve documentation for release candidates (online or with a git tag), so it is impossible to refer to the documentation for RC1.

v1 will remain on JSON API RC1. The next version of the API, v2, will support JSON API 1.0. Both the v1 and v2 APIs will be supported until the tools are updated, and then the v1 API will be retired.

Resources

Resources are simple objects supporting CRUD operations. Read operations can be done anonymously. Creating and updating require account permissions, and deleting requires admin account permissions.

All resources support similar operations using HTTP methods:

• GET /api/v1/<type> - List or search instances (paginated)
• POST /api/v1/<type> - Create a new instance
• GET /api/v1/<type>/<id> - Retrieve an instance
• PUT /api/v1/<type>/<id> - Update an instance
• DELETE /api/v1/<type>/<id> - Delete an instance

Because the operations are similar, only browsers has complete examples, and others just show retrieving an instance (GET /api/v1/<type>/<id>). Full requests and responses are generated and stored in the source repository

Contents

• Resources
  • Browsers
    • List
    • Retrieve by ID
    • Retrieve by Slug
    • Create
    • Update
    • Partial Update
    • Update order of related resources
    • Reverting to a previous instance
    • Deletion
    • Reverting a deletion
  • Versions
  • Features
  • Supports
  • Specifications
  • Sections
  • Maturities

Browsers

A browser is a brand of web client that has one or more versions. This follows most users’ understanding of browsers, i.e., firefox_desktop represents desktop Firefox, safari_desktop represents desktop Safari, and firefox_android represents Firefox on Android.

The browsers representation includes:

• attributes

  • id (server selected) - Database ID
  • slug (write-once) - Unique, human-friendly slug
  • name (localized) - Browser name
  • note (localized) - Notes, intended for related data like OS, applicable device, engines, etc.

• links

  • versions (many) - Associated versions, ordered roughly from earliest to latest. User can change the order.
  • history_current (one) - Current historical_browsers. Can be set to a value from history to revert changes.
  • history (many) - Associated historical_browsers in time order (most recent first). Changes are ignored.

Note: bug 1078699 is proposing that select users will be able to modify slugs

List

To request the paginated list of browsers:

GET /api/v1/browsers HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": [
        {
            "id": "1",
            "slug": "android",
            "name": {
                "en": "Android Browser"
            },
            "note": null,
            "links": {
                "versions": [
                    "1",
                    "2",
                    "3"
                ],
                "history_current": "1",
                "history": [
                    "1"
                ]
            }
        },
        {
            "id": "2",
            "slug": "android_webview",
            "name": {
                "en": "Android Webview"
            },
            "note": null,
            "links": {
                "versions": [
                    "4"
                ],
                "history_current": "2",
                "history": [
                    "2"
                ]
            }
        },
        {
            "id": "3",
            "slug": "blackberry",
            "name": {
                "en": "BlackBerry Browser"
            },
            "note": null,
            "links": {
                "versions": [
                    "5",
                    "6",
                    "7"
                ],
                "history_current": "3",
                "history": [
                    "3"
                ]
            }
        },
        {
            "id": "4",
            "slug": "chrome_desktop",
            "name": {
                "en": "Chrome for Desktop"
            },
            "note": null,
            "links": {
                "versions": [
                    "8",
                    "9",
                    "10"
                ],
                "history_current": "4",
                "history": [
                    "4"
                ]
            }
        },
        {
            "id": "5",
            "slug": "chrome_for_android",
            "name": {
                "en": "Chrome for Android"
            },
            "note": null,
            "links": {
                "versions": [
                    "11",
                    "12",
                    "13"
                ],
                "history_current": "5",
                "history": [
                    "5"
                ]
            }
        },
        {
            "id": "6",
            "slug": "firefox_android",
            "name": {
                "en": "Firefox for Android"
            },
            "note": null,
            "links": {
                "versions": [
                    "14",
                    "15",
                    "16"
                ],
                "history_current": "6",
                "history": [
                    "6"
                ]
            }
        },
        {
            "id": "7",
            "slug": "firefox_desktop",
            "name": {
                "en": "Firefox for Desktop"
            },
            "note": null,
            "links": {
                "versions": [
                    "17",
                    "18",
                    "19",
                    "20",
                    "21"
                ],
                "history_current": "7",
                "history": [
                    "7"
                ]
            }
        },
        {
            "id": "8",
            "slug": "firefox_os",
            "name": {
                "en": "Firefox OS"
            },
            "note": null,
            "links": {
                "versions": [
                    "22",
                    "23",
                    "24"
                ],
                "history_current": "8",
                "history": [
                    "8"
                ]
            }
        },
        {
            "id": "9",
            "slug": "ie_desktop",
            "name": {
                "en": "Internet Explorer for Desktop"
            },
            "note": null,
            "links": {
                "versions": [
                    "25",
                    "26",
                    "27",
                    "28",
                    "29"
                ],
                "history_current": "9",
                "history": [
                    "9"
                ]
            }
        },
        {
            "id": "10",
            "slug": "ie_mobile",
            "name": {
                "en": "Internet Explorer Mobile"
            },
            "note": null,
            "links": {
                "versions": [
                    "30",
                    "31",
                    "32"
                ],
                "history_current": "10",
                "history": [
                    "10"
                ]
            }
        }
    ],
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    },
    "meta": {
        "pagination": {
            "browsers": {
                "previous": null,
                "next": "https://browsercompat.org/api/v1/browsers?page=2",
                "count": 15
            }
        }
    }
}

Retrieve by ID

Note: bug 1230306 is proposing switching IDs to UUIDs.

To request a single browser with a known ID:

GET /api/v1/browsers/7 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "7",
        "slug": "firefox_desktop",
        "name": {
            "en": "Firefox for Desktop"
        },
        "note": null,
        "links": {
            "versions": [
                "17",
                "18",
                "19",
                "20",
                "21"
            ],
            "history_current": "7",
            "history": [
                "7"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

Retrieve by Slug

Note: bug 1078699 is proposing an alternate URL format.

To request a browser by slug:

GET /api/v1/browsers?slug=firefox_desktop HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

The response includes the desired browser, in list format:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": [
        {
            "id": "7",
            "slug": "firefox_desktop",
            "name": {
                "en": "Firefox for Desktop"
            },
            "note": null,
            "links": {
                "versions": [
                    "17",
                    "18",
                    "19",
                    "20",
                    "21"
                ],
                "history_current": "7",
                "history": [
                    "7"
                ]
            }
        }
    ],
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    },
    "meta": {
        "pagination": {
            "browsers": {
                "previous": null,
                "next": null,
                "count": 1
            }
        }
    }
}

Create

Creating browser instances require authentication with create privileges. To create a new browser instance, POST a representation with at least the required parameters. Some items (such as the id attribute and the history_current link) will be picked by the server, and will be ignored if included.

Here’s an example of creating a browser instance, with cookie-based authentication:

POST /api/v1/browsers HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 132
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "browsers": {
        "slug": "amazon-silk-mobile",
        "name": {
            "en": "Amazon Silk Mobile"
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "16",
        "slug": "amazon-silk-mobile",
        "name": {
            "en": "Amazon Silk Mobile"
        },
        "note": null,
        "links": {
            "versions": [],
            "history_current": "16",
            "history": [
                "16"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

This, and other methods that change resources, will create a new changeset, and associate the new historical_browsers with that changeset. To assign to an existing changeset, add it to the URI:

POST /api/v1/browsers?changeset=4 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 220
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "browsers": {
        "slug": "nintendo-ds",
        "name": {
            "en": "Nintendo DS Browser",
            "ja": "\u30cb\u30f3\u30c6\u30f3\u30c9\u30fc\uff24\uff33\u30d6\u30e9\u30a6\u30b6"
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "18",
        "slug": "nintendo-ds",
        "name": {
            "en": "Nintendo DS Browser",
            "ja": "ニンテンドーＤＳブラウザ"
        },
        "note": null,
        "links": {
            "versions": [],
            "history_current": "18",
            "history": [
                "18"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

Update

Updating a browser instance require authentication with create privileges. Some items (such as the id attribute and history links) can not be changed, and will be ignored if included. A successful update will return a 200 OK, add a new ID to the history links list, and update the history_current link.

This update changes the English name from “Internet Explorer” to “Microsoft Internet Explorer”:

PUT /api/v1/browsers/9 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 1000
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "browsers": {
        "id": "9",
        "slug": "ie_desktop",
        "name": {
            "en": "Microsoft Internet Explorer"
        },
        "note": null,
        "links": {
            "history": [
                "9"
            ],
            "history_current": "9",
            "versions": [
                "25",
                "26",
                "27",
                "28",
                "29"
            ]
        }
    },
    "links": {
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        }
    }
}

With this response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "9",
        "slug": "ie_desktop",
        "name": {
            "en": "Microsoft Internet Explorer"
        },
        "note": null,
        "links": {
            "versions": [
                "25",
                "26",
                "27",
                "28",
                "29"
            ],
            "history_current": "19",
            "history": [
                "19",
                "9"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

Partial Update

An update can just update the target fields. This is a further request to change the English name for the Internet Explorer browser.

PUT /api/v1/browsers/9 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 78
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "browsers": {
        "name": {
            "en": "IE"
        }
    }
}

With this response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "9",
        "slug": "ie_desktop",
        "name": {
            "en": "IE"
        },
        "note": null,
        "links": {
            "versions": [
                "25",
                "26",
                "27",
                "28",
                "29"
            ],
            "history_current": "20",
            "history": [
                "20",
                "19",
                "9"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

Update order of related resources

In many cases, related resources (which appear in the “links” attribute”) are sorted by ID. In some cases, the order is significant, and is set on a related field. For example, versions for a browser are ordered by updating the order on the browser object:

To change just the versions order:

PUT /api/v1/browsers/9 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 205
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "browsers": {
        "links": {
            "versions": [
                "25",
                "26",
                "27",
                "29",
                "28"
            ]
        }
    }
}

With this response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "9",
        "slug": "ie_desktop",
        "name": {
            "en": "IE"
        },
        "note": null,
        "links": {
            "versions": [
                "25",
                "26",
                "27",
                "29",
                "28"
            ],
            "history_current": "21",
            "history": [
                "21",
                "20",
                "19",
                "9"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

Reverting to a previous instance

To revert to an earlier instance, set the history_current link to a previous value. This resets the content and creates a new historical_browsers object:

PUT /api/v1/browsers/9 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 91
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "browsers": {
        "links": {
            "history_current": "9"
        }
    }
}

With this response (note that the name and version order have reverted to the original values):

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "browsers": {
        "id": "9",
        "slug": "ie_desktop",
        "name": {
            "en": "Internet Explorer for Desktop"
        },
        "note": null,
        "links": {
            "versions": [
                "25",
                "26",
                "27",
                "29",
                "28"
            ],
            "history_current": "22",
            "history": [
                "22",
                "21",
                "20",
                "19",
                "9"
            ]
        }
    },
    "links": {
        "browsers.versions": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{browsers.versions}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        }
    }
}

Deletion

To delete a browser:

DELETE /api/v1/browsers/16 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 0
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

The response has no body:

HTTP/1.1 204 NO CONTENT

Reverting a deletion

Reverting deletions is not currently possible, and is tracked in bug 1159349.

Versions

A version is a specific release of a Browser.

The versions representation includes:

• attributes

  • id (server selected) - Database ID
  • version (write-once) - Version of browser. Numeric or text string, depending on the status (see table below).
  • release_day - Day that browser was released in ISO 8601 format, or null if unknown.
  • retirement_day - Approximate day the browser was “retired” (stopped being a current browser), in ISO 8601 format, or null if unknown.
  • status - One of beta, current, future, retired-beta, retired, or unknown (see table below).
  • release_notes_uri (localized) - URI of release notes for this version, or null if none.
  • note (localized) - Engine, OS, etc. information, or null
  • order (read-only) - The relative order among versions for this browser. The order can be changed on the browser resource.

• links

  • browser - The related browser
  • supports (many) - Associated supports, in ID order. Changes are ignored; work on the supports to add, change, or remove.
  • history_current (one) - Current historical_versions. Set to a value from history to revert to that version.
  • history (many) - Associated historical_versions, in time order (most recent first). Changes are ignored.

The version is either a numeric value, such as "11.0", or text, such as "Nightly". The version format depends on the chosen status:

Status	Version	Meaning
beta	numeric	A release candidate suggested for early adopters or testers
current	numeric or the text "current"	A current and preferred release for most users
future	text such as "Nightly"	A named but unnumbered future release
retired-beta	numeric	An old beta version, replaced by a new beta or release
retired	numeric	An old released version no longer recommended for users
unknown	numeric	A release with an unknown status

To get a single version:

GET /api/v1/versions/21 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "versions": {
        "id": "21",
        "version": "16.0",
        "release_day": "2012-10-09",
        "retirement_day": "2012-11-20",
        "status": "retired",
        "release_notes_uri": {
            "en": "https://developer.mozilla.org/en/Firefox/Releases/16",
            "de": "https://developer.mozilla.org/de/Firefox/Releases/16",
            "es": "https://developer.mozilla.org/es/Firefox/Releases/16",
            "fr": "https://developer.mozilla.org/fr/Firefox/Versions/16",
            "ja": "https://developer.mozilla.org/ja/Firefox/Releases/16",
            "ko": "https://developer.mozilla.org/ko/Firefox/Releases/16",
            "pl": "https://developer.mozilla.org/pl/Firefox/Releases/16",
            "pt-PT": "https://developer.mozilla.org/pt-PT/Firefox/Releases/16",
            "ru": "https://developer.mozilla.org/ru/Firefox/Releases/16",
            "zh-CN": "https://developer.mozilla.org/zh-CN/Firefox/Releases/16",
            "zh-TW": "https://developer.mozilla.org/zh-TW/Firefox/Releases/16"
        },
        "note": null,
        "order": 4,
        "links": {
            "browser": "7",
            "supports": [
                "12",
                "22"
            ],
            "history_current": "21",
            "history": [
                "21"
            ]
        }
    },
    "links": {
        "versions.browser": {
            "type": "browsers",
            "href": "https://browsercompat.org/api/v1/browsers/{versions.browser}"
        },
        "versions.supports": {
            "type": "supports",
            "href": "https://browsercompat.org/api/v1/supports/{versions.supports}"
        },
        "versions.history_current": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{versions.history_current}"
        },
        "versions.history": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{versions.history}"
        }
    }
}

Features

A feature is a web technology. This could be a precise technology, such as the value cover for the CSS background-size property. It could be a hierarchical group of related technologies, such as the CSS background-size property or the set of all CSS properties. Some features correspond to a page on MDN, which will display the list of specifications and a browser compatibility table of the sub-features.

The features representation includes:

• attributes

  • id (server selected) - Database ID
  • slug (write-once) - Unique, human-friendly slug
  • mdn_uri (optional, localized) - The URI of the language-specific MDN page that this feature was first scraped from. If the path contains unicode, it should be percent-encoded as in RFC 3987. May be used in UX or for debugging import scripts.
  • experimental - True if a feature is considered experimental, such as being non-standard or part of an non-ratified spec.
  • standardized - True if a feature is described in a standards-track spec, regardless of the spec’s maturity.
  • stable - True if a feature is considered suitable for production websites.
  • obsolete - True if a feature should not be used in new development.
  • name (canonical or localized) - Feature name. If the name is the code used by a developer, then the value is a string, and should be wrapped in a <code> block when displayed. If the name is a description of the feature, then the value is the available translations, including at least an en translation, and may include HTML markup. For example, "display" and "display: none" are canonical names for the CSS display property and one of the values for that property, while "Basic support", "<code>none, inline</code> and <code>block</code>", and "CSS Properties" are non-canonical names that should be translated.

• links

  • sections (many) - Associated sections. Order can be changed by the user.
  • supports (many) - Associated supports, Order is in ID order, changes are ignored.
  • parent (one or null) - The feature one level up, or null if top-level. Can be changed by user.
  • children (many) - The features that have this feature as parent, in display order. Can be an empty list, for “leaf” features. Can be re-ordered by the user.
  • history_current (one) - Current historical_features. User can set to a valid history to revert to that version.
  • history (many) - Associated historical_features, in time order (most recent first). Changes are ignored.

To get a specific feature (in this case, a leaf feature with a translated name):

GET /api/v1/features/12 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "features": {
        "id": "12",
        "slug": "web-css-transform-three-value-syntax",
        "mdn_uri": null,
        "experimental": false,
        "standardized": true,
        "stable": true,
        "obsolete": false,
        "name": {
            "en": "Three-value syntax",
            "es": "Sintaxis con tres valores",
            "ja": "3-値構文"
        },
        "links": {
            "parent": "10",
            "children": [],
            "sections": [],
            "supports": [
                "20",
                "21",
                "22",
                "23",
                "24",
                "25",
                "26"
            ],
            "history_current": "12",
            "history": [
                "12"
            ]
        }
    },
    "links": {
        "features.parent": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{features.parent}"
        },
        "features.children": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{features.children}"
        },
        "features.sections": {
            "type": "sections",
            "href": "https://browsercompat.org/api/v1/sections/{features.sections}"
        },
        "features.supports": {
            "type": "supports",
            "href": "https://browsercompat.org/api/v1/supports/{features.supports}"
        },
        "features.history_current": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{features.history_current}"
        },
        "features.history": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{features.history}"
        }
    }
}

Here’s an example of a branch feature with a canonical name (the parent of the previous example):

GET /api/v1/features/10 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "features": {
        "id": "10",
        "slug": "web-css-transform-origin",
        "mdn_uri": {
            "en": "https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin",
            "es": "https://developer.mozilla.org/es/docs/Web/CSS/transform-origin",
            "fr": "https://developer.mozilla.org/fr/docs/Web/CSS/transform-origin",
            "ja": "https://developer.mozilla.org/ja/docs/Web/CSS/transform-origin"
        },
        "experimental": false,
        "standardized": true,
        "stable": true,
        "obsolete": false,
        "name": "transform-origin",
        "links": {
            "parent": "2",
            "children": [
                "11",
                "12"
            ],
            "sections": [
                "4"
            ],
            "supports": [],
            "history_current": "10",
            "history": [
                "10"
            ]
        }
    },
    "links": {
        "features.parent": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{features.parent}"
        },
        "features.children": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{features.children}"
        },
        "features.sections": {
            "type": "sections",
            "href": "https://browsercompat.org/api/v1/sections/{features.sections}"
        },
        "features.supports": {
            "type": "supports",
            "href": "https://browsercompat.org/api/v1/supports/{features.supports}"
        },
        "features.history_current": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{features.history_current}"
        },
        "features.history": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{features.history}"
        }
    }
}

Supports

A support is an assertion that a particular Version of a Browser supports (or does not support) a feature.

The support representation includes:

• attributes

  • id (server selected) - Database ID
  • support - Assertion of support of the version for the feature, one of "yes", "no", "partial", or "unknown"
  • prefix - Prefix used to enable support, such as “moz”
  • prefix_mandatory - True if the prefix is required
  • alternate_name - An alternate name associated with this feature, such as "RTCPeerConnectionIdentityEvent"
  • alternate_name_mandatory - True if the alternate name is required
  • requires_config - A configuration string required to enable the feature, such as "media.peerconnection.enabled=on"
  • default_config - The configuration string in the shipping browser, such as "media.peerconnection.enabled=off"
  • protected - True if the feature requires additional steps to enable in order to protect the user’s security or privacy, such as geolocation and the Bluetooth API.
  • note (localized) - Note on support, designed for display after a compatibility table, can contain HTML

• links

  • version (one) - The associated version. Cannot be changed by the user after creation.
  • feature (one) - The associated feature. Cannot be changed by the user after creation. The version and feature combo must be unique.
  • history_current (one) - Current historical_supports. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_supports in time order (most recent first). Changes are ignored.

To get a single support:

GET /api/v1/supports/22 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "supports": {
        "id": "22",
        "support": "yes",
        "prefix": null,
        "prefix_mandatory": false,
        "alternate_name": null,
        "alternate_mandatory": false,
        "requires_config": null,
        "default_config": null,
        "protected": false,
        "note": null,
        "links": {
            "version": "21",
            "feature": "12",
            "history_current": "22",
            "history": [
                "22"
            ]
        }
    },
    "links": {
        "supports.version": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{supports.version}"
        },
        "supports.feature": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{supports.feature}"
        },
        "supports.history_current": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{supports.history_current}"
        },
        "supports.history": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{supports.history}"
        }
    }
}

Specifications

A specification is a standards document that specifies a web technology.

The specification representation includes:

• attributes

  • id (server selected) - Database ID
  • slug - Unique, human-friendly key
  • mdn_key - Key used in the KumaScript macros SpecName and Spec2.
  • name (localized) - Specification name
  • uri (localized) - Specification URI, without subpath and anchor

• links

  • maturity (one) - Associated maturity. Can be changed by the user.
  • sections (many) - Associated sections. The order can be changed by the user.
  • history_current (one) - Current historical_specifications. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_specifications in time order (most recent first). Changes are ignored.

To get a single specification:

GET /api/v1/specifications/2 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "specifications": {
        "id": "2",
        "slug": "css2_1",
        "mdn_key": "CSS2.1",
        "name": {
            "en": "CSS Level 2 (Revision 1)"
        },
        "uri": {
            "en": "http://www.w3.org/TR/CSS2/"
        },
        "links": {
            "maturity": "1",
            "sections": [
                "2"
            ],
            "history_current": "2",
            "history": [
                "2"
            ]
        }
    },
    "links": {
        "specifications.maturity": {
            "type": "maturities",
            "href": "https://browsercompat.org/api/v1/maturities/{specifications.maturity}"
        },
        "specifications.sections": {
            "type": "sections",
            "href": "https://browsercompat.org/api/v1/sections/{specifications.sections}"
        },
        "specifications.history_current": {
            "type": "historical_specifications",
            "href": "https://browsercompat.org/api/v1/historical_specifications/{specifications.history_current}"
        },
        "specifications.history": {
            "type": "historical_specifications",
            "href": "https://browsercompat.org/api/v1/historical_specifications/{specifications.history}"
        }
    }
}

Sections

Note: bug 1216786 is proposing splitting Sections into Sections and References.

A section refers to a specific area of a specification document.

The section representation includes:

• attributes

  • id (server selected) - Database ID
  • number (optional, localized) - The section number
  • name (localized) - Section name
  • subpath (localized, optional) - A subpage (possibly with an #anchor) to get to the subsection in the doc. Can be empty string.
  • note (localized, optional) - Notes for this section

• links

  • specification (one) - The specification. Can be changed by the user.
  • features (many) - The associated features. In ID order, changes are ignored.
  • history_current (one) - Current historical_sections. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_sections in time order (most recent first). Changes are ignored.

To get a single section:

GET /api/v1/sections/3 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "sections": {
        "id": "3",
        "number": {
            "en": "16"
        },
        "name": {
            "en": "The float property"
        },
        "subpath": {
            "en": "#the-float-property"
        },
        "note": {
            "en": "Lots of new values, not all clearly defined yet. Any differences in behavior unrelated to new features are expected to be unintentional; please report."
        },
        "links": {
            "specification": "3",
            "features": [
                "5"
            ],
            "history_current": "3",
            "history": [
                "3"
            ]
        }
    },
    "links": {
        "sections.specification": {
            "type": "specifications",
            "href": "https://browsercompat.org/api/v1/specifications/{sections.specification}"
        },
        "sections.features": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{sections.features}"
        },
        "sections.history_current": {
            "type": "historical_sections",
            "href": "https://browsercompat.org/api/v1/historical_sections/{sections.history_current}"
        },
        "sections.history": {
            "type": "historical_sections",
            "href": "https://browsercompat.org/api/v1/historical_sections/{sections.history}"
        }
    }
}

Maturities

A maturity refers to the maturity of a specification document.

The maturity representation includes:

• attributes

  • id (server selected) - Database ID
  • slug - A human-friendly identifier for this maturity. When applicable, it matches the key in the KumaScript macro Spec2
  • name (localized) - Status name

• links

  • specifications (many) - Associated specifications. In ID order, changes are ignored.
  • history_current (one) - Current historical_maturities. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_maturities in time order (most recent first). Changes are ignored.

To get a single maturity:

GET /api/v1/maturities/1 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "maturities": {
        "id": "1",
        "slug": "REC",
        "name": {
            "en": "Recommendation",
            "de": "Empfehlung",
            "ja": "勧告",
            "ru": "Рекомендация"
        },
        "links": {
            "specifications": [
                "1",
                "2"
            ],
            "history_current": "1",
            "history": [
                "1"
            ]
        }
    },
    "links": {
        "maturities.specifications": {
            "type": "specifications",
            "href": "https://browsercompat.org/api/v1/specifications/{maturities.specifications}"
        },
        "maturities.history_current": {
            "type": "historical_maturities",
            "href": "https://browsercompat.org/api/v1/historical_maturities/{maturities.history_current}"
        },
        "maturities.history": {
            "type": "historical_maturities",
            "href": "https://browsercompat.org/api/v1/historical_maturities/{maturities.history}"
        }
    }
}

Change Control Resources

Change Control Resources help manage changes to resources.

Users

A user represents a person or process that creates, changes, or deletes a resource.

The representation includes:

• attributes

  • id (server selected) - Database ID
  • username - The user’s email or ID
  • created (server selected) - Time that the account was created, in ISO 8601 format.
  • agreement - The version of the contribution agreement the user has accepted. “0” for not agreed, “1” for first version, etc.
  • permissions - A list of permissions. Permissions include "change-resource" (add or change any resource except users or history resources), "delete-resource" (delete any resource) "import-mdn" (setup import of an MDN page)

• links

  • changesets (many) - Associated changesets, in ID order, changes are ignored.

To get a single user representation:

GET /api/v1/users/1 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "users": {
        "id": "1",
        "username": "user",
        "created": "2015-04-20T18:06:48.567514Z",
        "agreement": 0,
        "permissions": [
            "change-resource",
            "delete-resource"
        ],
        "links": {
            "changesets": []
        }
    },
    "links": {
        "users.changesets": {
            "type": "changesets",
            "href": "https://browsercompat.org/api/v1/changesets/{users.changesets}"
        }
    }
}

Note: bug 1159354 proposes this method for retrieving the authenticated user:

GET /api/v1/users/me HTTP/1.1
Host: browsersupports.org
Accept: application/vnd.api+json

Changesets

A changeset collects history resources into a logical unit, allowing for faster reversions and better history display. The changeset can be auto-created through a POST, PUT, or DELETE to a resource, or it can be created independently and specified by adding changeset=<ID> URI parameter (i.e., PUT /browsers/15?changeset=73).

The representation includes:

• attributes

  • id (server selected) - Database ID
  • created (server selected) - When the changeset was created, in ISO 8601 format.
  • modified (server selected) - When the changeset was last modified, in ISO 8601 format.
  • target_resource_type (write-once, optional) - The name of the primary resource for this changeset, for example “browsers”, “versions”, etc.
  • target_resource_id (write-once, optional) - The ID of the primary resource for this changeset.
  • closed - True if the changeset is closed to new changes. Auto-created changesets are auto-closed, and cache invalidation is delayed until manually created changesets are closed.

• links

  • user (one) - The user who initiated this changeset, can not be changed.
  • historical_browsers (many) - Associated historical_browsers, in ID order, changes are ignored.
  • historical_features (many) - Associated historical_features, in ID order, changes are ignored.
  • historical_maturities (many) - Associated historical_maturities, in ID order, changes are ignored.
  • historical_sections (many) - Associated historical_sections, in ID order, changes are ignored.
  • historical_specificationss (many) - Associated historical_specificationss, in ID order, changes are ignored.
  • historical_supports (many) - Associated historical_supports, in ID order, changes are ignored.
  • historical_versions (many) - Associated historical_versions, in ID order, changes are ignored.

To get a single changeset representation:

GET /api/v1/changesets/2 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "changesets": {
        "id": "2",
        "created": "2015-04-20T18:22:47.046692Z",
        "modified": "2015-04-20T18:22:47.056433Z",
        "closed": true,
        "target_resource_type": null,
        "target_resource_id": null,
        "links": {
            "user": "1",
            "historical_browsers": [
                "16"
            ],
            "historical_features": [],
            "historical_maturities": [],
            "historical_sections": [],
            "historical_specifications": [],
            "historical_supports": [],
            "historical_versions": []
        }
    },
    "links": {
        "changesets.user": {
            "type": "users",
            "href": "https://browsercompat.org/api/v1/users/{changesets.user}"
        },
        "changesets.historical_browsers": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{changesets.historical_browsers}"
        },
        "changesets.historical_features": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{changesets.historical_features}"
        },
        "changesets.historical_maturities": {
            "type": "historical_maturities",
            "href": "https://browsercompat.org/api/v1/historical_maturities/{changesets.historical_maturities}"
        },
        "changesets.historical_sections": {
            "type": "historical_sections",
            "href": "https://browsercompat.org/api/v1/historical_sections/{changesets.historical_sections}"
        },
        "changesets.historical_specifications": {
            "type": "historical_specifications",
            "href": "https://browsercompat.org/api/v1/historical_specifications/{changesets.historical_specifications}"
        },
        "changesets.historical_supports": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{changesets.historical_supports}"
        },
        "changesets.historical_versions": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{changesets.historical_versions}"
        }
    }
}

History Resources

History Resources are created when a Resource is created, updated, or deleted. By navigating the history chain, a caller can see the changes of a resource over time.

All history representations are similar, so one example should be enough to determine the pattern.

Historical Browsers

A historical_browser resource represents the state of a browser at a point in time, and who is responsible for that state. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • browsers - The browsers representation at this point in time

• links

  • browser (one) - Associated browser, can not be changed
  • changeset (one) - Associated changeset, can not be changed.

To get a single historical_browsers representation:

GET /api/v1/historical_browsers/7 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "historical_browsers": {
        "id": "7",
        "date": "2015-04-20T18:44:09.905824Z",
        "event": "created",
        "browsers": {
            "id": "7",
            "slug": "firefox_desktop",
            "name": {
                "en": "Firefox for Desktop"
            },
            "note": null,
            "links": {
                "versions": [],
                "history_current": "7"
            }
        },
        "links": {
            "changeset": "1",
            "browser": "7"
        }
    },
    "links": {
        "historical_browsers.changeset": {
            "type": "changesets",
            "href": "https://browsercompat.org/api/v1/changesets/{historical_browsers.changeset}"
        },
        "historical_browsers.browser": {
            "type": "browsers",
            "href": "https://browsercompat.org/api/v1/browsers/{historical_browsers.browser}"
        }
    }
}

Historical Versions

A historical_versions resource represents the state of a version at a point in time, and who is responsible for that representation. See historical_browsers and versions for an idea of the representation.

Historical Features

A historical_features resource represents the state of a feature at a point in time, and who is responsible for that representation. See historical_browsers and features for an idea of the representation.

Historical Sections

A historical_sections resource represents the state of a section at a point in time, and who is responsible for that representation. See historical_browsers and sections for an idea of the representation.

Historical Specifications

A historical_specifications resource represents the state of a specification at a point in time, and who is responsible for that representation. See historical_browsers and specifications for an idea of the representation.

Historical Supports

A historical_supports resource represents the state of a support at a point in time, and who is responsible for that representation. See historical_browsers and supports for an idea of the representation.

Historical Maturities

A historical_maturities resource represents the state of a maturity at a point in time, and who is responsible for that representation. See historical_browsers and maturities for an idea of the representation.

Views

A View is a combination of resources for a particular presentation. It is suitable for anonymous viewing of content. It uses the flexibility of the JSON API specification to include a basket of related resources in a response, but doesn’t use the official method of Inclusion of Related Resources.

View a Feature

This view collects the data for a feature, including the related resources needed to display it on MDN.

Here is a simple example, the view for the CSS property float:

GET /api/v1/view_features/5 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "features": {
        "id": "5",
        "slug": "web-css-float",
        "mdn_uri": {
            "en": "https://developer.mozilla.org/en-US/docs/Web/CSS/float",
            "de": "https://developer.mozilla.org/de/docs/Web/CSS/float",
            "es": "https://developer.mozilla.org/es/docs/Web/CSS/float",
            "ja": "https://developer.mozilla.org/ja/docs/Web/CSS/float",
            "ru": "https://developer.mozilla.org/ru/docs/Web/CSS/float"
        },
        "experimental": false,
        "standardized": true,
        "stable": true,
        "obsolete": false,
        "name": "float",
        "links": {
            "parent": "2",
            "children": [
                "6"
            ],
            "sections": [
                "1",
                "2",
                "3"
            ],
            "supports": [],
            "history_current": "5",
            "history": [
                "5"
            ]
        }
    },
    "links": {
        "features.parent": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{features.parent}"
        },
        "features.children": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{features.children}"
        },
        "features.sections": {
            "type": "sections",
            "href": "https://browsercompat.org/api/v1/sections/{features.sections}"
        },
        "features.supports": {
            "type": "supports",
            "href": "https://browsercompat.org/api/v1/supports/{features.supports}"
        },
        "features.history_current": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{features.history_current}"
        },
        "features.history": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{features.history}"
        },
        "browsers.history_current": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history_current}"
        },
        "browsers.history": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{browsers.history}"
        },
        "versions.browser": {
            "type": "browsers",
            "href": "https://browsercompat.org/api/v1/browsers/{versions.browser}"
        },
        "versions.history_current": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{versions.history_current}"
        },
        "versions.history": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{versions.history}"
        },
        "supports.version": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{supports.version}"
        },
        "supports.feature": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{supports.feature}"
        },
        "supports.history_current": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{supports.history_current}"
        },
        "supports.history": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{supports.history}"
        },
        "maturities.history_current": {
            "type": "historical_maturities",
            "href": "https://browsercompat.org/api/v1/historical_maturities/{maturities.history_current}"
        },
        "maturities.history": {
            "type": "historical_maturities",
            "href": "https://browsercompat.org/api/v1/historical_maturities/{maturities.history}"
        },
        "specifications.maturity": {
            "type": "maturities",
            "href": "https://browsercompat.org/api/v1/maturities/{specifications.maturity}"
        },
        "specifications.history_current": {
            "type": "historical_specifications",
            "href": "https://browsercompat.org/api/v1/historical_specifications/{specifications.history_current}"
        },
        "specifications.history": {
            "type": "historical_specifications",
            "href": "https://browsercompat.org/api/v1/historical_specifications/{specifications.history}"
        },
        "sections.specification": {
            "type": "specifications",
            "href": "https://browsercompat.org/api/v1/specifications/{sections.specification}"
        },
        "sections.history_current": {
            "type": "historical_sections",
            "href": "https://browsercompat.org/api/v1/historical_sections/{sections.history_current}"
        },
        "sections.history": {
            "type": "historical_sections",
            "href": "https://browsercompat.org/api/v1/historical_sections/{sections.history}"
        }
    },
    "linked": {
        "browsers": [
            {
                "id": "1",
                "slug": "android",
                "name": {
                    "en": "Android Browser"
                },
                "note": null,
                "links": {
                    "history_current": "1",
                    "history": [
                        "1"
                    ]
                }
            },
            {
                "id": "2",
                "slug": "android_webview",
                "name": {
                    "en": "Android Webview"
                },
                "note": null,
                "links": {
                    "history_current": "2",
                    "history": [
                        "2"
                    ]
                }
            },
            {
                "id": "4",
                "slug": "chrome_desktop",
                "name": {
                    "en": "Chrome for Desktop"
                },
                "note": null,
                "links": {
                    "history_current": "4",
                    "history": [
                        "4"
                    ]
                }
            },
            {
                "id": "6",
                "slug": "firefox_android",
                "name": {
                    "en": "Firefox for Android"
                },
                "note": null,
                "links": {
                    "history_current": "6",
                    "history": [
                        "6"
                    ]
                }
            },
            {
                "id": "7",
                "slug": "firefox_desktop",
                "name": {
                    "en": "Firefox for Desktop"
                },
                "note": null,
                "links": {
                    "history_current": "7",
                    "history": [
                        "7"
                    ]
                }
            },
            {
                "id": "9",
                "slug": "ie_desktop",
                "name": {
                    "en": "Internet Explorer for Desktop"
                },
                "note": null,
                "links": {
                    "history_current": "22",
                    "history": [
                        "22",
                        "21",
                        "20",
                        "19",
                        "9"
                    ]
                }
            },
            {
                "id": "10",
                "slug": "ie_mobile",
                "name": {
                    "en": "Internet Explorer Mobile"
                },
                "note": null,
                "links": {
                    "history_current": "10",
                    "history": [
                        "10"
                    ]
                }
            },
            {
                "id": "11",
                "slug": "opera_desktop",
                "name": {
                    "en": "Opera for Desktop"
                },
                "note": null,
                "links": {
                    "history_current": "11",
                    "history": [
                        "11"
                    ]
                }
            },
            {
                "id": "14",
                "slug": "safari_desktop",
                "name": {
                    "en": "Safari for Desktop"
                },
                "note": null,
                "links": {
                    "history_current": "14",
                    "history": [
                        "14"
                    ]
                }
            },
            {
                "id": "15",
                "slug": "safari_ios",
                "name": {
                    "en": "Safari for iOS"
                },
                "note": null,
                "links": {
                    "history_current": "15",
                    "history": [
                        "15"
                    ]
                }
            }
        ],
        "versions": [
            {
                "id": "2",
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "1",
                    "history_current": "2",
                    "history": [
                        "2"
                    ]
                }
            },
            {
                "id": "4",
                "version": "current",
                "release_day": null,
                "retirement_day": null,
                "status": "current",
                "release_notes_uri": null,
                "note": null,
                "order": 0,
                "links": {
                    "browser": "2",
                    "history_current": "4",
                    "history": [
                        "4"
                    ]
                }
            },
            {
                "id": "9",
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "4",
                    "history_current": "9",
                    "history": [
                        "9"
                    ]
                }
            },
            {
                "id": "15",
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "6",
                    "history_current": "15",
                    "history": [
                        "15"
                    ]
                }
            },
            {
                "id": "18",
                "version": "1.0",
                "release_day": "2004-11-09",
                "retirement_day": "2005-11-29",
                "status": "retired",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "7",
                    "history_current": "18",
                    "history": [
                        "18"
                    ]
                }
            },
            {
                "id": "26",
                "version": "4.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "9",
                    "history_current": "26",
                    "history": [
                        "26"
                    ]
                }
            },
            {
                "id": "32",
                "version": "6.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 2,
                "links": {
                    "browser": "10",
                    "history_current": "32",
                    "history": [
                        "32"
                    ]
                }
            },
            {
                "id": "34",
                "version": "7.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "11",
                    "history_current": "34",
                    "history": [
                        "34"
                    ]
                }
            },
            {
                "id": "42",
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "14",
                    "history_current": "42",
                    "history": [
                        "42"
                    ]
                }
            },
            {
                "id": "44",
                "version": "5.1",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 3,
                "links": {
                    "browser": "14",
                    "history_current": "44",
                    "history": [
                        "44"
                    ]
                }
            },
            {
                "id": "46",
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1,
                "links": {
                    "browser": "15",
                    "history_current": "46",
                    "history": [
                        "46"
                    ]
                }
            }
        ],
        "supports": [
            {
                "id": "1",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "2",
                    "feature": "6",
                    "history_current": "1",
                    "history": [
                        "1"
                    ]
                }
            },
            {
                "id": "2",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "9",
                    "feature": "6",
                    "history_current": "2",
                    "history": [
                        "2"
                    ]
                }
            },
            {
                "id": "3",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "15",
                    "feature": "6",
                    "history_current": "3",
                    "history": [
                        "3"
                    ]
                }
            },
            {
                "id": "4",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "18",
                    "feature": "6",
                    "history_current": "4",
                    "history": [
                        "4"
                    ]
                }
            },
            {
                "id": "5",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "26",
                    "feature": "6",
                    "history_current": "5",
                    "history": [
                        "5"
                    ]
                }
            },
            {
                "id": "6",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "32",
                    "feature": "6",
                    "history_current": "6",
                    "history": [
                        "6"
                    ]
                }
            },
            {
                "id": "7",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "34",
                    "feature": "6",
                    "history_current": "7",
                    "history": [
                        "7"
                    ]
                }
            },
            {
                "id": "8",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "42",
                    "feature": "6",
                    "history_current": "8",
                    "history": [
                        "8"
                    ]
                }
            },
            {
                "id": "9",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "44",
                    "feature": "6",
                    "history_current": "9",
                    "history": [
                        "9"
                    ]
                }
            },
            {
                "id": "10",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "46",
                    "feature": "6",
                    "history_current": "10",
                    "history": [
                        "10"
                    ]
                }
            },
            {
                "id": "27",
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null,
                "links": {
                    "version": "4",
                    "feature": "6",
                    "history_current": "27",
                    "history": [
                        "27"
                    ]
                }
            }
        ],
        "maturities": [
            {
                "id": "1",
                "slug": "REC",
                "name": {
                    "en": "Recommendation",
                    "de": "Empfehlung",
                    "ja": "勧告",
                    "ru": "Рекомендация"
                },
                "links": {
                    "history_current": "1",
                    "history": [
                        "1"
                    ]
                }
            },
            {
                "id": "2",
                "slug": "WD",
                "name": {
                    "en": "Working Draft",
                    "de": "Arbeitsentwurf",
                    "ja": "草案",
                    "ru": "Рабочий черновик"
                },
                "links": {
                    "history_current": "2",
                    "history": [
                        "2"
                    ]
                }
            }
        ],
        "specifications": [
            {
                "id": "1",
                "slug": "css1",
                "mdn_key": "CSS1",
                "name": {
                    "en": "CSS Level 1"
                },
                "uri": {
                    "en": "http://www.w3.org/TR/CSS1/"
                },
                "links": {
                    "maturity": "1",
                    "history_current": "1",
                    "history": [
                        "1"
                    ]
                }
            },
            {
                "id": "2",
                "slug": "css2_1",
                "mdn_key": "CSS2.1",
                "name": {
                    "en": "CSS Level 2 (Revision 1)"
                },
                "uri": {
                    "en": "http://www.w3.org/TR/CSS2/"
                },
                "links": {
                    "maturity": "1",
                    "history_current": "2",
                    "history": [
                        "2"
                    ]
                }
            },
            {
                "id": "3",
                "slug": "css3_box",
                "mdn_key": "CSS3 Box",
                "name": {
                    "en": "CSS Basic Box Model"
                },
                "uri": {
                    "en": "http://dev.w3.org/csswg/css3-box/"
                },
                "links": {
                    "maturity": "2",
                    "history_current": "3",
                    "history": [
                        "3"
                    ]
                }
            }
        ],
        "sections": [
            {
                "id": "1",
                "number": {
                    "en": "5.5.25"
                },
                "name": {
                    "en": "'float'"
                },
                "subpath": {
                    "en": "#float"
                },
                "note": {
                    "en": "Initial definition."
                },
                "links": {
                    "specification": "1",
                    "history_current": "1",
                    "history": [
                        "1"
                    ]
                }
            },
            {
                "id": "2",
                "number": {
                    "en": "9.5.1"
                },
                "name": {
                    "en": "Positioning the float: the 'float' property"
                },
                "subpath": {
                    "en": "visuren.html#float-position"
                },
                "note": {
                    "en": "No change."
                },
                "links": {
                    "specification": "2",
                    "history_current": "2",
                    "history": [
                        "2"
                    ]
                }
            },
            {
                "id": "3",
                "number": {
                    "en": "16"
                },
                "name": {
                    "en": "The float property"
                },
                "subpath": {
                    "en": "#the-float-property"
                },
                "note": {
                    "en": "Lots of new values, not all clearly defined yet. Any differences in behavior unrelated to new features are expected to be unintentional; please report."
                },
                "links": {
                    "specification": "3",
                    "history_current": "3",
                    "history": [
                        "3"
                    ]
                }
            }
        ],
        "features": [
            {
                "id": "6",
                "slug": "web-css-float_basic-support",
                "mdn_uri": null,
                "experimental": false,
                "standardized": true,
                "stable": true,
                "obsolete": false,
                "name": {
                    "en": "Basic Support",
                    "ja": "基本サポート"
                },
                "links": {
                    "parent": "5",
                    "children": [],
                    "sections": [],
                    "supports": [
                        "1",
                        "2",
                        "3",
                        "4",
                        "5",
                        "6",
                        "7",
                        "8",
                        "9",
                        "10",
                        "27"
                    ],
                    "history_current": "6",
                    "history": [
                        "6"
                    ]
                }
            }
        ]
    },
    "meta": {
        "compat_table": {
            "supports": {
                "5": {},
                "6": {
                    "1": [
                        "1"
                    ],
                    "2": [
                        "27"
                    ],
                    "4": [
                        "2"
                    ],
                    "6": [
                        "3"
                    ],
                    "7": [
                        "4"
                    ],
                    "9": [
                        "5"
                    ],
                    "10": [
                        "6"
                    ],
                    "11": [
                        "7"
                    ],
                    "14": [
                        "8"
                    ],
                    "15": [
                        "10"
                    ]
                }
            },
            "tabs": [
                {
                    "name": {
                        "en": "Desktop Browsers"
                    },
                    "browsers": [
                        "4",
                        "7",
                        "9",
                        "11",
                        "14"
                    ]
                },
                {
                    "name": {
                        "en": "Mobile Browsers"
                    },
                    "browsers": [
                        "1",
                        "2",
                        "6",
                        "10",
                        "15"
                    ]
                }
            ],
            "child_pages": false,
            "pagination": {
                "linked.features": {
                    "previous": null,
                    "next": null,
                    "count": 1
                }
            },
            "languages": [
                "en",
                "de",
                "es",
                "ja",
                "ru"
            ],
            "notes": {}
        }
    }
}

One way to use this representation is:

1. Parse into an in-memory object store,

2. Create the “Specifications” section:

   1. Add the Specifications header

   2. Create an HTML table with a header row “Specification”, “Status”, “Comment”

   3. For each id in features.links.sections (["746", "421", "70"]):

      • Add the first column: a link to specifications.uri.(lang or en) + sections.subpath.(lang or en), with link text specifications.name.(lang or en), with title based on sections.name.(lang or en) or feature.name.(lang or en).
      • Add the second column: A span with class “spec-” + maturities.slug, and the text maturities.name.(lang or en).
      • Add the third column: maturities.notes.(lang or en), or empty string

   4. Close the table, and add an edit button.

3. Create the Browser Compatibility section:

   1. Add The “Browser compatibility” header

   2. For each item in meta.compat_table.tabs, create a table with the proper name (“Desktop”, “Mobile”)

   3. For each browser id in meta.compat-table.tabs.browsers, add a column with the translated browser name.

   4. For each feature in features.features:

      • Add the first column: the feature name. If it is a string, then wrap in <code>. Otherwise, use the best translation of feature.name, in a lang=(lang) block.

      • Add any feature flags, such as an obsolete or experimental icon, based on the feature flags.

      • For each browser id in meta.compat-table-important:

        • Get the important support IDs from meta.compat-table-important.supports.<feature ID>.<browser ID>
        • If null, then display ”?”
        • If just one, display “<version>”, or “<support>”, depending on the defined attributes
        • If multiple, display as subcells
        • Add prefixes, alternate names, config, and notes link as appropriate

   5. Close each table, add an edit button

   6. Add notes for displayed supports

This may be done by including the JSON in the page as sent over the wire, or loaded asynchronously, with the tables built after initial page load.

This can also be used by a “caniuse” table layout by ignoring the meta section and displaying all the included data. This will require more client-side processing to generate, or additional data in the <meta> section.

Including Child Pages

By default, view_feature only includes row children, which are subfeatures that are represented as rows in the MDN table. These row children are identified by not having a value for mdn_uri.

There can also be page children, which are represented as more detailed page on MDN. For example, Web/CSS has the page child Web/CSS/Display. By default, these are not included, but can be included by setting the query parameter child_pages=1:

GET /api/v1/view_features/5?child_pages=1 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

Updating Views with Changesets

Updating the page requires a sequence of requests. For example, if a user wants to change Chrome support for <address> from an unknown version to version 1, you’ll have to create the version for that version, then add the support for the support.

The first step is to create a changeset as an authenticated user:

POST /api/v1/changesets HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 107
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "changesets": {
        "target_resource_type": "features",
        "target_resource_id": "5"
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "changesets": {
        "id": "36",
        "created": "2015-04-20T20:36:06.794827Z",
        "modified": "2015-04-20T20:36:06.795315Z",
        "closed": false,
        "target_resource_type": "features",
        "target_resource_id": 5,
        "links": {
            "user": "1",
            "historical_browsers": [],
            "historical_features": [],
            "historical_maturities": [],
            "historical_sections": [],
            "historical_specifications": [],
            "historical_supports": [],
            "historical_versions": []
        }
    },
    "links": {
        "changesets.user": {
            "type": "users",
            "href": "https://browsercompat.org/api/v1/users/{changesets.user}"
        },
        "changesets.historical_browsers": {
            "type": "historical_browsers",
            "href": "https://browsercompat.org/api/v1/historical_browsers/{changesets.historical_browsers}"
        },
        "changesets.historical_features": {
            "type": "historical_features",
            "href": "https://browsercompat.org/api/v1/historical_features/{changesets.historical_features}"
        },
        "changesets.historical_maturities": {
            "type": "historical_maturities",
            "href": "https://browsercompat.org/api/v1/historical_maturities/{changesets.historical_maturities}"
        },
        "changesets.historical_sections": {
            "type": "historical_sections",
            "href": "https://browsercompat.org/api/v1/historical_sections/{changesets.historical_sections}"
        },
        "changesets.historical_specifications": {
            "type": "historical_specifications",
            "href": "https://browsercompat.org/api/v1/historical_specifications/{changesets.historical_specifications}"
        },
        "changesets.historical_supports": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{changesets.historical_supports}"
        },
        "changesets.historical_versions": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{changesets.historical_versions}"
        }
    }
}

Next, use the changeset ID when creating the version:

POST /api/v1/versions?changeset=36 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 138
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "versions": {
        "version": "2.0",
        "status": "retired",
        "links": {
            "browser": "3"
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "versions": {
        "id": "50",
        "version": "2.0",
        "release_day": null,
        "retirement_day": null,
        "status": "retired",
        "release_notes_uri": null,
        "note": null,
        "order": 3,
        "links": {
            "browser": "3",
            "supports": [],
            "history_current": "53",
            "history": [
                "53"
            ]
        }
    },
    "links": {
        "versions.browser": {
            "type": "browsers",
            "href": "https://browsercompat.org/api/v1/browsers/{versions.browser}"
        },
        "versions.supports": {
            "type": "supports",
            "href": "https://browsercompat.org/api/v1/supports/{versions.supports}"
        },
        "versions.history_current": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{versions.history_current}"
        },
        "versions.history": {
            "type": "historical_versions",
            "href": "https://browsercompat.org/api/v1/historical_versions/{versions.history}"
        }
    }
}

Finally, create the support:

POST /api/v1/supports?changeset=36 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 112
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "supports": {
        "links": {
            "version": "50",
            "feature": "6"
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "supports": {
        "id": "29",
        "support": "yes",
        "prefix": null,
        "prefix_mandatory": false,
        "alternate_name": null,
        "alternate_mandatory": false,
        "requires_config": null,
        "default_config": null,
        "protected": false,
        "note": null,
        "links": {
            "version": "50",
            "feature": "6",
            "history_current": "32",
            "history": [
                "32"
            ]
        }
    },
    "links": {
        "supports.version": {
            "type": "versions",
            "href": "https://browsercompat.org/api/v1/versions/{supports.version}"
        },
        "supports.feature": {
            "type": "features",
            "href": "https://browsercompat.org/api/v1/features/{supports.feature}"
        },
        "supports.history_current": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{supports.history_current}"
        },
        "supports.history": {
            "type": "historical_supports",
            "href": "https://browsercompat.org/api/v1/historical_supports/{supports.history}"
        }
    }
}

The historical_versions and historical_supports resources will both refer to changeset 36, and this changeset is linked to feature 5, despite the fact that no changes were made to the feature. This will facilitate displaying a history of the compatibility tables, for the purpose of reviewing changes and reverting vandalism.

Updating View with PUT

view_features supports PUT for bulk updates of support data. Here is a simple example that adds a new subfeature without support:

PUT /api/v1/view_features/html-element-address HTTP/1.1
Host: browsersupports.org
Content-Type: application/vnd.api+json
Authorization: Bearer mF_9.B5f-4.1JqM

{
    "features": {
        "id": "816",
        "slug": "html-element-address",
        "mdn_uri": {
            "en": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/address"
        },
        "experimental": false,
        "standardized": true,
        "stable": true,
        "obsolete": false,
        "name": "address",
        "links": {
            "sections": ["746", "421", "70"],
            "supports": [],
            "parent": "800",
            "children": ["191"],
            "history_current": "216",
            "history": ["216"]
        }
    },
    "linked": {
        "features": [
            {
                "id": "_New Subfeature",
                "slug": "html-address-new-subfeature",
                "name": {
                    "en": "New Subfeature"
                },
                "links": {
                    "parent": "816"
                }
            }
        ]
    }
}

The response is the feature view with new and updated items, or an error response.

This is a trivial use case, which would be better implemented by creating the feature directly, but it can be extended to bulk updates of existing feature views, or for first-time importing of subfeatures and support data. It has some quirks:

• New items should be identified with an ID starting with an underscore (_). Relations to new items should use the underscored IDs.
• Only feature, support, and section resources can be added or updated. Features must be the target feature or a descendant, and supports and sections are restricted to those features.
• Deletions are not supported.
• Other resources (browsers, versions, etc) can not be added or changed. This includes adding links to new resources.

Once the MDN import is complete, this PUT interface will be deprecated in favor of direct POST and PUT to the standard resource API.

v2 BrowserCompat API

The v2 BrowserCompat API is designed to store and maintain information about web technologies, such as HTML and CSS, in the manner used on MDN. This takes the form of Specification tables, which detail the specifications for technologies, and Browser Compatibility tables, which detail when browsers implemented those technologies. A simple example is for the HTML element <address>. A more complex example is the CSS property display.

The v2 API was initially released in January 2016, and is based on JSON API v1.0. The v2 API does not implement the entire JSON API v1.0 specification. See the issues page for the list of known differences between the v2 API and JSON API v1.0.

The v2 API is the recommended API for new code. The v1 API will be retained until MDN tools are updated to work with the v2 API API, and then the v1 API will be removed.

Implementation

The v2 API implements the JSON API v1.0 specification. This section shows how to interact with the API, and the next section gives the details of the resources available through the API.

Resources

Resources are identified by a plural noun. The list of resources, available at https://browsercompat.herokuapp.com/api/v2, include:

• browsers - A brand of web client with one of more versions
• versions - A specific release of a browser
• features - A web technology
• supports - Support details of a version for a feature
• specifications - A document specifying a web technology
• maturities - The state of a specification in the standardization process
• sections - A section of a specification
• changesets - A collection of one or more data changes
• users - API users
• historical_browsers - A change to a browser resource
• historical_versions - A change to a version resource
• historical_features - A change to a feature resource
• historical_supports - A change to a support resource
• historical_specifications - A change to a specification resource
• historical_maturities - A change to a maturity resource
• historical_sections - A change to a section resource

There is also a view that combines related resources:

• view_features - A feature combined with related resources.

List

To request a paginated list of a resource, GET the resource by name:

GET /api/v2/browsers HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers",
        "next": "https://browsercompat.org/api/v2/browsers?page=2",
        "prev": null
    },
    "data": [
        {
            "type": "browsers",
            "id": "1",
            "attributes": {
                "slug": "android",
                "name": {
                    "en": "Android Browser"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "1"
                        },
                        {
                            "type": "versions",
                            "id": "2"
                        },
                        {
                            "type": "versions",
                            "id": "3"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/1"
            }
        },
        {
            "type": "browsers",
            "id": "2",
            "attributes": {
                "slug": "android_webview",
                "name": {
                    "en": "Android Webview"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "4"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/2"
            }
        },
        {
            "type": "browsers",
            "id": "3",
            "attributes": {
                "slug": "blackberry",
                "name": {
                    "en": "BlackBerry Browser"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "5"
                        },
                        {
                            "type": "versions",
                            "id": "6"
                        },
                        {
                            "type": "versions",
                            "id": "7"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/3"
            }
        },
        {
            "type": "browsers",
            "id": "4",
            "attributes": {
                "slug": "chrome_desktop",
                "name": {
                    "en": "Chrome for Desktop"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "8"
                        },
                        {
                            "type": "versions",
                            "id": "9"
                        },
                        {
                            "type": "versions",
                            "id": "10"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/4"
            }
        },
        {
            "type": "browsers",
            "id": "5",
            "attributes": {
                "slug": "chrome_for_android",
                "name": {
                    "en": "Chrome for Android"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "11"
                        },
                        {
                            "type": "versions",
                            "id": "12"
                        },
                        {
                            "type": "versions",
                            "id": "13"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "5"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "5"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/5"
            }
        },
        {
            "type": "browsers",
            "id": "6",
            "attributes": {
                "slug": "firefox_android",
                "name": {
                    "en": "Firefox for Android"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "14"
                        },
                        {
                            "type": "versions",
                            "id": "15"
                        },
                        {
                            "type": "versions",
                            "id": "16"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/6"
            }
        },
        {
            "type": "browsers",
            "id": "7",
            "attributes": {
                "slug": "firefox_desktop",
                "name": {
                    "en": "Firefox for Desktop"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "17"
                        },
                        {
                            "type": "versions",
                            "id": "18"
                        },
                        {
                            "type": "versions",
                            "id": "19"
                        },
                        {
                            "type": "versions",
                            "id": "20"
                        },
                        {
                            "type": "versions",
                            "id": "21"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "7"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "7"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/7"
            }
        },
        {
            "type": "browsers",
            "id": "8",
            "attributes": {
                "slug": "firefox_os",
                "name": {
                    "en": "Firefox OS"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "22"
                        },
                        {
                            "type": "versions",
                            "id": "23"
                        },
                        {
                            "type": "versions",
                            "id": "24"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "8"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "8"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/8"
            }
        },
        {
            "type": "browsers",
            "id": "9",
            "attributes": {
                "slug": "ie_desktop",
                "name": {
                    "en": "Internet Explorer for Desktop"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "25"
                        },
                        {
                            "type": "versions",
                            "id": "26"
                        },
                        {
                            "type": "versions",
                            "id": "27"
                        },
                        {
                            "type": "versions",
                            "id": "28"
                        },
                        {
                            "type": "versions",
                            "id": "29"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "9"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/9"
            }
        },
        {
            "type": "browsers",
            "id": "10",
            "attributes": {
                "slug": "ie_mobile",
                "name": {
                    "en": "Internet Explorer Mobile"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "30"
                        },
                        {
                            "type": "versions",
                            "id": "31"
                        },
                        {
                            "type": "versions",
                            "id": "32"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "10"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "10"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/10"
            }
        }
    ],
    "meta": {
        "count": 15
    }
}

Retrieve by ID

To request a single resource, GET by name and ID.

Note: bug 1230306 proposes switching IDs to UUIDs.

Here’s an example:

GET /api/v2/browsers/7 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers/7"
    },
    "data": {
        "type": "browsers",
        "id": "7",
        "attributes": {
            "slug": "firefox_desktop",
            "name": {
                "en": "Firefox for Desktop"
            },
            "note": null
        },
        "relationships": {
            "versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/7/relationships/versions",
                    "related": "https://browsercompat.org/api/v2/browsers/7/versions"
                },
                "data": [
                    {
                        "type": "versions",
                        "id": "17"
                    },
                    {
                        "type": "versions",
                        "id": "18"
                    },
                    {
                        "type": "versions",
                        "id": "19"
                    },
                    {
                        "type": "versions",
                        "id": "20"
                    },
                    {
                        "type": "versions",
                        "id": "21"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/7/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/browsers/7/history_current"
                },
                "data": {
                    "type": "historical_browsers",
                    "id": "7"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/7/relationships/history",
                    "related": "https://browsercompat.org/api/v2/browsers/7/history"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "7"
                    }
                ]
            }
        }
    }
}

Filter by attribute

Note: bug 1078699 proposes an alternate URL format for retrieving by slug.

Resources can be filtered by an attribute value, using a filter query string:

GET /api/v2/browsers?filter[slug]=firefox_desktop HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

The response includes the desired browser, in list format:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers?filter[slug]=firefox_desktop",
        "next": null,
        "prev": null
    },
    "data": [
        {
            "type": "browsers",
            "id": "7",
            "attributes": {
                "slug": "firefox_desktop",
                "name": {
                    "en": "Firefox for Desktop"
                },
                "note": null
            },
            "relationships": {
                "versions": {
                    "data": [
                        {
                            "type": "versions",
                            "id": "17"
                        },
                        {
                            "type": "versions",
                            "id": "18"
                        },
                        {
                            "type": "versions",
                            "id": "19"
                        },
                        {
                            "type": "versions",
                            "id": "20"
                        },
                        {
                            "type": "versions",
                            "id": "21"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "7"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "7"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/7"
            }
        }
    ],
    "meta": {
        "count": 1
    }
}

Fetch Related Resources

Related resources appear in the JSON under /data/relationships. The “related” link can be used to get the related resources:

GET /api/v2/browsers/7/versions HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

The response includes the related data, as a list of resources or a single resource, depending on the relationship:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers/7/versions",
        "next": null,
        "prev": null
    },
    "data": [
        {
            "type": "versions",
            "id": "17",
            "attributes": {
                "version": "current",
                "release_day": null,
                "retirement_day": null,
                "status": "current",
                "release_notes_uri": null,
                "note": null,
                "order": 0
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "supports": {
                    "data": []
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "17"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "17"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/17"
            }
        },
        {
            "type": "versions",
            "id": "18",
            "attributes": {
                "version": "1.0",
                "release_day": "2004-11-09",
                "retirement_day": "2005-11-29",
                "status": "retired",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "supports": {
                    "data": [
                        {
                            "type": "supports",
                            "id": "4"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "18"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "18"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/18"
            }
        },
        {
            "type": "versions",
            "id": "19",
            "attributes": {
                "version": "3.5",
                "release_day": "2009-06-30",
                "retirement_day": "2010-01-21",
                "status": "retired",
                "release_notes_uri": {
                    "en": "https://developer.mozilla.org/en/Firefox/Releases/3.5",
                    "de": "https://developer.mozilla.org/de/docs/Firefox_3.5_f%C3%BCr_Entwickler",
                    "es": "https://developer.mozilla.org/es/docs/Firefox_3.5_para_desarrolladores",
                    "fr": "https://developer.mozilla.org/fr/Firefox/Versions/3.5",
                    "ja": "https://developer.mozilla.org/ja/Firefox/Releases/3.5",
                    "ko": "https://developer.mozilla.org/ko/docs/Firefox_3.5_for_developers",
                    "pl": "https://developer.mozilla.org/pl/Firefox/Releases/3.5",
                    "pt-PT": "https://developer.mozilla.org/pt-PT/docs/Firefox_3.5_para_desenvolvedores",
                    "ru": "https://developer.mozilla.org/ru/docs/Firefox_3.5_%D0%B4%D0%BB%D1%8F_%D1%80%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D1%87%D0%B8%D0%BA%D0%B0",
                    "zh-CN": "https://developer.mozilla.org/zh-CN/Firefox/Releases/3.5",
                    "zh-TW": "https://developer.mozilla.org/zh-TW/docs/Firefox_3.1_%E6%8A%80%E8%A1%93%E6%96%87%E4%BB%B6"
                },
                "note": null,
                "order": 2
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "supports": {
                    "data": [
                        {
                            "type": "supports",
                            "id": "13"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "19"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "19"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/19"
            }
        },
        {
            "type": "versions",
            "id": "20",
            "attributes": {
                "version": "10.0",
                "release_day": "2012-01-31",
                "retirement_day": "2012-03-13",
                "status": "retired",
                "release_notes_uri": {
                    "en": "https://developer.mozilla.org/en/Firefox/Releases/10",
                    "de": "https://developer.mozilla.org/de/Firefox/Releases/10",
                    "es": "https://developer.mozilla.org/es/Firefox/Releases/10",
                    "fr": "https://developer.mozilla.org/fr/Firefox/Releases/10",
                    "ja": "https://developer.mozilla.org/ja/docs/Firefox_10_for_developers",
                    "ko": "https://developer.mozilla.org/ko/Firefox/Releases/10",
                    "pl": "https://developer.mozilla.org/pl/Firefox/Releases/10",
                    "pt-PT": "https://developer.mozilla.org/pt-PT/Firefox/Releases/10",
                    "ru": "https://developer.mozilla.org/ru/Firefox/Releases/10",
                    "zh-CN": "https://developer.mozilla.org/zh-CN/Firefox/Releases/10",
                    "zh-TW": "https://developer.mozilla.org/zh-TW/Firefox/Releases/10"
                },
                "note": null,
                "order": 3
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "supports": {
                    "data": [
                        {
                            "type": "supports",
                            "id": "21"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "20"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "20"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/20"
            }
        },
        {
            "type": "versions",
            "id": "21",
            "attributes": {
                "version": "16.0",
                "release_day": "2012-10-09",
                "retirement_day": "2012-11-20",
                "status": "retired",
                "release_notes_uri": {
                    "en": "https://developer.mozilla.org/en/Firefox/Releases/16",
                    "de": "https://developer.mozilla.org/de/Firefox/Releases/16",
                    "es": "https://developer.mozilla.org/es/Firefox/Releases/16",
                    "fr": "https://developer.mozilla.org/fr/Firefox/Versions/16",
                    "ja": "https://developer.mozilla.org/ja/Firefox/Releases/16",
                    "ko": "https://developer.mozilla.org/ko/Firefox/Releases/16",
                    "pl": "https://developer.mozilla.org/pl/Firefox/Releases/16",
                    "pt-PT": "https://developer.mozilla.org/pt-PT/Firefox/Releases/16",
                    "ru": "https://developer.mozilla.org/ru/Firefox/Releases/16",
                    "zh-CN": "https://developer.mozilla.org/zh-CN/Firefox/Releases/16",
                    "zh-TW": "https://developer.mozilla.org/zh-TW/Firefox/Releases/16"
                },
                "note": null,
                "order": 4
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "supports": {
                    "data": [
                        {
                            "type": "supports",
                            "id": "12"
                        },
                        {
                            "type": "supports",
                            "id": "22"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "21"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "21"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/21"
            }
        }
    ],
    "meta": {
        "count": 5
    }
}

Fetch Relationships

Alternatively, just the data for a relationship can be retrieved using the “self” link of related resources:

GET /api/v2/browsers/7/relationships/versions HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

The response just includes the types and IDs of the related resources:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers/7/relationships/versions",
        "related": "https://browsercompat.org/api/v2/browsers/7/versions"
    },
    "data": [
        {
            "type": "versions",
            "id": "17"
        },
        {
            "type": "versions",
            "id": "18"
        },
        {
            "type": "versions",
            "id": "19"
        },
        {
            "type": "versions",
            "id": "20"
        },
        {
            "type": "versions",
            "id": "21"
        }
    ]
}

Create a Single Resource

To create a new resource, POST to the resource list as an authenticated user. The POST body must include at least the required attributes. Some items (such as the history_current ID) will be picked by the server, and will be ignored if included.

Here is an example creating a browser with minimal data:

POST /api/v2/browsers HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 206
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "browsers",
        "attributes": {
            "slug": "amazon-silk-mobile",
            "name": {
                "en": "Amazon Silk Mobile"
            }
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers"
    },
    "data": {
        "type": "browsers",
        "id": "16",
        "attributes": {
            "slug": "amazon-silk-mobile",
            "name": {
                "en": "Amazon Silk Mobile"
            },
            "note": null
        },
        "relationships": {
            "versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/relationships/versions",
                    "related": "https://browsercompat.org/api/v2/browsers/versions"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/browsers/history_current"
                },
                "data": {
                    "type": "historical_browsers",
                    "id": "16"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/relationships/history",
                    "related": "https://browsercompat.org/api/v2/browsers/history"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "16"
                    }
                ]
            }
        }
    }
}

Create Multiple Resources

When creating several resources, the changes can be associated by first creating a changeset:

POST /api/v2/changesets HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 115
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "changesets",
        "attributes": {
            "closed": false
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/changesets"
    },
    "data": {
        "type": "changesets",
        "id": "4",
        "attributes": {
            "created": "2016-01-08T22:22:22.292921Z",
            "modified": "2016-01-08T22:22:33.916387Z",
            "closed": false,
            "target_resource_type": null,
            "target_resource_id": null
        },
        "relationships": {
            "user": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/user",
                    "related": "https://browsercompat.org/api/v2/changesets/user"
                },
                "data": {
                    "type": "users",
                    "id": "1"
                }
            },
            "historical_browsers": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_browsers",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_browsers"
                },
                "data": []
            },
            "historical_features": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_features",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_features"
                },
                "data": []
            },
            "historical_maturities": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_maturities",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_maturities"
                },
                "data": []
            },
            "historical_sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_sections",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_sections"
                },
                "data": []
            },
            "historical_specifications": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_specifications",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_specifications"
                },
                "data": []
            },
            "historical_supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_supports",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_supports"
                },
                "data": []
            },
            "historical_versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_versions",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_versions"
                },
                "data": []
            }
        }
    }
}

The changeset can then be specified as a query parameter:

POST /api/v2/browsers?changeset=4 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 298
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "browsers",
        "attributes": {
            "slug": "nintendo-ds",
            "name": {
                "en": "Nintendo DS Browser",
                "ja": "\u30cb\u30f3\u30c6\u30f3\u30c9\u30fc\uff24\uff33\u30d6\u30e9\u30a6\u30b6"
            }
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers?changeset=4"
    },
    "data": {
        "type": "browsers",
        "id": "18",
        "attributes": {
            "slug": "nintendo-ds",
            "name": {
                "en": "Nintendo DS Browser",
                "ja": "ニンテンドーＤＳブラウザ"
            },
            "note": null
        },
        "relationships": {
            "versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/relationships/versions",
                    "related": "https://browsercompat.org/api/v2/browsers/versions"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/browsers/history_current"
                },
                "data": {
                    "type": "historical_browsers",
                    "id": "18"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/relationships/history",
                    "related": "https://browsercompat.org/api/v2/browsers/history"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "18"
                    }
                ]
            }
        }
    }
}

Finally, close the changeset, which is now associated with the historical resources:

PATCH /api/v2/changesets/4 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 114
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "changesets",
        "attributes": {
            "closed": true
        }
    }
}

The response included relationships to the items created in the changeset:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/changesets/4"
    },
    "data": {
        "type": "changesets",
        "id": "4",
        "attributes": {
            "created": "2016-01-08T22:22:46.419281Z",
            "modified": "2016-01-08T22:22:54.978989Z",
            "closed": true,
            "target_resource_type": null,
            "target_resource_id": null
        },
        "relationships": {
            "user": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/user",
                    "related": "https://browsercompat.org/api/v2/changesets/4/user"
                },
                "data": {
                    "type": "users",
                    "id": "1"
                }
            },
            "historical_browsers": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_browsers",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_browsers"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "18"
                    }
                ]
            },
            "historical_features": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_features",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_features"
                },
                "data": []
            },
            "historical_maturities": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_maturities",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_maturities"
                },
                "data": []
            },
            "historical_sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_sections",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_sections"
                },
                "data": []
            },
            "historical_specifications": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_specifications",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_specifications"
                },
                "data": []
            },
            "historical_supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_supports",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_supports"
                },
                "data": []
            },
            "historical_versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/4/relationships/historical_versions",
                    "related": "https://browsercompat.org/api/v2/changesets/4/historical_versions"
                },
                "data": []
            }
        }
    }
}

Update a resource

To update a resource with new data, PATCH the instance with the new data. Omitted items with keep their old values. For each resource, there are some items that can not be changed (for example, the id or the history relationship IDs), and will be ignored if included in the update request. A successful update will return a 200 OK, add a new ID to the history relationship, and update the history_current relationship.

Here’s an example of updating a browser:

PATCH /api/v2/browsers/9 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 167
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "browsers",
        "id": "9",
        "attributes": {
            "name": {
                "en": "IE"
            }
        }
    }
}

With this response:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers/9"
    },
    "data": {
        "type": "browsers",
        "id": "9",
        "attributes": {
            "slug": "ie_desktop",
            "name": {
                "en": "IE"
            },
            "note": null
        },
        "relationships": {
            "versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/9/relationships/versions",
                    "related": "https://browsercompat.org/api/v2/browsers/9/versions"
                },
                "data": [
                    {
                        "type": "versions",
                        "id": "25"
                    },
                    {
                        "type": "versions",
                        "id": "26"
                    },
                    {
                        "type": "versions",
                        "id": "27"
                    },
                    {
                        "type": "versions",
                        "id": "28"
                    },
                    {
                        "type": "versions",
                        "id": "29"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/9/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/browsers/9/history_current"
                },
                "data": {
                    "type": "historical_browsers",
                    "id": "20"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/9/relationships/history",
                    "related": "https://browsercompat.org/api/v2/browsers/9/history"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "20"
                    },
                    {
                        "type": "historical_browsers",
                        "id": "19"
                    },
                    {
                        "type": "historical_browsers",
                        "id": "9"
                    }
                ]
            }
        }
    }
}

Update a one-to-many relationship

Some relationships are one-to-many, and the relationship appears on both sides. For example, a specification has one maturity, but a maturity can be related to several specifications. To update these relationships, PATCH the “to-one” relationship (maturity) on the “many” resource (specification):

PATCH /api/v2/specifications/7 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 250
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "specifications",
        "relationships": {
            "maturity": {
                "data": {
                    "type": "maturities",
                    "id": "5"
                }
            }
        }
    }
}

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/specifications/7"
    },
    "data": {
        "type": "specifications",
        "id": "7",
        "attributes": {
            "slug": "css3-ruby",
            "mdn_key": "CSS3 Ruby",
            "name": {
                "en": "CSS Ruby Layout Module Level 1"
            },
            "uri": {
                "en": "http://dev.w3.org/csswg/css-ruby/"
            }
        },
        "relationships": {
            "maturity": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/7/relationships/maturity",
                    "related": "https://browsercompat.org/api/v2/specifications/7/maturity"
                },
                "data": {
                    "type": "maturities",
                    "id": "5"
                }
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/7/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/specifications/7/sections"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/7/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/specifications/7/history_current"
                },
                "data": {
                    "type": "historical_specifications",
                    "id": "8"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/7/relationships/history",
                    "related": "https://browsercompat.org/api/v2/specifications/7/history"
                },
                "data": [
                    {
                        "type": "historical_specifications",
                        "id": "8"
                    },
                    {
                        "type": "historical_specifications",
                        "id": "7"
                    }
                ]
            }
        }
    }
}

Update a relationship via relationship link

An alternate way to change a relationship is to PATCH the relationship endpoint:

PATCH /api/v2/specifications/7/relationships/maturity HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 71
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "maturities",
        "id": "4"
    }
}

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/specifications/7/relationships/maturity",
        "related": "https://browsercompat.org/api/v2/specifications/7/maturity"
    },
    "data": {
        "type": "maturities",
        "id": "4"
    }
}

Update the order of a one-to-many relationship

For some one-to-many relationships, the order of the to-many relationships matters (for example, version order with respect to browsers, and child features with respect to the parent feature). To change the order, update the order of the relationships on the “one” resource, either by updating the resource or the relationship:

PATCH /api/v2/features/2/relationships/children HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 624
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": [
        {
            "type": "features",
            "id": "3"
        },
        {
            "type": "features",
            "id": "4"
        },
        {
            "type": "features",
            "id": "5"
        },
        {
            "type": "features",
            "id": "7"
        },
        {
            "type": "features",
            "id": "8"
        },
        {
            "type": "features",
            "id": "13"
        },
        {
            "type": "features",
            "id": "9"
        },
        {
            "type": "features",
            "id": "10"
        }
    ]
}

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/features/2/relationships/children",
        "related": "https://browsercompat.org/api/v2/features/2/children"
    },
    "data": [
        {
            "type": "features",
            "id": "3"
        },
        {
            "type": "features",
            "id": "4"
        },
        {
            "type": "features",
            "id": "5"
        },
        {
            "type": "features",
            "id": "7"
        },
        {
            "type": "features",
            "id": "8"
        },
        {
            "type": "features",
            "id": "13"
        },
        {
            "type": "features",
            "id": "9"
        },
        {
            "type": "features",
            "id": "10"
        }
    ]
}

Revert to previous revision

To revert an instance to a previous revision, set the history_current relationship to the history ID of the previous revision. This resets the content and creates a new history object for the change:

PATCH /api/v2/features/12 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 281
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "features",
        "id": "12",
        "relationships": {
            "history_current": {
                "data": {
                    "type": "historical_features",
                    "id": "12"
                }
            }
        }
    }
}

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/features/12"
    },
    "data": {
        "type": "features",
        "id": "12",
        "attributes": {
            "slug": "web-css-transform-three-value-syntax",
            "mdn_uri": null,
            "experimental": false,
            "standardized": true,
            "stable": true,
            "obsolete": false,
            "name": {
                "en": "Three-value syntax",
                "es": "Sintaxis con tres valores",
                "ja": "3-値構文"
            }
        },
        "relationships": {
            "parent": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/parent",
                    "related": "https://browsercompat.org/api/v2/features/12/parent"
                },
                "data": {
                    "type": "features",
                    "id": "10"
                }
            },
            "children": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/children",
                    "related": "https://browsercompat.org/api/v2/features/12/children"
                },
                "data": []
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/features/12/sections"
                },
                "data": []
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/features/12/supports"
                },
                "data": [
                    {
                        "type": "supports",
                        "id": "20"
                    },
                    {
                        "type": "supports",
                        "id": "21"
                    },
                    {
                        "type": "supports",
                        "id": "22"
                    },
                    {
                        "type": "supports",
                        "id": "23"
                    },
                    {
                        "type": "supports",
                        "id": "24"
                    },
                    {
                        "type": "supports",
                        "id": "25"
                    },
                    {
                        "type": "supports",
                        "id": "26"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/features/12/history_current"
                },
                "data": {
                    "type": "historical_features",
                    "id": "26"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/history",
                    "related": "https://browsercompat.org/api/v2/features/12/history"
                },
                "data": [
                    {
                        "type": "historical_features",
                        "id": "26"
                    },
                    {
                        "type": "historical_features",
                        "id": "16"
                    },
                    {
                        "type": "historical_features",
                        "id": "12"
                    }
                ]
            }
        }
    }
}

Delete a resource

To delete a resource:

DELETE /api/v1/versions/49 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 0
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

The response has no body:

HTTP/1.1 204 NO CONTENT

Revert a deletion

Reverting deletions is not currently possible, and is tracked in bug 1159349.

Resources

Resources are simple objects supporting CRUD operations. Read operations can be done anonymously. Creating and updating require account permissions, and deleting requires admin account permissions.

Browsers

A browser is a brand of web client that has one or more versions. This follows most users’ understanding of browsers, i.e., firefox_desktop represents desktop Firefox, safari_desktop represents desktop Safari, and firefox_android represents Firefox on Android.

The browsers representation includes:

• attributes

  • id (server selected) - Database ID
  • slug (write-once) - Unique, human-friendly slug
  • name (localized) - Browser name
  • note (localized) - Notes, intended for related data like OS, applicable device, engines, etc.

• relationships

  • versions (many) - Associated versions, ordered roughly from earliest to latest. User can change the order.
  • history_current (one) - Current historical_browsers. Can be set to a value from history to revert changes.
  • history (many) - Associated historical_browsers in time order (most recent first). Changes are ignored.

Note: bug 1078699 is proposing that select users will be able to modify slugs

An example browser resource:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/browsers/7"
    },
    "data": {
        "type": "browsers",
        "id": "7",
        "attributes": {
            "slug": "firefox_desktop",
            "name": {
                "en": "Firefox for Desktop"
            },
            "note": null
        },
        "relationships": {
            "versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/7/relationships/versions",
                    "related": "https://browsercompat.org/api/v2/browsers/7/versions"
                },
                "data": [
                    {
                        "type": "versions",
                        "id": "17"
                    },
                    {
                        "type": "versions",
                        "id": "18"
                    },
                    {
                        "type": "versions",
                        "id": "19"
                    },
                    {
                        "type": "versions",
                        "id": "20"
                    },
                    {
                        "type": "versions",
                        "id": "21"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/7/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/browsers/7/history_current"
                },
                "data": {
                    "type": "historical_browsers",
                    "id": "7"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/7/relationships/history",
                    "related": "https://browsercompat.org/api/v2/browsers/7/history"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "7"
                    }
                ]
            }
        }
    }
}

Versions

A version is a specific release of a Browser.

The versions representation includes:

• attributes

  • id (server selected) - Database ID
  • version (write-once) - Version of browser. Numeric or text string, depending on the status (see table below).
  • release_day - Day that browser was released in ISO 8601 format, or null if unknown.
  • retirement_day - Approximate day the browser was “retired” (stopped being a current browser), in ISO 8601 format, or null if unknown.
  • status - One of beta, current, future, retired-beta, retired, or unknown (see table below).
  • release_notes_uri (localized) - URI of release notes for this version, or null if none.
  • note (localized) - Engine, OS, etc. information, or null
  • order (read-only) - The relative order among versions for this browser. The order can be changed on the browser resource.

• relationships

  • browser - The related browser
  • supports (many) - Associated supports, in ID order. Changes are ignored; work on the supports to add, change, or remove.
  • history_current (one) - Current historical_versions. Set to a value from history to revert to that version.
  • history (many) - Associated historical_versions, in time order (most recent first). Changes are ignored.

The version is either a numeric value, such as "11.0", or text, such as "Nightly". The version format depends on the chosen status:

Status	Version	Meaning
beta	numeric	A release candidate suggested for early adopters or testers
current	numeric or the text "current"	A current and preferred release for most users
future	text such as "Nightly"	A named but unnumbered future release
retired-beta	numeric	An old beta version, replaced by a new beta or release
retired	numeric	An old released version no longer recommended for users
unknown	numeric	A release with an unknown status

An example version resource:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/versions/21"
    },
    "data": {
        "type": "versions",
        "id": "21",
        "attributes": {
            "version": "16.0",
            "release_day": "2012-10-09",
            "retirement_day": "2012-11-20",
            "status": "retired",
            "release_notes_uri": {
                "en": "https://developer.mozilla.org/en/Firefox/Releases/16",
                "de": "https://developer.mozilla.org/de/Firefox/Releases/16",
                "es": "https://developer.mozilla.org/es/Firefox/Releases/16",
                "fr": "https://developer.mozilla.org/fr/Firefox/Versions/16",
                "ja": "https://developer.mozilla.org/ja/Firefox/Releases/16",
                "ko": "https://developer.mozilla.org/ko/Firefox/Releases/16",
                "pl": "https://developer.mozilla.org/pl/Firefox/Releases/16",
                "pt-PT": "https://developer.mozilla.org/pt-PT/Firefox/Releases/16",
                "ru": "https://developer.mozilla.org/ru/Firefox/Releases/16",
                "zh-CN": "https://developer.mozilla.org/zh-CN/Firefox/Releases/16",
                "zh-TW": "https://developer.mozilla.org/zh-TW/Firefox/Releases/16"
            },
            "note": null,
            "order": 4
        },
        "relationships": {
            "browser": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/21/relationships/browser",
                    "related": "https://browsercompat.org/api/v2/versions/21/browser"
                },
                "data": {
                    "type": "browsers",
                    "id": "7"
                }
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/21/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/versions/21/supports"
                },
                "data": [
                    {
                        "type": "supports",
                        "id": "12"
                    },
                    {
                        "type": "supports",
                        "id": "22"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/21/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/versions/21/history_current"
                },
                "data": {
                    "type": "historical_versions",
                    "id": "21"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/21/relationships/history",
                    "related": "https://browsercompat.org/api/v2/versions/21/history"
                },
                "data": [
                    {
                        "type": "historical_versions",
                        "id": "21"
                    }
                ]
            }
        }
    }
}

Features

A feature is a web technology. This could be a precise technology, such as the value cover for the CSS background-size property. It could be a hierarchical group of related technologies, such as the CSS background-size property or the set of all CSS properties. Some features correspond to a page on MDN, which will display the list of specifications and a browser compatibility table of the sub-features.

The features representation includes:

• attributes

  • id (server selected) - Database ID
  • slug (write-once) - Unique, human-friendly slug
  • mdn_uri (optional, localized) - The URI of the language-specific MDN page that this feature was first scraped from. If the path contains unicode, it should be percent-encoded as in RFC 3987. May be used in UX or for debugging import scripts.
  • experimental - True if a feature is considered experimental, such as being non-standard or part of an non-ratified spec.
  • standardized - True if a feature is described in a standards-track spec, regardless of the spec’s maturity.
  • stable - True if a feature is considered suitable for production websites.
  • obsolete - True if a feature should not be used in new development.
  • name (canonical or localized) - Feature name. If the name is the code used by a developer, then the value is a string, and should be wrapped in a <code> block when displayed. If the name is a description of the feature, then the value is the available translations, including at least an en translation, and may include HTML markup. For example, "display" and "display: none" are canonical names for the CSS display property and one of the values for that property, while "Basic support", "<code>none, inline</code> and <code>block</code>", and "CSS Properties" are non-canonical names that should be translated.

• relationships

  • sections (many) - Associated sections. Order can be changed by the user.
  • supports (many) - Associated supports, Order is in ID order, changes are ignored.
  • parent (one or null) - The feature one level up, or null if top-level. Can be changed by user.
  • children (many) - The features that have this feature as parent, in display order. Can be an empty list, for “leaf” features. Can be re-ordered by the user.
  • history_current (one) - Current historical_features. User can set to a valid history to revert to that version.
  • history (many) - Associated historical_features, in time order (most recent first). Changes are ignored.

Note: bug 1240785 is proposing that the slug is replaced with a list of optional aliases

Here is an example of a leaf feature with a translated name:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/features/12"
    },
    "data": {
        "type": "features",
        "id": "12",
        "attributes": {
            "slug": "web-css-transform-three-value-syntax",
            "mdn_uri": null,
            "experimental": false,
            "standardized": true,
            "stable": true,
            "obsolete": false,
            "name": {
                "en": "Three-value syntax",
                "es": "Sintaxis con tres valores",
                "ja": "3-値構文"
            }
        },
        "relationships": {
            "parent": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/parent",
                    "related": "https://browsercompat.org/api/v2/features/12/parent"
                },
                "data": {
                    "type": "features",
                    "id": "10"
                }
            },
            "children": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/children",
                    "related": "https://browsercompat.org/api/v2/features/12/children"
                },
                "data": []
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/features/12/sections"
                },
                "data": []
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/features/12/supports"
                },
                "data": [
                    {
                        "type": "supports",
                        "id": "20"
                    },
                    {
                        "type": "supports",
                        "id": "21"
                    },
                    {
                        "type": "supports",
                        "id": "22"
                    },
                    {
                        "type": "supports",
                        "id": "23"
                    },
                    {
                        "type": "supports",
                        "id": "24"
                    },
                    {
                        "type": "supports",
                        "id": "25"
                    },
                    {
                        "type": "supports",
                        "id": "26"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/features/12/history_current"
                },
                "data": {
                    "type": "historical_features",
                    "id": "12"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/12/relationships/history",
                    "related": "https://browsercompat.org/api/v2/features/12/history"
                },
                "data": [
                    {
                        "type": "historical_features",
                        "id": "12"
                    }
                ]
            }
        }
    }
}

Here is an example of a branch feature with a canonical name (the parent of the previous example):

{
    "links": {
        "self": "https://browsercompat.org/api/v2/features/10"
    },
    "data": {
        "type": "features",
        "id": "10",
        "attributes": {
            "slug": "web-css-transform-origin",
            "mdn_uri": {
                "en": "https://developer.mozilla.org/en-US/docs/Web/CSS/transform-origin",
                "es": "https://developer.mozilla.org/es/docs/Web/CSS/transform-origin",
                "fr": "https://developer.mozilla.org/fr/docs/Web/CSS/transform-origin",
                "ja": "https://developer.mozilla.org/ja/docs/Web/CSS/transform-origin"
            },
            "experimental": false,
            "standardized": true,
            "stable": true,
            "obsolete": false,
            "name": "transform-origin"
        },
        "relationships": {
            "parent": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/10/relationships/parent",
                    "related": "https://browsercompat.org/api/v2/features/10/parent"
                },
                "data": {
                    "type": "features",
                    "id": "2"
                }
            },
            "children": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/10/relationships/children",
                    "related": "https://browsercompat.org/api/v2/features/10/children"
                },
                "data": [
                    {
                        "type": "features",
                        "id": "11"
                    },
                    {
                        "type": "features",
                        "id": "12"
                    }
                ]
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/10/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/features/10/sections"
                },
                "data": [
                    {
                        "type": "sections",
                        "id": "4"
                    }
                ]
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/10/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/features/10/supports"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/10/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/features/10/history_current"
                },
                "data": {
                    "type": "historical_features",
                    "id": "10"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/10/relationships/history",
                    "related": "https://browsercompat.org/api/v2/features/10/history"
                },
                "data": [
                    {
                        "type": "historical_features",
                        "id": "10"
                    }
                ]
            }
        }
    }
}

Supports

A support is an assertion that a particular Version of a Browser supports (or does not support) a feature.

The support representation includes:

• attributes

  • id (server selected) - Database ID
  • support - Assertion of support of the version for the feature, one of "yes", "no", "partial", or "unknown"
  • prefix - Prefix used to enable support, such as “moz”
  • prefix_mandatory - True if the prefix is required
  • alternate_name - An alternate name associated with this feature, such as "RTCPeerConnectionIdentityEvent"
  • alternate_name_mandatory - True if the alternate name is required
  • requires_config - A configuration string required to enable the feature, such as "media.peerconnection.enabled=on"
  • default_config - The configuration string in the shipping browser, such as "media.peerconnection.enabled=off"
  • protected - True if the feature requires additional steps to enable in order to protect the user’s security or privacy, such as geolocation and the Bluetooth API.
  • note (localized) - Note on support, designed for display after a compatibility table, can contain HTML

• relationships

  • version (one) - The associated version. Cannot be changed by the user after creation.
  • feature (one) - The associated feature. Cannot be changed by the user after creation. The version and feature combo must be unique.
  • history_current (one) - Current historical_supports. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_supports in time order (most recent first). Changes are ignored.

Here is a sample support:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/supports/22"
    },
    "data": {
        "type": "supports",
        "id": "22",
        "attributes": {
            "support": "yes",
            "prefix": null,
            "prefix_mandatory": false,
            "alternate_name": null,
            "alternate_mandatory": false,
            "requires_config": null,
            "default_config": null,
            "protected": false,
            "note": null
        },
        "relationships": {
            "version": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/22/relationships/version",
                    "related": "https://browsercompat.org/api/v2/supports/22/version"
                },
                "data": {
                    "type": "versions",
                    "id": "21"
                }
            },
            "feature": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/22/relationships/feature",
                    "related": "https://browsercompat.org/api/v2/supports/22/feature"
                },
                "data": {
                    "type": "features",
                    "id": "12"
                }
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/22/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/supports/22/history_current"
                },
                "data": {
                    "type": "historical_supports",
                    "id": "22"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/22/relationships/history",
                    "related": "https://browsercompat.org/api/v2/supports/22/history"
                },
                "data": [
                    {
                        "type": "historical_supports",
                        "id": "22"
                    }
                ]
            }
        }
    }
}

Specifications

A specification is a standards document that specifies a web technology.

The specification representation includes:

• attributes

  • id (server selected) - Database ID
  • slug - Unique, human-friendly key
  • mdn_key - Key used in the KumaScript macros SpecName and Spec2.
  • name (localized) - Specification name
  • uri (localized) - Specification URI, without subpath and anchor

• relationships

  • maturity (one) - Associated maturity. Can be changed by the user.
  • sections (many) - Associated sections. The order can be changed by the user.
  • history_current (one) - Current historical_specifications. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_specifications in time order (most recent first). Changes are ignored.

Here is a sample specification:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/specifications/2"
    },
    "data": {
        "type": "specifications",
        "id": "2",
        "attributes": {
            "slug": "css2_1",
            "mdn_key": "CSS2.1",
            "name": {
                "en": "CSS Level 2 (Revision 1)"
            },
            "uri": {
                "en": "http://www.w3.org/TR/CSS2/"
            }
        },
        "relationships": {
            "maturity": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/2/relationships/maturity",
                    "related": "https://browsercompat.org/api/v2/specifications/2/maturity"
                },
                "data": {
                    "type": "maturities",
                    "id": "1"
                }
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/2/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/specifications/2/sections"
                },
                "data": [
                    {
                        "type": "sections",
                        "id": "2"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/2/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/specifications/2/history_current"
                },
                "data": {
                    "type": "historical_specifications",
                    "id": "2"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/2/relationships/history",
                    "related": "https://browsercompat.org/api/v2/specifications/2/history"
                },
                "data": [
                    {
                        "type": "historical_specifications",
                        "id": "2"
                    }
                ]
            }
        }
    }
}

Sections

Note: bug 1216786 is proposing splitting Sections into Sections and References.

A section refers to a specific area of a specification document.

The section representation includes:

• attributes

  • id (server selected) - Database ID
  • number (optional, localized) - The section number
  • name (localized) - Section name
  • subpath (localized, optional) - A subpage (possibly with an #anchor) to get to the subsection in the doc. Can be empty string.
  • note (localized, optional) - Notes for this section

• relationships

  • specification (one) - The specification. Can be changed by the user.
  • features (many) - The associated features. In ID order, changes are ignored.
  • history_current (one) - Current historical_sections. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_sections in time order (most recent first). Changes are ignored.

Here is a sample section:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/sections/3"
    },
    "data": {
        "type": "sections",
        "id": "3",
        "attributes": {
            "number": {
                "en": "16"
            },
            "name": {
                "en": "The float property"
            },
            "subpath": {
                "en": "#the-float-property"
            },
            "note": {
                "en": "Lots of new values, not all clearly defined yet. Any differences in behavior unrelated to new features are expected to be unintentional; please report."
            }
        },
        "relationships": {
            "specification": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/sections/3/relationships/specification",
                    "related": "https://browsercompat.org/api/v2/sections/3/specification"
                },
                "data": {
                    "type": "specifications",
                    "id": "3"
                }
            },
            "features": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/sections/3/relationships/features",
                    "related": "https://browsercompat.org/api/v2/sections/3/features"
                },
                "data": [
                    {
                        "type": "features",
                        "id": "5"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/sections/3/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/sections/3/history_current"
                },
                "data": {
                    "type": "historical_sections",
                    "id": "3"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/sections/3/relationships/history",
                    "related": "https://browsercompat.org/api/v2/sections/3/history"
                },
                "data": [
                    {
                        "type": "historical_sections",
                        "id": "3"
                    }
                ]
            }
        }
    }
}

Maturities

A maturity refers to the maturity of a specification document.

The maturity representation includes:

• attributes

  • id (server selected) - Database ID
  • slug - A human-friendly identifier for this maturity. When applicable, it matches the key in the KumaScript macro Spec2
  • name (localized) - Status name

• relationships

  • specifications (many) - Associated specifications. In ID order, changes are ignored.
  • history_current (one) - Current historical_maturities. Can be changed to a valid history to revert to that version.
  • history (many) - Associated historical_maturities in time order (most recent first). Changes are ignored.

Here is a sample maturity:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/maturities/1"
    },
    "data": {
        "type": "maturities",
        "id": "1",
        "attributes": {
            "slug": "REC",
            "name": {
                "en": "Recommendation",
                "de": "Empfehlung",
                "ja": "勧告",
                "ru": "Рекомендация"
            }
        },
        "relationships": {
            "specifications": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/maturities/1/relationships/specifications",
                    "related": "https://browsercompat.org/api/v2/maturities/1/specifications"
                },
                "data": [
                    {
                        "type": "specifications",
                        "id": "1"
                    },
                    {
                        "type": "specifications",
                        "id": "2"
                    },
                    {
                        "type": "specifications",
                        "id": "6"
                    }
                ]
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/maturities/1/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/maturities/1/history_current"
                },
                "data": {
                    "type": "historical_maturities",
                    "id": "1"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/maturities/1/relationships/history",
                    "related": "https://browsercompat.org/api/v2/maturities/1/history"
                },
                "data": [
                    {
                        "type": "historical_maturities",
                        "id": "1"
                    }
                ]
            }
        }
    }
}

Users

A user represents a person or process that creates, changes, or deletes a resource.

The representation includes:

• attributes

  • id (server selected) - Database ID
  • username - The user’s email or ID
  • created (server selected) - Time that the account was created, in ISO 8601 format.
  • agreement - The version of the contribution agreement the user has accepted. “0” for not agreed, “1” for first version, etc.
  • permissions - A list of permissions. Permissions include "change-resource" (add or change any resource except users or history resources), "delete-resource" (delete any resource) "import-mdn" (setup import of an MDN page)

• relationships

  • changesets (many) - Associated changesets, in ID order, changes are ignored.

Here’s an example user:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/users/1"
    },
    "data": {
        "type": "users",
        "id": "1",
        "attributes": {
            "username": "user",
            "created": "2016-01-08T22:21:50.254130Z",
            "agreement": 0,
            "permissions": [
                "change-resource",
                "delete-resource"
            ]
        },
        "relationships": {
            "changesets": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/users/1/relationships/changesets",
                    "related": "https://browsercompat.org/api/v2/users/1/changesets"
                },
                "data": []
            }
        }
    }
}

Note: bug 1159354 proposes this method for retrieving the authenticated user:

GET /api/v2/users/me HTTP/1.1
Host: browsersupports.org
Accept: application/vnd.api+json

Changesets

A changeset collects history resources into a logical unit, allowing for faster reversions and better history display. The changeset can be auto-created through a POST, PUT, or DELETE to a resource, or it can be created independently and specified by adding changeset=<ID> URI parameter (i.e., PUT /browsers/15?changeset=73).

The representation includes:

• attributes

  • id (server selected) - Database ID
  • created (server selected) - When the changeset was created, in ISO 8601 format.
  • modified (server selected) - When the changeset was last modified, in ISO 8601 format.
  • target_resource_type (write-once, optional) - The name of the primary resource for this changeset, for example “browsers”, “versions”, etc.
  • target_resource_id (write-once, optional) - The ID of the primary resource for this changeset.
  • closed - True if the changeset is closed to new changes. Auto-created changesets are auto-closed, and cache invalidation is delayed until manually created changesets are closed.

• relationships

  • user (one) - The user who initiated this changeset, can not be changed.
  • historical_browsers (many) - Associated historical_browsers, in ID order, changes are ignored.
  • historical_features (many) - Associated historical_features, in ID order, changes are ignored.
  • historical_maturities (many) - Associated historical_maturities, in ID order, changes are ignored.
  • historical_sections (many) - Associated historical_sections, in ID order, changes are ignored.
  • historical_specifications (many) - Associated historical_specifications, in ID order, changes are ignored.
  • historical_supports (many) - Associated historical_supports, in ID order, changes are ignored.
  • historical_versions (many) - Associated historical_versions, in ID order, changes are ignored.

Here’s an example changeset resource:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/changesets/2"
    },
    "data": {
        "type": "changesets",
        "id": "2",
        "attributes": {
            "created": "2016-01-14T17:24:04.159902Z",
            "modified": "2016-01-14T17:24:30.537134Z",
            "closed": true,
            "target_resource_type": null,
            "target_resource_id": null
        },
        "relationships": {
            "user": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/user",
                    "related": "https://browsercompat.org/api/v2/changesets/2/user"
                },
                "data": {
                    "type": "users",
                    "id": "1"
                }
            },
            "historical_browsers": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_browsers",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_browsers"
                },
                "data": [
                    {
                        "type": "historical_browsers",
                        "id": "16"
                    }
                ]
            },
            "historical_features": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_features",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_features"
                },
                "data": []
            },
            "historical_maturities": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_maturities",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_maturities"
                },
                "data": []
            },
            "historical_sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_sections",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_sections"
                },
                "data": []
            },
            "historical_specifications": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_specifications",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_specifications"
                },
                "data": []
            },
            "historical_supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_supports",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_supports"
                },
                "data": []
            },
            "historical_versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/2/relationships/historical_versions",
                    "related": "https://browsercompat.org/api/v2/changesets/2/historical_versions"
                },
                "data": []
            }
        }
    }
}

Historical Browsers

A historical_browser resource represents the state of a browser at a point in time, and who is responsible for that state. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The browsers representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • browser (one) - Associated browser, can not be changed

Here is a sample historical_browser:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_browsers/17"
    },
    "data": {
        "type": "historical_browsers",
        "id": "17",
        "attributes": {
            "date": "2016-01-14T06:30:59.618000Z",
            "event": "created",
            "archive_data": {
                "type": "browsers",
                "id": "17",
                "attributes": {
                    "slug": "konqueror",
                    "name": {
                        "en": "Konqueror"
                    },
                    "note": {
                        "en": "First comes the Navigator, then Explorer, and then the Konqueror."
                    }
                },
                "relationships": {
                    "versions": {
                        "data": []
                    },
                    "history_current": {
                        "data": {
                            "type": "historical_browsers",
                            "id": "17"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/browsers/17"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_browsers/17/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_browsers/17/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "3"
                }
            },
            "browser": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_browsers/17/relationships/browser",
                    "related": "https://browsercompat.org/api/v2/historical_browsers/17/browser"
                },
                "data": {
                    "type": "browsers",
                    "id": "17"
                }
            }
        }
    }
}

Historical Versions

A historical_versions resource represents the state of a version at a point in time, and who is responsible for that representation. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The versions representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • version (one) - Associated version, can not be changed

Here is a sample historical_version:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_versions/49"
    },
    "data": {
        "type": "historical_versions",
        "id": "49",
        "attributes": {
            "date": "2016-01-14T07:52:04.749000Z",
            "event": "created",
            "archive_data": {
                "type": "versions",
                "id": "49",
                "attributes": {
                    "version": "19.0",
                    "release_day": "2013-02-19",
                    "retirement_day": "2013-04-02",
                    "status": "retired",
                    "release_notes_uri": {
                        "en": "https://developer.mozilla.org/en/Firefox/Releases/19",
                        "de": "https://developer.mozilla.org/de/Firefox/Releases/19",
                        "es": "https://developer.mozilla.org/es/docs/Firefox_19_para_desarrolladores",
                        "fr": "https://developer.mozilla.org/fr/Firefox/Versions/19",
                        "ja": "https://developer.mozilla.org/ja/Firefox/Releases/19",
                        "ko": "https://developer.mozilla.org/ko/Firefox/Releases/19",
                        "pl": "https://developer.mozilla.org/pl/Firefox/Releases/19",
                        "pt-PT": "https://developer.mozilla.org/pt-PT/Firefox/Releases/19",
                        "ru": "https://developer.mozilla.org/ru/Firefox/Releases/19",
                        "zh-CN": "https://developer.mozilla.org/zh-CN/Firefox/Releases/19",
                        "zh-TW": "https://developer.mozilla.org/zh-TW/Firefox/Releases/19"
                    },
                    "note": {
                        "en": "Released to beta channel on January 10, 2013"
                    },
                    "order": 6
                },
                "relationships": {
                    "browser": {
                        "data": {
                            "type": "browsers",
                            "id": "7"
                        }
                    },
                    "history_current": {
                        "data": {
                            "type": "historical_versions",
                            "id": "49"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/49"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_versions/49/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_versions/49/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "13"
                }
            },
            "version": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_versions/49/relationships/version",
                    "related": "https://browsercompat.org/api/v2/historical_versions/49/version"
                },
                "data": {
                    "type": "versions",
                    "id": "49"
                }
            }
        }
    }
}

Historical Features

A historical_features resource represents the state of a feature at a point in time, and who is responsible for that representation. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The features representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • feature (one) - Associated feature, can not be changed

Here is a sample historical_feature:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_features/19"
    },
    "data": {
        "type": "historical_features",
        "id": "19",
        "attributes": {
            "date": "2016-01-14T08:02:33.132000Z",
            "event": "created",
            "archive_data": {
                "type": "features",
                "id": "17",
                "attributes": {
                    "slug": "web-html-element",
                    "mdn_uri": null,
                    "experimental": false,
                    "standardized": true,
                    "stable": true,
                    "obsolete": false,
                    "name": {
                        "en": "Element"
                    }
                },
                "relationships": {
                    "parent": {
                        "data": {
                            "type": "features",
                            "id": "16"
                        }
                    },
                    "children": {
                        "data": []
                    },
                    "sections": {
                        "data": []
                    },
                    "history_current": {
                        "data": {
                            "type": "historical_features",
                            "id": "19"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/features/17"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_features/19/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_features/19/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "27"
                }
            },
            "feature": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_features/19/relationships/feature",
                    "related": "https://browsercompat.org/api/v2/historical_features/19/feature"
                },
                "data": {
                    "type": "features",
                    "id": "17"
                }
            }
        }
    }
}

Historical Supports

A historical_supports resource represents the state of a support at a point in time, and who is responsible for that representation. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The supports representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • support (one) - Associated support, can not be changed

Here is a sample historical_support:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_supports/28"
    },
    "data": {
        "type": "historical_supports",
        "id": "28",
        "attributes": {
            "date": "2016-01-14T08:08:03.582000Z",
            "event": "created",
            "archive_data": {
                "type": "supports",
                "id": "28",
                "attributes": {
                    "support": "partial",
                    "prefix": "-o",
                    "prefix_mandatory": true,
                    "alternate_name": "float",
                    "alternate_mandatory": true,
                    "requires_config": "future=true",
                    "default_config": "future=false",
                    "protected": true,
                    "note": {
                        "en": "This is fake."
                    }
                },
                "relationships": {
                    "version": {
                        "data": {
                            "type": "versions",
                            "id": "37"
                        }
                    },
                    "feature": {
                        "data": {
                            "type": "features",
                            "id": "6"
                        }
                    },
                    "history_current": {
                        "data": {
                            "type": "historical_supports",
                            "id": "28"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/28"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_supports/28/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_supports/28/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "36"
                }
            },
            "support": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_supports/28/relationships/support",
                    "related": "https://browsercompat.org/api/v2/historical_supports/28/support"
                },
                "data": {
                    "type": "supports",
                    "id": "28"
                }
            }
        }
    }
}

Historical Specifications

A historical_specifications resource represents the state of a specification at a point in time, and who is responsible for that representation. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The specifications representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • specification (one) - Associated specification, can not be changed

Here is a sample historical_specification:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_specifications/7"
    },
    "data": {
        "type": "historical_specifications",
        "id": "7",
        "attributes": {
            "date": "2016-01-14T08:07:26.056000Z",
            "event": "created",
            "archive_data": {
                "type": "specifications",
                "id": "7",
                "attributes": {
                    "slug": "css3-ruby",
                    "mdn_key": "CSS3 Ruby",
                    "name": {
                        "en": "CSS Ruby Layout Module Level 1"
                    },
                    "uri": {
                        "en": "http://dev.w3.org/csswg/css-ruby/"
                    }
                },
                "relationships": {
                    "maturity": {
                        "data": {
                            "type": "maturities",
                            "id": "2"
                        }
                    },
                    "sections": {
                        "data": []
                    },
                    "history_current": {
                        "data": {
                            "type": "historical_specifications",
                            "id": "7"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/specifications/7"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_specifications/7/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_specifications/7/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "40"
                }
            },
            "specification": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_specifications/7/relationships/specification",
                    "related": "https://browsercompat.org/api/v2/historical_specifications/7/specification"
                },
                "data": {
                    "type": "specifications",
                    "id": "7"
                }
            }
        }
    }
}

Historical Sections

A historical_sections resource represents the state of a section at a point in time, and who is responsible for that representation. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The sections representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • section (one) - Associated section, can not be changed

Here is a sample historical_section:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_sections/8"
    },
    "data": {
        "type": "historical_sections",
        "id": "8",
        "attributes": {
            "date": "2016-01-14T08:05:47.948000Z",
            "event": "created",
            "archive_data": {
                "type": "sections",
                "id": "8",
                "attributes": {
                    "number": {
                        "en": "2.1"
                    },
                    "name": {
                        "en": "Ruby-specific 'display' Values"
                    },
                    "subpath": {
                        "en": "#ruby-display"
                    },
                    "note": null
                },
                "relationships": {
                    "specification": {
                        "data": {
                            "type": "specifications",
                            "id": "5"
                        }
                    },
                    "history_current": {
                        "data": {
                            "type": "historical_sections",
                            "id": "8"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/sections/8"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_sections/8/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_sections/8/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "46"
                }
            },
            "section": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_sections/8/relationships/section",
                    "related": "https://browsercompat.org/api/v2/historical_sections/8/section"
                },
                "data": {
                    "type": "sections",
                    "id": "8"
                }
            }
        }
    }
}

Historical Maturities

A historical_maturities resource represents the state of a maturity at a point in time, and who is responsible for that representation. The representation includes:

• attributes

  • id (server selected) - Database ID
  • date (server selected) - The time of this change in ISO 8601
  • event (server selected) - The type of event, one of "created", "changed", or "deleted"
  • archive_data - The maturities representation at this point in time

• relationships

  • changeset (one) - Associated changeset, can not be changed.
  • maturity (one) - Associated maturity, can not be changed

Here is a sample historical_maturity:

{
    "links": {
        "self": "https://browsercompat.org/api/v2/historical_maturities/10"
    },
    "data": {
        "type": "historical_maturities",
        "id": "10",
        "attributes": {
            "date": "2016-01-14T08:04:58.382000Z",
            "event": "created",
            "archive_data": {
                "type": "maturities",
                "id": "10",
                "attributes": {
                    "slug": "Idea",
                    "name": {
                        "en": "Idea"
                    }
                },
                "relationships": {
                    "history_current": {
                        "data": {
                            "type": "historical_maturities",
                            "id": "10"
                        }
                    }
                },
                "links": {
                    "self": "https://browsercompat.org/api/v2/maturities/10"
                }
            }
        },
        "relationships": {
            "changeset": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_maturities/10/relationships/changeset",
                    "related": "https://browsercompat.org/api/v2/historical_maturities/10/changeset"
                },
                "data": {
                    "type": "changesets",
                    "id": "52"
                }
            },
            "maturity": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/historical_maturities/10/relationships/maturity",
                    "related": "https://browsercompat.org/api/v2/historical_maturities/10/maturity"
                },
                "data": {
                    "type": "maturities",
                    "id": "10"
                }
            }
        }
    }
}

Views

A View is a combination of resources for a particular presentation. It is suitable for anonymous viewing of content. It uses the flexibility of the JSON API specification to include a basket of related resources in a response, but doesn’t use the official method of Inclusion of Related Resources.

View a Feature

This view collects the data for a feature, including the related resources needed to display it on MDN.

Here is a simple example, the view for the CSS property float:

GET /api/v2/view_features/5 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/view_features/5"
    },
    "data": {
        "type": "features",
        "id": "5",
        "attributes": {
            "slug": "web-css-float",
            "mdn_uri": {
                "en": "https://developer.mozilla.org/en-US/docs/Web/CSS/float",
                "de": "https://developer.mozilla.org/de/docs/Web/CSS/float",
                "es": "https://developer.mozilla.org/es/docs/Web/CSS/float",
                "ja": "https://developer.mozilla.org/ja/docs/Web/CSS/float",
                "ru": "https://developer.mozilla.org/ru/docs/Web/CSS/float"
            },
            "experimental": false,
            "standardized": true,
            "stable": true,
            "obsolete": false,
            "name": "float"
        },
        "relationships": {
            "parent": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/parent",
                    "related": "https://browsercompat.org/api/v2/view_features/5/parent"
                },
                "data": {
                    "type": "features",
                    "id": "2"
                }
            },
            "children": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/children",
                    "related": "https://browsercompat.org/api/v2/view_features/5/children"
                },
                "data": [
                    {
                        "type": "features",
                        "id": "6"
                    }
                ]
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/view_features/5/sections"
                },
                "data": [
                    {
                        "type": "sections",
                        "id": "1"
                    },
                    {
                        "type": "sections",
                        "id": "2"
                    },
                    {
                        "type": "sections",
                        "id": "3"
                    }
                ]
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/view_features/5/supports"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/view_features/5/history_current"
                },
                "data": {
                    "type": "historical_features",
                    "id": "5"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/history",
                    "related": "https://browsercompat.org/api/v2/view_features/5/history"
                },
                "data": [
                    {
                        "type": "historical_features",
                        "id": "5"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "browsers",
            "id": "1",
            "attributes": {
                "slug": "android",
                "name": {
                    "en": "Android Browser"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/1"
            }
        },
        {
            "type": "browsers",
            "id": "2",
            "attributes": {
                "slug": "android_webview",
                "name": {
                    "en": "Android Webview"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/2"
            }
        },
        {
            "type": "browsers",
            "id": "4",
            "attributes": {
                "slug": "chrome_desktop",
                "name": {
                    "en": "Chrome for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/4"
            }
        },
        {
            "type": "browsers",
            "id": "6",
            "attributes": {
                "slug": "firefox_android",
                "name": {
                    "en": "Firefox for Android"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/6"
            }
        },
        {
            "type": "browsers",
            "id": "7",
            "attributes": {
                "slug": "firefox_desktop",
                "name": {
                    "en": "Firefox for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "7"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "7"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/7"
            }
        },
        {
            "type": "browsers",
            "id": "9",
            "attributes": {
                "slug": "ie_desktop",
                "name": {
                    "en": "Internet Explorer for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "24"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "24"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "23"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "22"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "21"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "20"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "19"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/9"
            }
        },
        {
            "type": "browsers",
            "id": "10",
            "attributes": {
                "slug": "ie_mobile",
                "name": {
                    "en": "Internet Explorer Mobile"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "10"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "10"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/10"
            }
        },
        {
            "type": "browsers",
            "id": "11",
            "attributes": {
                "slug": "opera_desktop",
                "name": {
                    "en": "Opera for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "11"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "11"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/11"
            }
        },
        {
            "type": "browsers",
            "id": "14",
            "attributes": {
                "slug": "safari_desktop",
                "name": {
                    "en": "Safari for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "14"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "14"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/14"
            }
        },
        {
            "type": "browsers",
            "id": "15",
            "attributes": {
                "slug": "safari_ios",
                "name": {
                    "en": "Safari for iOS"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "15"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "15"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/15"
            }
        },
        {
            "type": "versions",
            "id": "2",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/2"
            }
        },
        {
            "type": "versions",
            "id": "4",
            "attributes": {
                "version": "current",
                "release_day": null,
                "retirement_day": null,
                "status": "current",
                "release_notes_uri": null,
                "note": null,
                "order": 0
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "2"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/4"
            }
        },
        {
            "type": "versions",
            "id": "9",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "4"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "9"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/9"
            }
        },
        {
            "type": "versions",
            "id": "15",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "15"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "15"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/15"
            }
        },
        {
            "type": "versions",
            "id": "18",
            "attributes": {
                "version": "1.0",
                "release_day": "2004-11-09",
                "retirement_day": "2005-11-29",
                "status": "retired",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "18"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "18"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/18"
            }
        },
        {
            "type": "versions",
            "id": "26",
            "attributes": {
                "version": "4.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "9"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "26"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "26"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/26"
            }
        },
        {
            "type": "versions",
            "id": "32",
            "attributes": {
                "version": "6.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 2
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "10"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "32"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "32"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/32"
            }
        },
        {
            "type": "versions",
            "id": "34",
            "attributes": {
                "version": "7.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "11"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "34"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "34"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/34"
            }
        },
        {
            "type": "versions",
            "id": "42",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "14"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "42"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "42"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/42"
            }
        },
        {
            "type": "versions",
            "id": "44",
            "attributes": {
                "version": "5.1",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 3
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "14"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "44"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "44"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/44"
            }
        },
        {
            "type": "versions",
            "id": "46",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "15"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "46"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "46"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/46"
            }
        },
        {
            "type": "supports",
            "id": "1",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "2"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/1"
            }
        },
        {
            "type": "supports",
            "id": "2",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "9"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/2"
            }
        },
        {
            "type": "supports",
            "id": "3",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "15"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/3"
            }
        },
        {
            "type": "supports",
            "id": "4",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "18"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/4"
            }
        },
        {
            "type": "supports",
            "id": "5",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "26"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "5"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "5"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/5"
            }
        },
        {
            "type": "supports",
            "id": "6",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "32"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/6"
            }
        },
        {
            "type": "supports",
            "id": "7",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "34"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "7"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "7"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/7"
            }
        },
        {
            "type": "supports",
            "id": "8",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "42"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "8"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "8"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/8"
            }
        },
        {
            "type": "supports",
            "id": "9",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "44"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "9"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/9"
            }
        },
        {
            "type": "supports",
            "id": "10",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "46"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "10"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "10"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/10"
            }
        },
        {
            "type": "supports",
            "id": "27",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "4"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "27"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "27"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/27"
            }
        },
        {
            "type": "maturities",
            "id": "1",
            "attributes": {
                "slug": "REC",
                "name": {
                    "en": "Recommendation",
                    "de": "Empfehlung",
                    "ja": "勧告",
                    "ru": "Рекомендация"
                }
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_maturities",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_maturities",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/maturities/1"
            }
        },
        {
            "type": "maturities",
            "id": "2",
            "attributes": {
                "slug": "WD",
                "name": {
                    "en": "Working Draft",
                    "de": "Arbeitsentwurf",
                    "ja": "草案",
                    "ru": "Рабочий черновик"
                }
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_maturities",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_maturities",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/maturities/2"
            }
        },
        {
            "type": "specifications",
            "id": "1",
            "attributes": {
                "slug": "css1",
                "mdn_key": "CSS1",
                "name": {
                    "en": "CSS Level 1"
                },
                "uri": {
                    "en": "http://www.w3.org/TR/CSS1/"
                }
            },
            "relationships": {
                "maturity": {
                    "data": {
                        "type": "maturities",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_specifications",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_specifications",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/specifications/1"
            }
        },
        {
            "type": "specifications",
            "id": "2",
            "attributes": {
                "slug": "css2_1",
                "mdn_key": "CSS2.1",
                "name": {
                    "en": "CSS Level 2 (Revision 1)"
                },
                "uri": {
                    "en": "http://www.w3.org/TR/CSS2/"
                }
            },
            "relationships": {
                "maturity": {
                    "data": {
                        "type": "maturities",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_specifications",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_specifications",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/specifications/2"
            }
        },
        {
            "type": "specifications",
            "id": "3",
            "attributes": {
                "slug": "css3_box",
                "mdn_key": "CSS3 Box",
                "name": {
                    "en": "CSS Basic Box Model"
                },
                "uri": {
                    "en": "http://dev.w3.org/csswg/css3-box/"
                }
            },
            "relationships": {
                "maturity": {
                    "data": {
                        "type": "maturities",
                        "id": "2"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_specifications",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_specifications",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/specifications/3"
            }
        },
        {
            "type": "sections",
            "id": "1",
            "attributes": {
                "number": {
                    "en": "5.5.25"
                },
                "name": {
                    "en": "'float'"
                },
                "subpath": {
                    "en": "#float"
                },
                "note": {
                    "en": "Initial definition."
                }
            },
            "relationships": {
                "specification": {
                    "data": {
                        "type": "specifications",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_sections",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_sections",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/sections/1"
            }
        },
        {
            "type": "sections",
            "id": "2",
            "attributes": {
                "number": {
                    "en": "9.5.1"
                },
                "name": {
                    "en": "Positioning the float: the 'float' property"
                },
                "subpath": {
                    "en": "visuren.html#float-position"
                },
                "note": {
                    "en": "No change."
                }
            },
            "relationships": {
                "specification": {
                    "data": {
                        "type": "specifications",
                        "id": "2"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_sections",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_sections",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/sections/2"
            }
        },
        {
            "type": "sections",
            "id": "3",
            "attributes": {
                "number": {
                    "en": "16"
                },
                "name": {
                    "en": "The float property"
                },
                "subpath": {
                    "en": "#the-float-property"
                },
                "note": {
                    "en": "Lots of new values, not all clearly defined yet. Any differences in behavior unrelated to new features are expected to be unintentional; please report."
                }
            },
            "relationships": {
                "specification": {
                    "data": {
                        "type": "specifications",
                        "id": "3"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_sections",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_sections",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/sections/3"
            }
        },
        {
            "type": "features",
            "id": "6",
            "attributes": {
                "slug": "web-css-float_basic-support",
                "mdn_uri": null,
                "experimental": false,
                "standardized": true,
                "stable": true,
                "obsolete": false,
                "name": {
                    "en": "Basic Support",
                    "ja": "基本サポート"
                }
            },
            "relationships": {
                "parent": {
                    "data": {
                        "type": "features",
                        "id": "5"
                    }
                },
                "children": {
                    "data": []
                },
                "sections": {
                    "data": []
                },
                "supports": {
                    "data": [
                        {
                            "type": "supports",
                            "id": "1"
                        },
                        {
                            "type": "supports",
                            "id": "2"
                        },
                        {
                            "type": "supports",
                            "id": "3"
                        },
                        {
                            "type": "supports",
                            "id": "4"
                        },
                        {
                            "type": "supports",
                            "id": "5"
                        },
                        {
                            "type": "supports",
                            "id": "6"
                        },
                        {
                            "type": "supports",
                            "id": "7"
                        },
                        {
                            "type": "supports",
                            "id": "8"
                        },
                        {
                            "type": "supports",
                            "id": "9"
                        },
                        {
                            "type": "supports",
                            "id": "10"
                        },
                        {
                            "type": "supports",
                            "id": "27"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_features",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_features",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/features/6"
            }
        }
    ],
    "meta": {
        "compat_table": {
            "supports": {
                "5": {},
                "6": {
                    "1": [
                        "1"
                    ],
                    "2": [
                        "27"
                    ],
                    "4": [
                        "2"
                    ],
                    "6": [
                        "3"
                    ],
                    "7": [
                        "4"
                    ],
                    "9": [
                        "5"
                    ],
                    "10": [
                        "6"
                    ],
                    "11": [
                        "7"
                    ],
                    "14": [
                        "8"
                    ],
                    "15": [
                        "10"
                    ]
                }
            },
            "tabs": [
                {
                    "name": {
                        "en": "Desktop Browsers"
                    },
                    "browsers": [
                        "4",
                        "7",
                        "9",
                        "11",
                        "14"
                    ]
                },
                {
                    "name": {
                        "en": "Mobile Browsers"
                    },
                    "browsers": [
                        "1",
                        "2",
                        "6",
                        "10",
                        "15"
                    ]
                }
            ],
            "child_pages": false,
            "pagination": {
                "linked.features": {
                    "previous": null,
                    "next": null,
                    "count": 1
                }
            },
            "languages": [
                "en",
                "de",
                "es",
                "ja",
                "ru"
            ],
            "notes": {}
        }
    }
}

Generating a Compatibility Table

One way to use this representation is:

1. Parse /data and /included into an in-memory object store, so that you can load a resource given the type and ID.

2. Create the “Specifications” section:

   1. Add the Specifications header

   2. Create an HTML table with a header row “Specification”, “Status”, “Comment”

   3. For each id in /data/relationships/sections ("1", "2", "3"`):

      • Load the section, specification, and maturity
      • Add the first column: a link to (specification).attributes.uri.(lang or en) + (section).attributes.subpath.(lang or en), with link text (specification).attributes.name.(lang or en), with title based on (section).attributes.name.(lang or en) or data.attributes.name.(lang or en).
      • Add the second column: A span with class “spec-” + (maturity).attributes.slug, and the text (maturity).attributes.name.(lang or en).
      • Add the third column: (maturity).attributes.notes.(lang or en), or empty string

   4. Close the table, and add an edit button.

3. Create the Browser Compatibility section:

   1. Add The “Browser compatibility” header

   2. For each item in /meta/compat_table/tabs:

      • Create a table with the proper name (“Desktop”, “Mobile”)
      • Load the browser by ID in /browsers
      • Add a column the translated browser name

   3. For the main feature in /data and each feature in /data/relationships/children:

      • Add the first column: the feature name (attributes/name). If it is a string, then wrap in <code>. Otherwise, use the best translation of name, in a lang=(lang) block. A good name for the main feature is “Basic Support”.

      • Add any feature flags, such as an obsolete or experimental icon, based on the feature flags.

      • Load the supports reference list in /meta/compat_table/supports/(feature ID)/(browser ID)/(support IDs)

      • For each browsers’ supports reference list:

        • If no supports, then display ”?”
        • If just one support, display “<version>”, or “<support>”, depending on the defined attributes
        • If multiple supports, display as subcells
        • Add prefixes, alternate names, config, and notes link as appropriate

   4. Close each table, add an edit button

   5. Add notes for displayed supports

This may be done by including the JSON in the page as sent over the wire, or loaded asynchronously, with the tables built after initial page load.

This can also be used by a “caniuse” table layout by ignoring the meta section and displaying all the included data. This will require more client-side processing to generate, or additional data in the <meta> section.

Including Child Pages

By default, view_feature only includes row children, which are subfeatures that are represented as rows in the MDN table. These row children are identified by not having a value for mdn_uri.

There can also be page children, which are represented as more detailed page on MDN. For example, Web/CSS has the page child Web/CSS/Display. By default, these are not included, but can be included by setting the query parameter child_pages=1:

GET /api/v2/view_features/2?child_pages=1 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json

Updating Views with Changesets

Updating the page requires a sequence of requests. For example, if a user wants to change Chrome support for <address> from an unknown version to version 2, you’ll have to create the version for that version, then add the support for the support.

The first step is to create a changeset as an authenticated user:

POST /api/v2/changesets HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 173
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "changesets",
        "attributes": {
            "target_resource_type": "features",
            "target_resource_id": "6"
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/changesets"
    },
    "data": {
        "type": "changesets",
        "id": "56",
        "attributes": {
            "created": "2016-01-14T08:16:02.171000Z",
            "modified": "2016-01-14T08:16:06.763000Z",
            "closed": false,
            "target_resource_type": "features",
            "target_resource_id": 6
        },
        "relationships": {
            "user": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/user",
                    "related": "https://browsercompat.org/api/v2/changesets/user"
                },
                "data": {
                    "type": "users",
                    "id": "1"
                }
            },
            "historical_browsers": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_browsers",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_browsers"
                },
                "data": []
            },
            "historical_features": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_features",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_features"
                },
                "data": []
            },
            "historical_maturities": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_maturities",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_maturities"
                },
                "data": []
            },
            "historical_sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_sections",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_sections"
                },
                "data": []
            },
            "historical_specifications": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_specifications",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_specifications"
                },
                "data": []
            },
            "historical_supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_supports",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_supports"
                },
                "data": []
            },
            "historical_versions": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/changesets/relationships/historical_versions",
                    "related": "https://browsercompat.org/api/v2/changesets/historical_versions"
                },
                "data": []
            }
        }
    }
}

Next, use the changeset ID when creating the version:

POST /api/v2/versions?changeset=56 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 338
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "versions",
        "attributes": {
            "version": "2.0",
            "status": "retired"
        },
        "relationships": {
            "browser": {
                "data": {
                    "type": "browsers",
                    "id": "3"
                }
            }
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/versions?changeset=56"
    },
    "data": {
        "type": "versions",
        "id": "50",
        "attributes": {
            "version": "2.0",
            "release_day": null,
            "retirement_day": null,
            "status": "retired",
            "release_notes_uri": null,
            "note": null,
            "order": 3
        },
        "relationships": {
            "browser": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/relationships/browser",
                    "related": "https://browsercompat.org/api/v2/versions/browser"
                },
                "data": {
                    "type": "browsers",
                    "id": "3"
                }
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/versions/supports"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/versions/history_current"
                },
                "data": {
                    "type": "historical_versions",
                    "id": "54"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/versions/relationships/history",
                    "related": "https://browsercompat.org/api/v2/versions/history"
                },
                "data": [
                    {
                        "type": "historical_versions",
                        "id": "54"
                    }
                ]
            }
        }
    }
}

Finally, create the support:

POST /api/v2/supports?changeset=56 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 396
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "type": "supports",
        "relationships": {
            "version": {
                "data": {
                    "type": "versions",
                    "id": "50"
                }
            },
            "feature": {
                "data": {
                    "type": "features",
                    "id": "6"
                }
            }
        }
    }
}

A sample response is:

HTTP/1.1 201 CREATED
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/supports?changeset=56"
    },
    "data": {
        "type": "supports",
        "id": "29",
        "attributes": {
            "support": "yes",
            "prefix": null,
            "prefix_mandatory": false,
            "alternate_name": null,
            "alternate_mandatory": false,
            "requires_config": null,
            "default_config": null,
            "protected": false,
            "note": null
        },
        "relationships": {
            "version": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/relationships/version",
                    "related": "https://browsercompat.org/api/v2/supports/version"
                },
                "data": {
                    "type": "versions",
                    "id": "50"
                }
            },
            "feature": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/relationships/feature",
                    "related": "https://browsercompat.org/api/v2/supports/feature"
                },
                "data": {
                    "type": "features",
                    "id": "6"
                }
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/supports/history_current"
                },
                "data": {
                    "type": "historical_supports",
                    "id": "32"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/supports/relationships/history",
                    "related": "https://browsercompat.org/api/v2/supports/history"
                },
                "data": [
                    {
                        "type": "historical_supports",
                        "id": "32"
                    }
                ]
            }
        }
    }
}

The historical_versions and historical_supports resources will both refer to changeset 56, and this changeset is linked to feature 6, despite the fact that no changes were made to the feature. This will facilitate displaying a history of the compatibility tables, for the purpose of reviewing changes and reverting vandalism.

Updating View with PUT

view_features supports PUT for bulk updates of support data. Here is a simple example that adds a new subfeature without support:

PATCH /api/v2/view_features/5 HTTP/1.1
Host: browsercompat.org
Accept: application/vnd.api+json
Content-Length: 590
Content-Type: application/vnd.api+json
Cookie: csrftoken=p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn; sessionid=wurexa2wq416ftlvd5plesngwa28183h
X-Csrftoken: p7FqFyNp6hZS0FJYKyQxVmLrZILldjqn

{
    "data": {
        "id": "5",
        "type": "features"
    },
    "included": [
        {
            "type": "features",
            "id": "_New Subfeature",
            "attributes": {
                "slug": "web-css-float_new-subfeature",
                "name": {
                    "en": "New Subfeature"
                }
            },
            "relationships": {
                "parent": {
                    "data": {
                        "type": "features",
                        "id": "5"
                    }
                }
            }
        }
    ]
}

A sample response is:

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "links": {
        "self": "https://browsercompat.org/api/v2/view_features/5"
    },
    "data": {
        "type": "features",
        "id": "5",
        "attributes": {
            "slug": "web-css-float",
            "mdn_uri": {
                "en": "https://developer.mozilla.org/en-US/docs/Web/CSS/float",
                "de": "https://developer.mozilla.org/de/docs/Web/CSS/float",
                "es": "https://developer.mozilla.org/es/docs/Web/CSS/float",
                "ja": "https://developer.mozilla.org/ja/docs/Web/CSS/float",
                "ru": "https://developer.mozilla.org/ru/docs/Web/CSS/float"
            },
            "experimental": false,
            "standardized": true,
            "stable": true,
            "obsolete": false,
            "name": "float"
        },
        "relationships": {
            "parent": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/parent",
                    "related": "https://browsercompat.org/api/v2/view_features/5/parent"
                },
                "data": {
                    "type": "features",
                    "id": "2"
                }
            },
            "children": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/children",
                    "related": "https://browsercompat.org/api/v2/view_features/5/children"
                },
                "data": [
                    {
                        "type": "features",
                        "id": "6"
                    },
                    {
                        "type": "features",
                        "id": "19"
                    }
                ]
            },
            "sections": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/sections",
                    "related": "https://browsercompat.org/api/v2/view_features/5/sections"
                },
                "data": [
                    {
                        "type": "sections",
                        "id": "1"
                    },
                    {
                        "type": "sections",
                        "id": "2"
                    },
                    {
                        "type": "sections",
                        "id": "3"
                    }
                ]
            },
            "supports": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/supports",
                    "related": "https://browsercompat.org/api/v2/view_features/5/supports"
                },
                "data": []
            },
            "history_current": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/history_current",
                    "related": "https://browsercompat.org/api/v2/view_features/5/history_current"
                },
                "data": {
                    "type": "historical_features",
                    "id": "27"
                }
            },
            "history": {
                "links": {
                    "self": "https://browsercompat.org/api/v2/view_features/5/relationships/history",
                    "related": "https://browsercompat.org/api/v2/view_features/5/history"
                },
                "data": [
                    {
                        "type": "historical_features",
                        "id": "27"
                    },
                    {
                        "type": "historical_features",
                        "id": "5"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "type": "browsers",
            "id": "1",
            "attributes": {
                "slug": "android",
                "name": {
                    "en": "Android Browser"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/1"
            }
        },
        {
            "type": "browsers",
            "id": "2",
            "attributes": {
                "slug": "android_webview",
                "name": {
                    "en": "Android Webview"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/2"
            }
        },
        {
            "type": "browsers",
            "id": "3",
            "attributes": {
                "slug": "blackberry",
                "name": {
                    "en": "BlackBerry Browser"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/3"
            }
        },
        {
            "type": "browsers",
            "id": "4",
            "attributes": {
                "slug": "chrome_desktop",
                "name": {
                    "en": "Chrome for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/4"
            }
        },
        {
            "type": "browsers",
            "id": "6",
            "attributes": {
                "slug": "firefox_android",
                "name": {
                    "en": "Firefox for Android"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/6"
            }
        },
        {
            "type": "browsers",
            "id": "7",
            "attributes": {
                "slug": "firefox_desktop",
                "name": {
                    "en": "Firefox for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "7"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "7"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/7"
            }
        },
        {
            "type": "browsers",
            "id": "9",
            "attributes": {
                "slug": "ie_desktop",
                "name": {
                    "en": "Internet Explorer for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "24"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "24"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "23"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "22"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "21"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "20"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "19"
                        },
                        {
                            "type": "historical_browsers",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/9"
            }
        },
        {
            "type": "browsers",
            "id": "10",
            "attributes": {
                "slug": "ie_mobile",
                "name": {
                    "en": "Internet Explorer Mobile"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "10"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "10"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/10"
            }
        },
        {
            "type": "browsers",
            "id": "11",
            "attributes": {
                "slug": "opera_desktop",
                "name": {
                    "en": "Opera for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "11"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "11"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/11"
            }
        },
        {
            "type": "browsers",
            "id": "14",
            "attributes": {
                "slug": "safari_desktop",
                "name": {
                    "en": "Safari for Desktop"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "14"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "14"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/14"
            }
        },
        {
            "type": "browsers",
            "id": "15",
            "attributes": {
                "slug": "safari_ios",
                "name": {
                    "en": "Safari for iOS"
                },
                "note": null
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_browsers",
                        "id": "15"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_browsers",
                            "id": "15"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/browsers/15"
            }
        },
        {
            "type": "versions",
            "id": "2",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/2"
            }
        },
        {
            "type": "versions",
            "id": "4",
            "attributes": {
                "version": "current",
                "release_day": null,
                "retirement_day": null,
                "status": "current",
                "release_notes_uri": null,
                "note": null,
                "order": 0
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "2"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/4"
            }
        },
        {
            "type": "versions",
            "id": "9",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "4"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "9"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/9"
            }
        },
        {
            "type": "versions",
            "id": "15",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "15"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "15"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/15"
            }
        },
        {
            "type": "versions",
            "id": "18",
            "attributes": {
                "version": "1.0",
                "release_day": "2004-11-09",
                "retirement_day": "2005-11-29",
                "status": "retired",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "7"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "18"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "18"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/18"
            }
        },
        {
            "type": "versions",
            "id": "26",
            "attributes": {
                "version": "4.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "9"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "26"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "26"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/26"
            }
        },
        {
            "type": "versions",
            "id": "32",
            "attributes": {
                "version": "6.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 2
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "10"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "32"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "32"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/32"
            }
        },
        {
            "type": "versions",
            "id": "34",
            "attributes": {
                "version": "7.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "11"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "34"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "34"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/34"
            }
        },
        {
            "type": "versions",
            "id": "42",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "14"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "42"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "42"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/42"
            }
        },
        {
            "type": "versions",
            "id": "44",
            "attributes": {
                "version": "5.1",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 3
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "14"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "44"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "44"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/44"
            }
        },
        {
            "type": "versions",
            "id": "46",
            "attributes": {
                "version": "1.0",
                "release_day": null,
                "retirement_day": null,
                "status": "unknown",
                "release_notes_uri": null,
                "note": null,
                "order": 1
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "15"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "46"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "46"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/46"
            }
        },
        {
            "type": "versions",
            "id": "50",
            "attributes": {
                "version": "2.0",
                "release_day": null,
                "retirement_day": null,
                "status": "retired",
                "release_notes_uri": null,
                "note": null,
                "order": 3
            },
            "relationships": {
                "browser": {
                    "data": {
                        "type": "browsers",
                        "id": "3"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_versions",
                        "id": "54"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_versions",
                            "id": "54"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/versions/50"
            }
        },
        {
            "type": "supports",
            "id": "1",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "2"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/1"
            }
        },
        {
            "type": "supports",
            "id": "2",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "9"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/2"
            }
        },
        {
            "type": "supports",
            "id": "3",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "15"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/3"
            }
        },
        {
            "type": "supports",
            "id": "4",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "18"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "4"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "4"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/4"
            }
        },
        {
            "type": "supports",
            "id": "5",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "26"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "5"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "5"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/5"
            }
        },
        {
            "type": "supports",
            "id": "6",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "32"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/6"
            }
        },
        {
            "type": "supports",
            "id": "7",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "34"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "7"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "7"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/7"
            }
        },
        {
            "type": "supports",
            "id": "8",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "42"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "8"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "8"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/8"
            }
        },
        {
            "type": "supports",
            "id": "9",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "44"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "9"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "9"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/9"
            }
        },
        {
            "type": "supports",
            "id": "10",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "46"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "10"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "10"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/10"
            }
        },
        {
            "type": "supports",
            "id": "27",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "4"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "27"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "27"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/27"
            }
        },
        {
            "type": "supports",
            "id": "29",
            "attributes": {
                "support": "yes",
                "prefix": null,
                "prefix_mandatory": false,
                "alternate_name": null,
                "alternate_mandatory": false,
                "requires_config": null,
                "default_config": null,
                "protected": false,
                "note": null
            },
            "relationships": {
                "version": {
                    "data": {
                        "type": "versions",
                        "id": "50"
                    }
                },
                "feature": {
                    "data": {
                        "type": "features",
                        "id": "6"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_supports",
                        "id": "32"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_supports",
                            "id": "32"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/supports/29"
            }
        },
        {
            "type": "maturities",
            "id": "1",
            "attributes": {
                "slug": "REC",
                "name": {
                    "en": "Recommendation",
                    "de": "Empfehlung",
                    "ja": "勧告",
                    "ru": "Рекомендация"
                }
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_maturities",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_maturities",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/maturities/1"
            }
        },
        {
            "type": "maturities",
            "id": "2",
            "attributes": {
                "slug": "WD",
                "name": {
                    "en": "Working Draft",
                    "de": "Arbeitsentwurf",
                    "ja": "草案",
                    "ru": "Рабочий черновик"
                }
            },
            "relationships": {
                "history_current": {
                    "data": {
                        "type": "historical_maturities",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_maturities",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/maturities/2"
            }
        },
        {
            "type": "specifications",
            "id": "1",
            "attributes": {
                "slug": "css1",
                "mdn_key": "CSS1",
                "name": {
                    "en": "CSS Level 1"
                },
                "uri": {
                    "en": "http://www.w3.org/TR/CSS1/"
                }
            },
            "relationships": {
                "maturity": {
                    "data": {
                        "type": "maturities",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_specifications",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_specifications",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/specifications/1"
            }
        },
        {
            "type": "specifications",
            "id": "2",
            "attributes": {
                "slug": "css2_1",
                "mdn_key": "CSS2.1",
                "name": {
                    "en": "CSS Level 2 (Revision 1)"
                },
                "uri": {
                    "en": "http://www.w3.org/TR/CSS2/"
                }
            },
            "relationships": {
                "maturity": {
                    "data": {
                        "type": "maturities",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_specifications",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_specifications",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/specifications/2"
            }
        },
        {
            "type": "specifications",
            "id": "3",
            "attributes": {
                "slug": "css3_box",
                "mdn_key": "CSS3 Box",
                "name": {
                    "en": "CSS Basic Box Model"
                },
                "uri": {
                    "en": "http://dev.w3.org/csswg/css3-box/"
                }
            },
            "relationships": {
                "maturity": {
                    "data": {
                        "type": "maturities",
                        "id": "2"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_specifications",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_specifications",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/specifications/3"
            }
        },
        {
            "type": "sections",
            "id": "1",
            "attributes": {
                "number": {
                    "en": "5.5.25"
                },
                "name": {
                    "en": "'float'"
                },
                "subpath": {
                    "en": "#float"
                },
                "note": {
                    "en": "Initial definition."
                }
            },
            "relationships": {
                "specification": {
                    "data": {
                        "type": "specifications",
                        "id": "1"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_sections",
                        "id": "1"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_sections",
                            "id": "1"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/sections/1"
            }
        },
        {
            "type": "sections",
            "id": "2",
            "attributes": {
                "number": {
                    "en": "9.5.1"
                },
                "name": {
                    "en": "Positioning the float: the 'float' property"
                },
                "subpath": {
                    "en": "visuren.html#float-position"
                },
                "note": {
                    "en": "No change."
                }
            },
            "relationships": {
                "specification": {
                    "data": {
                        "type": "specifications",
                        "id": "2"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_sections",
                        "id": "2"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_sections",
                            "id": "2"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/sections/2"
            }
        },
        {
            "type": "sections",
            "id": "3",
            "attributes": {
                "number": {
                    "en": "16"
                },
                "name": {
                    "en": "The float property"
                },
                "subpath": {
                    "en": "#the-float-property"
                },
                "note": {
                    "en": "Lots of new values, not all clearly defined yet. Any differences in behavior unrelated to new features are expected to be unintentional; please report."
                }
            },
            "relationships": {
                "specification": {
                    "data": {
                        "type": "specifications",
                        "id": "3"
                    }
                },
                "history_current": {
                    "data": {
                        "type": "historical_sections",
                        "id": "3"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_sections",
                            "id": "3"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/sections/3"
            }
        },
        {
            "type": "features",
            "id": "6",
            "attributes": {
                "slug": "web-css-float_basic-support",
                "mdn_uri": null,
                "experimental": false,
                "standardized": true,
                "stable": true,
                "obsolete": false,
                "name": {
                    "en": "Basic Support",
                    "ja": "基本サポート"
                }
            },
            "relationships": {
                "parent": {
                    "data": {
                        "type": "features",
                        "id": "5"
                    }
                },
                "children": {
                    "data": []
                },
                "sections": {
                    "data": []
                },
                "supports": {
                    "data": [
                        {
                            "type": "supports",
                            "id": "1"
                        },
                        {
                            "type": "supports",
                            "id": "2"
                        },
                        {
                            "type": "supports",
                            "id": "3"
                        },
                        {
                            "type": "supports",
                            "id": "4"
                        },
                        {
                            "type": "supports",
                            "id": "5"
                        },
                        {
                            "type": "supports",
                            "id": "6"
                        },
                        {
                            "type": "supports",
                            "id": "7"
                        },
                        {
                            "type": "supports",
                            "id": "8"
                        },
                        {
                            "type": "supports",
                            "id": "9"
                        },
                        {
                            "type": "supports",
                            "id": "10"
                        },
                        {
                            "type": "supports",
                            "id": "27"
                        },
                        {
                            "type": "supports",
                            "id": "29"
                        }
                    ]
                },
                "history_current": {
                    "data": {
                        "type": "historical_features",
                        "id": "6"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_features",
                            "id": "6"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/features/6"
            }
        },
        {
            "type": "features",
            "id": "19",
            "attributes": {
                "slug": "web-css-float_new-subfeature",
                "mdn_uri": null,
                "experimental": false,
                "standardized": true,
                "stable": true,
                "obsolete": false,
                "name": {
                    "en": "New Subfeature"
                }
            },
            "relationships": {
                "parent": {
                    "data": {
                        "type": "features",
                        "id": "5"
                    }
                },
                "children": {
                    "data": []
                },
                "sections": {
                    "data": []
                },
                "supports": {
                    "data": []
                },
                "history_current": {
                    "data": {
                        "type": "historical_features",
                        "id": "28"
                    }
                },
                "history": {
                    "data": [
                        {
                            "type": "historical_features",
                            "id": "28"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://browsercompat.org/api/v2/features/19"
            }
        }
    ],
    "meta": {
        "compat_table": {
            "supports": {
                "5": {},
                "6": {
                    "1": [
                        "1"
                    ],
                    "2": [
                        "27"
                    ],
                    "3": [
                        "29"
                    ],
                    "4": [
                        "2"
                    ],
                    "6": [
                        "3"
                    ],
                    "7": [
                        "4"
                    ],
                    "9": [
                        "5"
                    ],
                    "10": [
                        "6"
                    ],
                    "11": [
                        "7"
                    ],
                    "14": [
                        "8"
                    ],
                    "15": [
                        "10"
                    ]
                },
                "19": {}
            },
            "tabs": [
                {
                    "name": {
                        "en": "Desktop Browsers"
                    },
                    "browsers": [
                        "4",
                        "7",
                        "9",
                        "11",
                        "14"
                    ]
                },
                {
                    "name": {
                        "en": "Mobile Browsers"
                    },
                    "browsers": [
                        "1",
                        "2",
                        "3",
                        "6",
                        "10",
                        "15"
                    ]
                }
            ],
            "child_pages": true,
            "pagination": {
                "linked.features": {
                    "previous": null,
                    "next": null,
                    "count": 2
                }
            },
            "languages": [
                "en",
                "de",
                "es",
                "ja",
                "ru"
            ],
            "notes": {}
        }
    }
}

The response is the feature view with new and updated items, or an error response.

This is a trivial use case, which would be better implemented by creating the feature directly, but it can be extended to bulk updates of existing feature views, or for first-time importing of subfeatures and support data. It has some quirks:

• New items should be identified with an ID starting with an underscore (_). Relations to new items should use the underscored IDs.
• Only feature, support, and section resources can be added or updated. Features must be the target feature or a descendant, and supports and sections are restricted to those features.
• Deletions are not supported.
• Other resources (browsers, versions, etc) can not be added or changed. This includes adding links to new resources.

Once the MDN import is complete, this PUT interface will be deprecated in favor of direct POST and PUT to the standard resource API.

Services

A Service provides server functionality beyond basic manipulation of resources.

Authentication

Several endpoint handle user authentication.

https://browsersupports.org/accounts/profile/ is an HTML page that summarizes the users’ account, which includes:

• The username, which can’t be changed.
• Changing or setting the password, which is optional if a linked account is used.
• Viewing, adding, and removing linked accounts, which are optional if a password is set. The support linked account type is Firefox Accounts.
• Viewing, adding, and removing emails. Emails can be verified (a link is clicked or a trusted linked account says it is verified), and one is the primary email used for communication.

Additional endpoints for authentication:

• /accounts/ - Redirect to login or profile, depending on login state
• /accounts/signup/ - Create a new account, using username and password
• /accounts/login/ - Login to an existing account, using username and password or selecting a linked account
• /accounts/logout/ - Logout from site
• /accounts/password/change/ - Change an existing password
• /accounts/password/set/ - Set the password for an account using only a linked account
• /accounts/email/ - Manage associated email addresses
• /accounts/password/reset/ - Start a password reset via email
• /accounts/social/connections/ - Manage social accounts
• /accounts/fxa/login/ - Start a Firefox Accounts login

Data Browser

The Data Browser at https://browsercompat.herokuapp.com/browse/ is an Ember.js single-page app that allows browsing the resources currently available in the API. It is built with Ember libraries that work with JSON API RC1.

Importer

The MDN Importer at https://browsercompat.herokuapp.com/importer/ is used to scrape data from MDN, extract compatibility data, pinpoint data issues on MDN pages, and commit extracted data to the API.

Tools

Some potentially useful scripts can be found in the /tools folder:

download_data.py

Download data from API. Usage:

$ tools/download_data.py [--api API] [-vq] [--data DATA]

• --api <API> (optional): Set the base URL of the API (default: http://localhost:8000)
• -v (optional): Print debug information
• -q (optional): Only print warnings
• --data <DATA> (optional): Set the output data folder (default: data subfolder in the working copy)

This will create several files (browsers.json, versions.json, etc.) that represent the API resources without pagination.

import_mdn.py

Import features from MDN, or reparse imported features. Usage:

$ tools/import_mdn.py [--api API] [--user USER] [-vq]

• --api <API> (optional): Set the base URL of the API (default: http://localhost:8000)
• --user <USER> (optional): Set the username to use on the API (default: prompt for username)
• -v (optional): Print debug information
• -q (optional): Only print warnings

load_spec_data.py

Import specification data from MDN’s SpecName and Spec2. Usage:

$ tools/load_spec_data.py [--api <API>] [--user <USER>]
                          [-vq] [--all-data]

• --api <API> (optional): Set the base URL of the API (default: http://localhost:8000)
• --user <USER> (optional): Set the username to use on the API (default: prompt for username)
• -v (optional): Print debug information
• -q (optional): Only print warnings

load_webcompat_data.py

Initialize with compatibility data from the WebPlatform project. Usage:

$ tools/load_webcompat_data.py [--api <API>] [--user <USER>]
                               [-vq] [--all-data]

• --api <API> (optional): Set the base URL of the API (default: http://localhost:8000)
• --user <USER> (optional): Set the username to use on the API (default: prompt for username)
• -v (optional): Print debug information
• -q (optional): Only print warnings
• --all-data (optional): Import all data, rather than a subset

make_doc_requests.py

Make documentation/integration requests against an API. Used by tools/run_integration_tests.sh. Usage:

$ tools/integration_requests.py [--mode {display,generate,verify}]
                                [--api API]
                                [--raw RAW] [--cases CASES]
                                [--user USER] [--password PASSWORD]
                                [--include-mod] [-vq]
                                [case name [case name ...]]

• --mode {display,generate,verify} (optional): Set the mode. Values are:

  • display (default): Run GET requests against an API, printing the actual requests and responses.
  • generate: Run all requests against an API. Throw away some headers, such as Allow and Server. Modify other headers, such as Cookies, to make them consistent from run to run. Standardize some response data, such as creation and modification times. Store the cleaned-up requests and responses in the docs folder, for documentation and integration testing.
  • verify: Run all requests against an API, standardizing the requests and responses and comparing them to those in the docs folder.

• --api API (optional): Set the base URL of the API (default: http://localhost:8000)

• --raw RAW (optional): Set the path to the folder containing raw requests and responses (default: docs/raw)

• --cases CASES (optional): Set the path to the documentation cases JSON file (default docs/doc_cases.json)

• --user USER: Set the username to use for requests (default anonymous requests)

• --password PASSWORD: Set the password to use for requests (default is prompt if --user set, otherwise use anonymous requests)

• --include-mod: If --mode display, then include requests that would modify the data, such as POST, PUT, and DELETE.

• -v: Be more verbose

• -q: Be quieter

• case name: Run the listed cases, not the full suite of cases

mirror_mdn_features.py

Create and update API features for MDN pages. This will create the branch features, and then import_mdn.py can be used to generate the leaf features. Usage:

$ tools/mirror_mdn_features.py [--api API] [--data DATA]
                               [--user USER] [--password PASSWORD]

• --api API (optional): Set the base URL of the API (default: http://localhost:8000)
• --user USER: Set the username to use for requests (default is prompt for username)
• --password PASSWORD: Set the password to use for requests (default is prompt for username)
• --data DATA: Set the data folder for caching MDN page JSON

run_integration_tests.sh

Run a local API server with known data, make requests against it, and look for issues in the response. Usage:

$ tools/run_integration_tests.sh [-ghqv]

• -g: Generate documentation / integration test samples. If omitted, then responses are checked against the documentation samples. Useful for adding new documentation cases, or updating when the API changes.
• -h: Show a usage statement
• -q: Show less output
• -v: Show more output

sample_mdn.py

Load random pages from MDN in your browser. Usage:

$ tools/sample_mdn.py

upload_data.py

Upload data to the API. Usage:

$ tools/upload_data.py [--api API] [--user USER]
                       [-vq] [--data DATA]

• --api <API> (optional): Set the base URL of the API (default: http://localhost:8000)
• --user <USER> (optional): Set the username to use on the API (default: prompt for username)
• -v (optional): Print debug information
• -q (optional): Only print warnings
• --data <DATA> (optional): Set the output data folder (default: data subfolder in the working copy)

This will load the local resources from files (browsers.json, versions.json, etc), download the resources from the API, and upload the changes to make the API match the local resource files.

Issues

The near-term goal is that compatibility data lives in the API rather than on the MDN page, and MDN contributors maintain this data in the API instead of editing wiki pages. As this plan is executed, limitations are discovered in API, and changes are made and deployed.

When MDN is using the API as the primary source of compatibility data, we’ll increment the API version for backward-incompatible changes. Until then, the v1 and v2 APIs will be modified with the evolving design.

This page outlines planned changes in the API. It doesn’t describe all the known bugs and issues - see tracking bug 996570 for a detailed list.

API Tasks

Here are the planned tasks that will require code changes to the API:

• Refactor Slugs - Slugs were designed to be human-friendly aliases for resources, and also to be natural key alternatives to auto-incrementing IDs. However, whenever they are used for these purposes, they are found to have issues and require adjusting. For example, Browser slugs were adjusted to remove the “desktop by default” bias (bug 1128525). Feature slugs had issues when the MDN page had a title that bumped up against the 50 character limit (bug 1078699). Slugs will be modified to be changeable by privileged users, instead of being set once at creation time. They may also be expanded beyond 50 characters, become a list of optional aliases, and be renamed in some cases. 3rd party developers should not rely on slugs remaining constant for the life of the API.
• Switch from Auto-Incrementing IDs to UUIDs (bug 1230306) - Resources are accessed by IDs, which using the database’s auto-incrementing integers. This means that two instances of the API could have the same data available at different IDs. Tools currently use slugs and other “permanent” attributes to identify resources as the same, even when IDs change. This is error-prone, and since slugs are planned to change, it would be useful to use UUIDs instead, so that the ID becomes a strong identifier between API instances.
• Recover deleted items (bug 1159349) - The History API could be used to recover deleted items, by administrators or users. The API needs to be modified to allow the reversion PATCH to deleted resources.
• Move to api.browsercompat.org (bug 1153329) - https://browsercompat.org will be the user-facing contribution interface and data browser. https://api.browsercompat.org will be the application-facing interface. This may require renaming the github repository, moving paths, and dropping sample views.
• Other v1/v2 API tasks (tracking bug 1240757) - See this tracking bug for other issues assigned to the v1/v2 API milestone.
• Known JSON API v1.0 issues (tracking bug 1243225) - The v2 API is a partial implementation of the JSON API v1.0 specification. There are known issues around optional functionality like sorting and including linked resources, as well as differences in error representations. See this tracking bug for known issues.

Data Tasks

Here are the planned tasks that involve adding or changing data in the API:

• Add Feature IDs to MDN document data (bug 1240774) - The mechanism for including a Compatibility table on MDN is evolving. The latest idea is that the Feature ID will be stored in the MDN document model, so that the existing parameterless KumaScript can used to inject the table. There are open design questions, such as how the IDs will be set, if they need to change, and, if so, who will change them and how.

• Import Data from MDN - The majority of the project work has been building a scraper capable of importing existing data from MDN. As of September 2015, the scraper can extract data from most MDN pages, and can pinpoint issues that require page changes. The scraped data has to be committed to the API, and this process is ongoing.

• Populate Browser Version Data - MDN has detailed information for Firefox releases, and much less for other browsers. The version model supports some data, such as a release date, a retirement date, and URLs for release notes. Versions can also be sorted with respect to the related browser. This information can’t be imported, and must be entered into the API. Some sources for this data include:

  • Google Chrome - Google Chrome Release History on Wikipedia
  • Mozilla Firefox - Firefox Release History on Wikipedia and KumaScript macro CompatGeckoDesktop
  • Microsoft Internet Explorer - Release History of IE on Wikipedia
  • Opera - Current Opera version history and Presto history on opera.com
  • Safari - Safari version history on Wikipedia

Future Tasks

Once MDN is using the API as the primary data source for compatibility data, we can move on to other goals.

This includes, but is not limited to:

• Supporting other relations between resources. For example, the CSS property color can be assigned a CSS color type such as color=red. The CSS property background-color can also be assigned CSS color types. Different browsers may support a different set of named colors. This relation can’t be directly represented in the API, but can be partially modeled with HTML links.
• Support test-driven compatibility data. This is generated by browser vendors and standardization supporters, and can be implemented as separate applications using the compatibility API.

History

The BrowserCompat API is still in beta, and true versioning won’t start until it is shipped to the general public. The issues are tracked on Bugzilla.

When code is merged to master (once or twice a week), it is deployed to Heroku at https://browsercompat.herokuapp.com.

Here are some development milestones:

• 2015-12-01 - MDN beta users can see API-backed tables on select pages
• 2015-09-11 - 3rd re-write of MDN importer ships, 82% of MDN can be imported
• 2015-02 - Added MDN importer
• 2014-12 - Added rest of resources, sample displays. Dropped versioning pre-release.
• 0.2.0 - 2014-10-13 - Add features, supports, pagination
• 0.1.0d - 2014-09-29 - Add resource-level caching
• 0.1.0c - 2014-09-16 - Add sample feature view, simplify draft API
• 0.1.0b - 2014-09-05 - Add filtering, more JSON API tuning.
• 0.1.0a - 2014-09-02 - First Heroku deployment. Browser and Version data.

Indices and tables

• Index
• Module Index
• Search Page