Appendix F. Media Type Specification for application/issue+json
During the lifecycle of many complex engineering projects and the subsequent maintenance of those products, we need to track the discovery and resolution of issues related to those projects. This media type specification describes a document format that has a very low barrier of entry for interoperability. The current specification is a minimal definition with the expectation that additional capabilities will be added over time.
Notational Conventions
The keywords MUST
, MUST NOT
, REQUIRED
, SHALL
, SHALL NOT
, SHOULD
, SHOULD NOT
, RECOMMENDED
, MAY
, and OPTIONAL
in this
document are to be interpreted as described in RFC 2119.
Issue Documents
The Issue document, shown in Example F-1, uses the format described in RFC 4627 and has the media type application/issue+json
.
Issue documents may contain the properties listed in Table F-1.
Property name | Description |
| A unique numeric identifier for the issue |
| A short textual summary of the issue (required) |
| A detailed description of the issue |
| A textual representation of the issue state containing one of the following values: open, closed. |
issue+json
also supports hypermedia using links that conform to the semantics of a link, as described by RFC 5988. Links are defined by a set of objects within an array named links
.
Security Considerations
issue+json
has some security issues common to all JSON content types. See RFC 4627 Section #6 for additional information. issue+json
does not provide executable content.
Information contained in issue+json
documents does not require privacy or integrity services.
Interoperability Considerations
Unrecognized document content should be ignored and should not invalidate the document.
IANA Considerations
This specification defines a new Internet media type (RFC 6838):
Type name: application Subtype name: issue+json Required parameters: None Optional parameters: None; unrecognised parameters should be ignored Encoding considerations: Same as [RFC4627] Security considerations: see [this document] Interoperability considerations: None. Published specification: [this document] Applications that use this media type: HTTP Additional information: Magic number(s): n/a File extension(s): n/a Macintosh file type code(s): n/a Person & email address to contact for further information: Darrel Miller <darrel@tavis.ca> Intended usage: COMMON Restrictions on usage: None. Author: Darrel Miller <darrel@tavis.ca> Change controller: IESG
Get Designing Evolvable Web APIs with ASP.NET now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.