Skip to content

Commit 02f1a49

Browse files
spencerroanremear
spencerroan
authored and
remear
committed
add Icons
1 parent 90596d2 commit 02f1a49

File tree

12 files changed

+478
-132
lines changed

12 files changed

+478
-132
lines changed

‎api/reference/1.0/app_configurations/list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ labels:
88

99
{% labels %}
1010

11-
Retrieve the App Configurations owned by the specified Company.
11+
Retrieve the App Configurations owned by the specified Company. Icons can be included with a query parameter `?include=icon`
1212

1313
{% filters app_configuration %}
1414

‎api/reference/1.0/app_configurations/relationships/icon/create.md‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: Create
3+
labels:
4+
- unstable
5+
---
6+
7+
# Create an Icon for an AppConfiguration
8+
9+
{% labels %}
10+
11+
Icons are processed asynchronously and have a `status` attribute representing the current status of the Icon.
12+
13+
{% alert info, Note %}
14+
This endpoint expects multipart requests. Icons must be 4 Mb or less.
15+
{% endalert %}
16+
17+
<div class="spectrum-Accordion" role="region">
18+
<div class="spectrum-Accordion-item is-open" role="presentation">
19+
20+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
21+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Attributes</button>
22+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
23+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
24+
</svg>
25+
</h3>
26+
27+
<div class="spectrum-Accordion-itemContent" role="region">
28+
<div class="spectrum-Table" role="grid">
29+
<div class="spectrum-Table-head" style="display: flex" role="row">
30+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
31+
Field
32+
</div>
33+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
34+
Type
35+
</div>
36+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
37+
Required / Optional
38+
</div>
39+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
40+
Description
41+
</div>
42+
</div>
43+
44+
<div class="spectrum-Table-body" role="rowgroup">
45+
<div class="spectrum-Table-row" style="display: flex" role="row">
46+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
47+
<code>file</code>
48+
</div>
49+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
50+
ico, png, jpg, jpeg
51+
</div>
52+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
53+
required
54+
</div>
55+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
56+
The icon image
57+
</div>
58+
</div>
59+
</div>
60+
</div>
61+
</div>
62+
</div>
63+
</div>
64+
65+
<div class="spectrum-Accordion" role="region">
66+
<div class="spectrum-Accordion-item is-open" role="presentation">
67+
68+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
69+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Endpoint Definition</button>
70+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
71+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
72+
</svg>
73+
</h3>
74+
75+
<div class="spectrum-Accordion-itemContent" role="region">
76+
<div class="highlight">
77+
<pre><code>POST app_configurations/:app_configuration_id/icon</code></pre>
78+
</div>
79+
</div>
80+
</div>
81+
82+
<div class="spectrum-Accordion-item is-open" role="presentation">
83+
84+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
85+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Example Request</button>
86+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
87+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
88+
</svg>
89+
</h3>
90+
91+
<div class="spectrum-Accordion-itemContent" role="region">
92+
<div class="highlight">
93+
<pre><code>curl https://reactor.adobe.io/app_configurations/:app_configuration_id/icon <span class="se">\</span>
94+
<span class="nt">-H</span> <span class="s2">"Accept: application/vnd.api+json;revision=1"</span> <span class="se">\</span>
95+
<span class="nt">-H</span> <span class="s2">"Content-Type: multipart/form-data"</span> <span class="se">\</span>
96+
<span class="nt">-H</span> <span class="s2">"Authorization: Bearer [TOKEN]"</span> <span class="se">\</span>
97+
<span class="nt">-H</span> <span class="s2">"X-Api-Key: [KEY]"</span> <span class="se">\</span>
98+
<span class="nt">-H</span> <span class="s2">"X-Gw-Ims-Org-Id: [ORG_ID]"</span> <span class="se">\</span>
99+
<span class="nt">-F</span> <span class="s2">"file"="@[PATH]"</span> <span class="se"></span>
100+
</code></pre>
101+
</div>
102+
</div>
103+
</div>
104+
105+
<div class="spectrum-Accordion-item is-open" role="presentation">
106+
107+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
108+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Example Response</button>
109+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
110+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
111+
</svg>
112+
</h3>
113+
114+
<div class="spectrum-Accordion-itemContent" role="region">
115+
<div class="highlight">
116+
<em>202 Accepted</em>
117+
<pre><code><span class="p">{</span><span class="w"></span>
118+
<span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
119+
<span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ICd1de2829fd4743c5bc45b98d9d01a396"</span><span class="p">,</span><span class="w"></span>
120+
<span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"icons"</span><span class="p">,</span><span class="w"></span>
121+
<span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span>
122+
<span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="kc">"https://assets.adobedtm.com/icons/17e0df72ece8/ICd1de2829fd4743c5bc45b98d9d01a396.png"</span><span class="p">,</span><span class="w"> </span>
123+
<span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span><span class="w"> </span>
124+
<span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-02-04T21:14:23.483Z"</span><span class="p">,</span><span class="w"> </span>
125+
<span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-02-04T21:14:23.483Z"</span><span class="w"></span>
126+
<span class="p">},</span><span class="w"></span>
127+
<span class="nt">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
128+
<span class="nt">"resource"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
129+
<span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
130+
<span class="nt">"related"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reactor.adobe.io/app_configurations/AC082ee39971a9444fb133e7610ae1e9f7"</span><span class="w"></span>
131+
<span class="p">},</span><span class="w"></span>
132+
<span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
133+
<span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AC082ee39971a9444fb133e7610ae1e9f7"</span><span class="p">,</span><span class="w"></span>
134+
<span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"app_configurations"</span><span class="p"></span><span class="w"></span>
135+
<span class="p">}</span><span class="w"></span>
136+
<span class="p">}</span><span class="w"></span>
137+
<span class="p">},</span><span class="w"></span>
138+
<span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
139+
<span class="nt">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reactor.adobe.io/app_configurations/AC082ee39971a9444fb133e7610ae1e9f7"</span><span class="p">,</span><span class="w"></span>
140+
<span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reactor.adobe.io/icons/ICd1de2829fd4743c5bc45b98d9d01a396"</span><span class="w"></span>
141+
<span class="p">}</span><span class="w"></span>
142+
<span class="p">}</span><span class="w">
143+
</span><span class="p">}</span></code></pre>
144+
</div>
145+
</div>
146+
</div>
147+
</div>

‎api/reference/1.0/app_configurations/relationships/icon/fetch_related.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Fetch related
3+
labels:
4+
- unstable
5+
---
6+
7+
# Fetch the related Icon
8+
9+
{% labels %}
10+
11+
Retrieve the AppConfiguration's Icon
12+
13+
{% scenario app_configuration_relationship_icon.show icons.get_the_icon_for_an_app_configuration %}

‎api/reference/1.0/app_surfaces/list.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ labels:
88

99
{% labels %}
1010

11-
Retrieve the App Surfaces owned by the specified Company.
11+
Retrieve the App Surfaces owned by the specified Company. Icons can be included with a query parameter `?include=icon`
1212

1313
{% scenario app_surfaces.index %}

‎api/reference/1.0/app_surfaces/relationships/icon/create.md‎

Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: Create
3+
labels:
4+
- unstable
5+
---
6+
7+
# Create an Icon for an AppSurface
8+
9+
{% labels %}
10+
11+
Icons are processed asynchronously and have a `status` attribute representing the current status of the Icon.
12+
13+
{% alert info, Note %}
14+
This endpoint expects multipart requests. Icons must be 4 Mb or less.
15+
{% endalert %}
16+
17+
<div class="spectrum-Accordion" role="region">
18+
<div class="spectrum-Accordion-item is-open" role="presentation">
19+
20+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
21+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Attributes</button>
22+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
23+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
24+
</svg>
25+
</h3>
26+
27+
<div class="spectrum-Accordion-itemContent" role="region">
28+
<div class="spectrum-Table" role="grid">
29+
<div class="spectrum-Table-head" style="display: flex" role="row">
30+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
31+
Field
32+
</div>
33+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
34+
Type
35+
</div>
36+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
37+
Required / Optional
38+
</div>
39+
<div class="spectrum-Table-headCell" style="flex: 1" role="columnheader">
40+
Description
41+
</div>
42+
</div>
43+
44+
<div class="spectrum-Table-body" role="rowgroup">
45+
<div class="spectrum-Table-row" style="display: flex" role="row">
46+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
47+
<code>file</code>
48+
</div>
49+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
50+
ico, png, jpg, jpeg
51+
</div>
52+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
53+
required
54+
</div>
55+
<div class="spectrum-Table-cell" style="flex: 1" role="gridcell">
56+
The icon image
57+
</div>
58+
</div>
59+
</div>
60+
</div>
61+
</div>
62+
</div>
63+
</div>
64+
65+
<div class="spectrum-Accordion" role="region">
66+
<div class="spectrum-Accordion-item is-open" role="presentation">
67+
68+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
69+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Endpoint Definition</button>
70+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
71+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
72+
</svg>
73+
</h3>
74+
75+
<div class="spectrum-Accordion-itemContent" role="region">
76+
<div class="highlight">
77+
<pre><code>POST app_surfaces/:app_surface_id/icon</code></pre>
78+
</div>
79+
</div>
80+
</div>
81+
82+
<div class="spectrum-Accordion-item is-open" role="presentation">
83+
84+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
85+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Example Request</button>
86+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
87+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
88+
</svg>
89+
</h3>
90+
91+
<div class="spectrum-Accordion-itemContent" role="region">
92+
<div class="highlight">
93+
<pre><code>curl https://reactor.adobe.io/app_surfaces/:app_surface_id/icon <span class="se">\</span>
94+
<span class="nt">-H</span> <span class="s2">"Accept: application/vnd.api+json;revision=1"</span> <span class="se">\</span>
95+
<span class="nt">-H</span> <span class="s2">"Content-Type: multipart/form-data"</span> <span class="se">\</span>
96+
<span class="nt">-H</span> <span class="s2">"Authorization: Bearer [TOKEN]"</span> <span class="se">\</span>
97+
<span class="nt">-H</span> <span class="s2">"X-Api-Key: [KEY]"</span> <span class="se">\</span>
98+
<span class="nt">-H</span> <span class="s2">"X-Gw-Ims-Org-Id: [ORG_ID]"</span> <span class="se">\</span>
99+
<span class="nt">-F</span> <span class="s2">"file"="@[PATH]"</span> <span class="se"></span>
100+
</code></pre>
101+
</div>
102+
</div>
103+
</div>
104+
105+
<div class="spectrum-Accordion-item is-open" role="presentation">
106+
107+
<h3 class="spectrum-Accordion-itemHeading no-anchor">
108+
<button class="spectrum-Accordion-itemHeader" type="button" onClick="toggleAccordion(this)" aria-expanded="true">Example Response</button>
109+
<svg class="spectrum-Icon spectrum-UIIcon-ChevronRightMedium spectrum-Accordion-itemIndicator" focusable="false" aria-hidden="true">
110+
<use xlink:href="#spectrum-css-icon-ChevronRightMedium" />
111+
</svg>
112+
</h3>
113+
114+
<div class="spectrum-Accordion-itemContent" role="region">
115+
<div class="highlight">
116+
<em>202 Accepted</em>
117+
<pre><code><span class="p">{</span><span class="w"></span>
118+
<span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
119+
<span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ICf76b9de5b229435bb76802427a88464b"</span><span class="p">,</span><span class="w"></span>
120+
<span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"icons"</span><span class="p">,</span><span class="w"></span>
121+
<span class="nt">"attributes"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span>
122+
<span class="nt">"url"</span><span class="p">:</span><span class="w"> </span><span class="kc">"https://assets.adobedtm.com/icons/17e0df72ece8/ICf76b9de5b229435bb76802427a88464b.png"</span><span class="p">,</span><span class="w"> </span>
123+
<span class="nt">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"pending"</span><span class="p">,</span><span class="w"> </span>
124+
<span class="nt">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-02-04T21:14:23.483Z"</span><span class="p">,</span><span class="w"> </span>
125+
<span class="nt">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2022-02-04T21:14:23.483Z"</span><span class="w"></span>
126+
<span class="p">},</span><span class="w"></span>
127+
<span class="nt">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
128+
<span class="nt">"resource"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
129+
<span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
130+
<span class="nt">"related"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reactor.adobe.io/app_surfaces/ASb763e208e4f64c86a4ce6445604355ce"</span><span class="w"></span>
131+
<span class="p">},</span><span class="w"></span>
132+
<span class="nt">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
133+
<span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ASb763e208e4f64c86a4ce6445604355ce"</span><span class="p">,</span><span class="w"></span>
134+
<span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"app_surfaces"</span><span class="p"></span><span class="w"></span>
135+
<span class="p">}</span><span class="w"></span>
136+
<span class="p">}</span><span class="w"></span>
137+
<span class="p">},</span><span class="w"></span>
138+
<span class="nt">"links"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
139+
<span class="nt">"resource"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reactor.adobe.io/app_surfaces/ASb763e208e4f64c86a4ce6445604355ce"</span><span class="p">,</span><span class="w"></span>
140+
<span class="nt">"self"</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://reactor.adobe.io/icons/ICf76b9de5b229435bb76802427a88464b"</span><span class="w"></span>
141+
<span class="p">}</span><span class="w"></span>
142+
<span class="p">}</span><span class="w">
143+
</span><span class="p">}</span></code></pre>
144+
</div>
145+
</div>
146+
</div>
147+
</div>

‎api/reference/1.0/app_surfaces/relationships/icon/fetch_related.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Fetch related
3+
labels:
4+
- unstable
5+
---
6+
7+
# Fetch the related Icon
8+
9+
{% labels %}
10+
11+
Retrieve the AppSurface's Icon
12+
13+
{% scenario app_surface_relationship_icon.show icons.get_the_icon_for_an_app_surface %}

0 commit comments

Comments
 (0)