Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions apis-json-spec.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Draft for Comment
Name: API Discovery Format
Informal Name: APIs.json
Authors: Kin Lane, Steven Willmott, Nicolas Grenie
Date: 10/06/2014
Location: http://apicommons.org/apisjson/apisjson_v0.14.txt
Authors: Kin Lane, Steven Willmott, Nicolas Grenie, Bruno Pedro
Date: 29/04/2015
Location: http://apicommons.org/apisjson/apisjson_v0.15.txt

A Simple Format for Publishing API Meta Data on the Web
A Simple Format for Publishing API Meta Data on the Web

Table of Contents

Expand Down Expand Up @@ -259,12 +259,13 @@ Table of Contents

3.8. Link Relation

In order for an API to reference its own description, it is recommended that it include header or
in-line references to the APIs.json file using the existing described by link relation:
In order for a Web site to reference its API description, it is recommended that it includes a header or
in-line reference to the APIs.json resource using the api link relation, e.g.:

* <link rel="describedby" href="api.example.com/apis.json" />
* <link rel="api" type="application/apis+json" href="https://example.com/apis.json" />

[Note, this is a generic link relation but seems to fit the bill]
It is intended that if there is sufficient traction, the link relation “api” will be
submitted to IANA as per RFC: http://tools.ietf.org/html/rfc5988

3.9. Extensions

Expand All @@ -287,7 +288,7 @@ Table of Contents
"created": "2014-04-07",
"modified": "2014-07-09",
"url": "http://apievangelist.com/apis.json",
"SpecificationVersion": "0.14",
"specificationVersion": "0.15",
"apis": [
{
"name": "Analysis",
Expand Down