Skip to content
This repository was archived by the owner on Feb 18, 2023. It is now read-only.

Commit e6c770d

Browse files
committed
Update Docs
1 parent 88f59a1 commit e6c770d

File tree

2 files changed

+21
-1
lines changed

2 files changed

+21
-1
lines changed

docs/api/blueprint/dataStructures/assets.apib

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@
33
+ mime: `image/jpeg` (string) - The asset mime type
44
+ type: `image` (string) - The asset type
55
+ path: `12342bh3y3bn3i4i5ii5b43o3n.jpg` (string) - The asset path in the storage
6+
+ links
7+
+ full: `https://laravelapi.test/api/assets/0c244c51-0a3b-4b86-829a-ee161c2f966f` (string) - The asset link for render full size
8+
+ thumb: `https://laravelapi.test/api/assets/0c244c51-0a3b-4b86-829a-ee161c2f966f?width=200&height=200` (string) - The asset link for render thumb size
69
+ created_at : `1997-07-16T19:20:30+01:00` (string) - Date in format iso 8601
710

resources/views/apidocs.blade.php

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2656,6 +2656,10 @@
26562656
"<span class="hljs-attribute">mime</span>": <span class="hljs-value"><span class="hljs-string">"image/jpeg"</span></span>,
26572657
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"image"</span></span>,
26582658
"<span class="hljs-attribute">path</span>": <span class="hljs-value"><span class="hljs-string">"12342bh3y3bn3i4i5ii5b43o3n.jpg"</span></span>,
2659+
"<span class="hljs-attribute">links</span>": <span class="hljs-value">{
2660+
"<span class="hljs-attribute">full</span>": <span class="hljs-value"><span class="hljs-string">"https://laravelapi.test/api/assets/0c244c51-0a3b-4b86-829a-ee161c2f966f"</span></span>,
2661+
"<span class="hljs-attribute">thumb</span>": <span class="hljs-value"><span class="hljs-string">"https://laravelapi.test/api/assets/0c244c51-0a3b-4b86-829a-ee161c2f966f?width=200&amp;height=200"</span>
2662+
</span>}</span>,
26592663
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value"><span class="hljs-string">"1997-07-16T19:20:30+01:00"</span>
26602664
</span>}
26612665
</span>}</code></pre><div style="height: 1px;"></div><h5>Schema</h5><pre><code>{
@@ -2681,6 +2685,19 @@
26812685
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
26822686
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The asset path in the storage"</span>
26832687
</span>}</span>,
2688+
"<span class="hljs-attribute">links</span>": <span class="hljs-value">{
2689+
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"object"</span></span>,
2690+
"<span class="hljs-attribute">properties</span>": <span class="hljs-value">{
2691+
"<span class="hljs-attribute">full</span>": <span class="hljs-value">{
2692+
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
2693+
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The asset link for render full size"</span>
2694+
</span>}</span>,
2695+
"<span class="hljs-attribute">thumb</span>": <span class="hljs-value">{
2696+
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
2697+
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"The asset link for render thumb size"</span>
2698+
</span>}
2699+
</span>}
2700+
</span>}</span>,
26842701
"<span class="hljs-attribute">created_at</span>": <span class="hljs-value">{
26852702
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-string">"string"</span></span>,
26862703
"<span class="hljs-attribute">description</span>": <span class="hljs-value"><span class="hljs-string">"Date in format iso 8601"</span>
@@ -2707,7 +2724,7 @@
27072724
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>413</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
27082725
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">413</span></span>,
27092726
"<span class="hljs-attribute">message</span>": <span class="hljs-value"><span class="hljs-string">"The body is too large"</span>
2710-
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 08 Aug 2017</p><script>/* eslint-env browser */
2727+
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 16 Sep 2018</p><script>/* eslint-env browser */
27112728
/* eslint quotes: [2, "single"] */
27122729
'use strict';
27132730

0 commit comments

Comments
 (0)