StabbyMcDuck/crapper_keeper

View on GitHub
doc/api/user/get_all_users.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
  <head>
    <title>User API</title>
    <meta charset="utf-8">
    <style>
      
body {
  font-family: Helvetica,Arial,sans-serif;
  font-size: 13px;
  font-weight: normal;
  line-height: 18px;
  color: #404040;
}

.container {
  width: 940px;
  margin-left: auto;
  margin-right: auto;
  zoom: 1;
}

pre {
  background-color: #f5f5f5;
  display: block;
  padding: 8.5px;
  margin: 0 0 18px;
  line-height: 18px;
  font-size: 12px;
  border: 1px solid #ccc;
  border: 1px solid rgba(0, 0, 0, 0.15);
  -webkit-border-radius: 3px;
  -moz-border-radius: 3px;
  border-radius: 3px;
  white-space: pre;
  white-space: pre-wrap;
  word-wrap: break-word;
}

td.required .name:after {
  float: right;
  content: "required";
  font-weight: normal;
  color: #F08080;
}

a{
  color: #0069d6;
  text-decoration: none;
  line-height: inherit;
  font-weight: inherit;
}

h1, h2, h3, h4, h5, h6 {
  font-weight: bold;
  color: #404040;
}

h1 {
  margin-bottom: 18px;
  font-size: 30px;
  line-height: 36px;
}
h2 {
  font-size: 24px;
  line-height: 36px;
}
h3{
  font-size: 18px;
  line-height: 36px;
}
h4 {
  font-size: 16px;
  line-height: 36px;
}

table{
  width: 100%;
  margin-bottom: 18px;
  padding: 0;
  border-collapse: separate;
  font-size: 13px;
  -webkit-border-radius: 4px;
  -moz-border-radius: 4px;
  border-radius: 4px;
  border-spacing: 0;
  border: 1px solid #ddd;
}

table th {
  padding-top: 9px;
  font-weight: bold;
  vertical-align: middle;
  border-bottom: 1px solid #ddd;
}
table th+th, table td+td {
  border-left: 1px solid #ddd;
}
table th, table td {
  padding: 10px 10px 9px;
  line-height: 18px;
  text-align: left;
}

    </style>
  </head>
  <body>
    <div class="container">
      <h1>User API</h1>

      <div class="article">
        <h2>Get all users</h2>
        <h3>GET api/v1/users</h3>



          <h3>Request</h3>

            <h4>Headers</h4>
            <pre class="request headers">Host: example.org
Cookie: </pre>

          <h4>Route</h4>
          <pre class="request route highlight">GET api/v1/users</pre>




            <h3>Response</h3>
              <h4>Headers</h4>
              <pre class="response headers">X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json; charset=utf-8
ETag: W/&quot;9b5c5874c9e860933582608ea0cc9f47&quot;
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 8ce0977e-7a34-413a-aa95-5d82c6c0322c
X-Runtime: 0.036078
Content-Length: 585</pre>
            <h4>Status</h4>
            <pre class="response status">200 OK</pre>
              <h4>Body</h4>
              <pre class="response body">[
  {
    &quot;id&quot;: &quot;c9dd2a96-5e9e-4a27-9266-d86a996b01d0&quot;,
    &quot;provider&quot;: null,
    &quot;uid&quot;: &quot;2&quot;,
    &quot;name&quot;: null,
    &quot;oauth_token&quot;: null,
    &quot;oauth_expires_at&quot;: null,
    &quot;created_at&quot;: &quot;2016-10-21T21:52:37.000+00:00&quot;,
    &quot;updated_at&quot;: &quot;2016-10-21T21:52:37.000+00:00&quot;,
    &quot;url&quot;: &quot;http://example.org/users/c9dd2a96-5e9e-4a27-9266-d86a996b01d0.json&quot;
  },
  {
    &quot;id&quot;: &quot;bc62a938-bc68-407e-afbf-47d94e720a5e&quot;,
    &quot;provider&quot;: null,
    &quot;uid&quot;: &quot;1&quot;,
    &quot;name&quot;: null,
    &quot;oauth_token&quot;: null,
    &quot;oauth_expires_at&quot;: null,
    &quot;created_at&quot;: &quot;2016-10-21T21:52:37.000+00:00&quot;,
    &quot;updated_at&quot;: &quot;2016-10-21T21:52:37.000+00:00&quot;,
    &quot;url&quot;: &quot;http://example.org/users/bc62a938-bc68-407e-afbf-47d94e720a5e.json&quot;
  }
]</pre>
      </div>
    </div>
  </body>
</html>