Skip to content

Commit

Permalink
Talk about examples in specifications
Browse files Browse the repository at this point in the history
Fixes #453
  • Loading branch information
mnot committed Feb 13, 2018
1 parent 242d87c commit e4cb12d
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions draft-ietf-httpbis-bcp56bis.md
Expand Up @@ -244,6 +244,23 @@ For example, an application can specify that it uses HTTP like this:
HTTP/1.1, and MAY support later versions. Support for common HTTP
mechanisms such as redirection and caching are assumed.

When specifying examples of protocol interactions, applications SHOULD document both the request
and response messages, with full headers, preferably in HTTP/1.1 format. For example:

~~~
GET /thing HTTP/1.1
Host: example.com
Accept: application/things+json
User-Agent: Foo/1.0

HTTP/1.1 200 OK
Content-Type: application/things+json
Content-Length: 500
Server: Bar/2.2

[payload here]
~~~


## Defining HTTP Resources {#resource}

Expand Down

0 comments on commit e4cb12d

Please sign in to comment.