/
pirates-artisanal-div.html
109 lines (95 loc) · 3.06 KB
/
pirates-artisanal-div.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Pirate API</title>
<style>
/* Layout */
html { padding:2em; }
article { padding:1em; max-width:53em; }
section { position:relative; z-index:1; }
section div {
margin-bottom:1em; display:grid; grid-template-columns: 0.618fr 1em 0.382fr;
position:relative; z-index:3;
}
h3 { grid-column-start:span 3; }
pre { margin:0; grid-column-start:1; grid-column-end:1; padding-top:0.4em; }
aside { grid-column-start:3; grid-column-end:3; }
code, dfn { margin-bottom:1em; }
dfn { display:block; position:relative; padding:0.3em 0.5em; }
.line { z-index:2; position:absolute; border-top:0.3em solid; }
/* Text */
body { font-family: 'Open Sans', Helvetica, sans-serif; }
dfn { font-style:normal; }
h1 { display:none; }
h2 { font-size:1.6em; font-weight:normal; }
h3 { font-size:1em; }
code { font-size:120%; }
/* Colour */
body { background-color:white; color:black; }
h2, h3 { color:#333; }
article { background-color:#FCF9F1; }
code a, dfn { background-color:#FFEBA9; }
code a, code a:visited { color:inherit; text-decoration:none; }
.line { border-color:#FFEBA9; }
a, a:visited { color:#428bca; }
</style>
</head>
<body>
<article class="http-resource" id="ship-crew">
<header>
<h1>A ship’s crew</h1>
</header>
<section class="method" id="ship-crew-get">
<h2>Add a pirate to a ship’s crew</h2>
<div class="request">
<h3>Request - crew member details</h3>
<pre><code class="lang-http">POST /ship/<a href="#ship-id">ShpOWZxvR3mxMndyC2aJ3A</a>/crew HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <a href="api-key">KiMwscRpnoSOQwTm</a>
{
"name": "Long John Silver",
"rank": "Pirate captain",
"born": {
"town": "Bristol",
"year": 1883
},
"familiar": {
"type": "parrot",
"name": "Captain Flint"
}
}
</code></pre>
<aside>
<dfn id="ship-id">Ship ID - a <a href="https://www.rfc-editor.org/rfc/rfc4648#section-5">base46url</a>-encoded <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> that uniquely identifies the ship</dfn>
<dfn id="api-key">Developer-specific API key that grants access to update a single ship, until its expiry date</dfn>
</aside>
</div>
<div class="response">
<h3>Success response - crew member added</h3>
<pre><code class="lang-http">HTTP/1.1 201 Created
Location: /pirate/<a href="pirate-id">P3jJuhcUJoWLFsYdjLZ3Ww</a>
</code></pre>
<aside>
<dfn id="pirate-id" style="top:1.1em">Pirate ID</dfn>
</aside>
</div>
<div class="response">
<h3>Error response - ship not found</h3>
<pre><code class="lang-http">HTTP/1.1 404 Not Found
Content-Type: application/problem+json
Content-Language: en
{
"title": "Ship not found",
"detail": "No ship with ID ‘ShpOWZxvR3mxMndyC2aJ3A’",
"ship_id": "ShpOWZxvR3mxMndyC2aJ3A"
}</code></pre>
</div>
<div class="line" id="line-ship-id" style="top:7.5em; left:6.4em; width:27em"></div>
<div class="line" id="line-api-key" style="top:10.8em; left:12.8em; width:21em"></div>
<div class="line" id="line-pirate-id" style="top:31.9em; left:10.5em; width:23em"></div>
</section>
</article>
</body>
</html>