Skip to content

Commit 87feccd

Browse files
committed
updated ci docs
1 parent 04f2faa commit 87feccd

File tree

2 files changed

+31
-17
lines changed

2 files changed

+31
-17
lines changed

apps/showcase/doc/designer/ci/DesignerApiDoc.vue

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22
<DocSectionText v-bind="$attrs">
33
<p>Theme Designer public endpoint is hosted at PrimeUI Store.</p>
44
<DocSectionCode :code="code1" hideToggleCode importCode hideStackBlitz />
5+
<h3>Get a Secret Key</h3>
6+
<ul class="leading-relaxed list-decimal list-inside">
7+
<li>Visit the <a href="https://primeui.store/designer" target="_blank" rel="noopener noreferrer">PrimeUI Store</a>.</li>
8+
<li>Purchase an Extended License of Theme Designer.</li>
9+
<li>Navigate to your <a href="https://primeui.store/user/designer" target="_blank" rel="noopener noreferrer"> account settings</a>.</li>
10+
<li>Generate a secret key for CI/CD integration.</li>
11+
</ul>
12+
13+
<h3>Authentication</h3>
14+
<p>Define a <i>Authentication: Bearer</i> request headerto configure your secret key.</p>
15+
516
<h3>Parameters</h3>
617
<p>The request type must be <i>POST</i>.</p>
718
<div class="doc-tablewrapper">
@@ -15,14 +26,6 @@
1526
</tr>
1627
</thead>
1728
<tbody>
18-
<tr>
19-
<td>
20-
<i>designer-secret</i>
21-
</td>
22-
<td>string</td>
23-
<td>yes</td>
24-
<td>Secret key to access the API, can be generated at PrimeUI Store.</td>
25-
</tr>
2629
<tr>
2730
<td>
2831
<i>name</i>
@@ -67,20 +70,15 @@
6770
</table>
6871
</div>
6972

70-
<h3>Get a Secret Key</h3>
71-
<ul class="leading-relaxed list-decimal list-inside">
72-
<li>Visit the <a href="https://primeui.store/designer" target="_blank" rel="noopener noreferrer">PrimeUI Store</a>.</li>
73-
<li>Purchase an Extended License of Theme Designer.</li>
74-
<li>Navigate to your <a href="https://primeui.store/user/designer" target="_blank" rel="noopener noreferrer"> account settings</a>.</li>
75-
<li>Generate a secret key for CI/CD integration.</li>
76-
</ul>
73+
<h3>Example</h3>
74+
<DocSectionCode :code="code2" hideToggleCode importCode hideStackBlitz />
7775

7876
<h3>Response</h3>
7977
<p>A successful response returns a zip file containing the source code of the generated theme preset. The content-type header of this type of response is <i>application/zip</i>.</p>
8078

8179
<h3>Error Handling</h3>
8280
<p>When theme generation fails, a json response is returned with <i>application/json</i> content-type header. The response contains an error object with <i>code</i> and <i>message</i>.</p>
83-
<DocSectionCode :code="code2" hideToggleCode importCode hideStackBlitz />
81+
<DocSectionCode :code="code3" hideToggleCode importCode hideStackBlitz />
8482
</DocSectionText>
8583
</template>
8684

@@ -95,6 +93,22 @@ https://primeui.store/api/designer/integration/theme/create
9593
},
9694
code2: {
9795
basic: `
96+
const response = await fetch(https://primeui.store/api/designer/integration/theme/create, {
97+
method: 'POST',
98+
headers: {
99+
'Content-Type': 'application/json',
100+
'Accept': 'application/json, application/zip',
101+
'Authorization': \`Bearer \${designer_secret_key}\`
102+
},
103+
body: JSON.stringify({
104+
name: 'acme-theme',
105+
project: 'primevue,
106+
tokens: //JSON data
107+
})
108+
});`
109+
},
110+
code3: {
111+
basic: `
98112
{
99113
error: {
100114
code: 'download_failed',

apps/showcase/doc/designer/ci/integration/BitbucketDoc.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ pipelines:
5050
- chmod +x pipe.sh
5151
- export DESIGNER_SECRET="\${THEME_DESIGNER_SECRET_KEY}"
5252
- export THEME_NAME="acme-theme"
53-
- export PROJECT="primeng"
53+
- export PROJECT="primevue"
5454
- export FONT_SIZE="14px"
5555
- export FONT_FAMILY="Inter Var"
5656
- export TOKENS_PATH="./tokens.json"

0 commit comments

Comments
 (0)