]> BookStack Code Mirror - bookstack/blob - resources/views/api-docs/index.blade.php
Added rate limit section to the API docs
[bookstack] / resources / views / api-docs / index.blade.php
1 @extends('layouts.simple')
2
3 @section('body')
4
5     <div class="container pt-xl">
6
7         <div class="grid right-focus reverse-collapse">
8             <div>
9
10                 <div class="sticky-sidebar">
11                     <p class="text-uppercase text-muted mb-xm mt-l"><strong>Getting Started</strong></p>
12
13                     <div class="text-mono">
14                         <div class="mb-xs"><a href="#authentication">Authentication</a></div>
15                         <div class="mb-xs"><a href="#request-format">Request Format</a></div>
16                         <div class="mb-xs"><a href="#listing-endpoints">Listing Endpoints</a></div>
17                         <div class="mb-xs"><a href="#error-handling">Error Handling</a></div>
18                         <div class="mb-xs"><a href="#rate-limits">Rate Limits</a></div>
19                     </div>
20
21                     @foreach($docs as $model => $endpoints)
22                         <p class="text-uppercase text-muted mb-xm mt-l"><strong>{{ $model }}</strong></p>
23
24                         @foreach($endpoints as $endpoint)
25                             <div class="mb-xs">
26                                 <a href="#{{ $endpoint['name'] }}" class="text-mono inline block mr-s">
27                                     <span class="api-method" data-method="{{ $endpoint['method'] }}">{{ $endpoint['method'] }}</span>
28                                 </a>
29                                 <a href="#{{ $endpoint['name'] }}" class="text-mono">
30                                     {{ $endpoint['controller_method_kebab'] }}
31                                 </a>
32                             </div>
33                         @endforeach
34                     @endforeach
35                 </div>
36             </div>
37
38             <div style="overflow: auto;">
39
40                 <section code-highlighter class="card content-wrap auto-height">
41                     @include('api-docs.parts.getting-started')
42                 </section>
43
44                 @foreach($docs as $model => $endpoints)
45                     <section class="card content-wrap auto-height">
46                         <h1 class="list-heading text-capitals">{{ $model }}</h1>
47
48                         @foreach($endpoints as $endpoint)
49                             @include('api-docs.parts.endpoint', ['endpoint' => $endpoint, 'loop' => $loop])
50                         @endforeach
51                     </section>
52                 @endforeach
53             </div>
54
55         </div>
56
57
58     </div>
59 @stop