Skip to content

Commit 94c5120

Browse files
author
github-actions[bot]
committed
Update generated documentation
1 parent aa86b30 commit 94c5120

File tree

9 files changed

+97
-76
lines changed

9 files changed

+97
-76
lines changed
Lines changed: 68 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,77 @@
11
<!DOCTYPE html>
22
<html lang="en">
3-
<head>
4-
<meta charset="UTF-8" />
5-
<title>Extensibility API Documentation</title>
6-
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
73

8-
<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css" />
9-
<script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
4+
<head>
5+
<meta charset="UTF-8" />
6+
<title>Extensibility API Documentation</title>
7+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
108

11-
<style>
12-
body {
13-
display: flex;
14-
flex-direction: column;
15-
height: 100vh;
16-
margin: 0;
17-
padding-top: 55px; /* ensures content below fixed header */
18-
}
19-
.api-container {
20-
flex: 1 0 0;
21-
overflow: visible;
22-
}
23-
elements-api {
24-
height: calc(100vh - 55px);
25-
}
9+
<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css" />
10+
<script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
2611

27-
.header-bar {
28-
position: fixed;
29-
top: 0;
30-
left: 0;
31-
right: 0;
32-
background-color: #006666;
33-
color: white;
34-
font-family: Arial, sans-serif;
35-
padding: 10px 15px;
36-
display: flex;
37-
align-items: center;
38-
box-shadow: 0 2px 3px rgba(0,0,0,.15);
39-
z-index: 999;
40-
}
12+
<style>
13+
body {
14+
display: flex;
15+
flex-direction: column;
16+
height: 100vh;
17+
margin: 0;
18+
padding-top: 55px;
19+
/* ensures content below fixed header */
20+
}
4121

42-
.header-bar a {
43-
color: white;
44-
text-decoration: none;
45-
font-size: 12px;
46-
padding: 6px 12px;
47-
border-radius: 5px;
48-
background-color: rgba(255,255,255,0.15);
49-
transition: background-color 0.2s;
50-
}
22+
.api-container {
23+
flex: 1 0 0;
24+
overflow: visible;
25+
}
5126

52-
.header-bar a:hover {
53-
background-color: rgba(255,255,255,0.3);
54-
}
55-
</style>
56-
</head>
57-
<body>
58-
<div class="header-bar">
59-
<a href="Extensibility-API.v1.html">← Back to Documentation</a>
60-
</div>
27+
elements-api {
28+
height: calc(100vh - 55px);
29+
}
30+
31+
.header-bar {
32+
position: fixed;
33+
top: 0;
34+
left: 0;
35+
right: 0;
36+
background-color: white;
37+
color: white;
38+
font-family: Arial, sans-serif;
39+
padding: 10px 15px;
40+
display: flex;
41+
align-items: center;
42+
box-shadow: 0 2px 3px rgba(0, 0, 0, .15);
43+
z-index: 999;
44+
}
45+
46+
.header-bar a {
47+
color: white;
48+
background-color: #6f45d9;
49+
text-decoration: none;
50+
font-size: 12px;
51+
padding: 6px 12px;
52+
border-radius: 5px;
53+
transition: background-color 0.2s;
54+
}
55+
56+
.header-bar a:hover {
57+
background-color: #6f45d9;
58+
}
59+
</style>
60+
</head>
61+
62+
<body>
63+
<div class="header-bar">
64+
<a href="Extensibility-API.v1.html">← Back to Documentation</a>
65+
</div>
66+
67+
<elements-api id="docs" router="hash" layout="sidebar" hideTryIt="true"></elements-api>
68+
<script>
69+
(async () => {
70+
const docs = document.getElementById('docs');
71+
const text = await fetch('Extensibility-API.v1.json').then(res => res.text())
72+
docs.apiDescriptionDocument = text;
73+
})();
74+
</script>
75+
</body>
6176

62-
<elements-api id="docs" router="hash" layout="sidebar" hideTryIt="true"></elements-api>
63-
<script>
64-
(async () => {
65-
const docs = document.getElementById('docs');
66-
const text = await fetch('Extensibility-API.v1.json').then(res => res.text())
67-
docs.apiDescriptionDocument = text;
68-
})();
69-
</script>
70-
</body>
7177
</html>

articles/Extensibility/api/Extensibility-API.v1.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,18 @@
7171
<article class="content wrap" id="_content" data-uid="">
7272

7373
<div style="margin-bottom:15px;padding:10px;border-bottom:1px dashed #ccc;">
74-
<a href="Extensibility-API.v1-fv.html" style="display:inline-block;padding: 8px 15px; background-color: #006666; color: white; text-decoration: none; border-radius: 5px;margin-bottom:10px;">
74+
<a href="Extensibility-API.v1-fv.html" style="display:inline-block;padding: 8px 15px; background-color: #6f45d9; color: white; text-decoration: none; border-radius: 5px;margin-bottom:10px;">
7575
⤢ View Documentation Fullscreen
7676
</a>
77+
<div style="font-size: 12px; color: #666; margin-top: 5px;">
78+
<em>API examples are only available when viewing in full-screen mode.</em>
79+
</div>
7780
</div>
7881
<div id="stoplight-api-container" style="margin-top:20px;"></div>
7982
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
8083
<script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
8184
<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css">
82-
<elements-api apidescriptionurl="Extensibility-API.v1.json" router="memory" layout="stacked"></elements-api>
85+
<elements-api apidescriptionurl="Extensibility-API.v1.json" router="memory" layout="stacked" hidetryit="true" hidetryitpanel="true"></elements-api>
8386

8487
</article>
8588
</div>

articles/Extensibility/toc.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@
190190

191191
<ul class="nav level2">
192192
<li>
193-
<a href="api/Extensibility-API.v1-fv.html" name="" title="Extensibility API">Extensibility API</a>
193+
<a href="api/Extensibility-API.v1.html" name="" title="Extensibility API">Extensibility API</a>
194194
</li>
195195
</ul>
196196
</li>

articles/Extensibility/toc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11

2-
{"items":[{"name":"What's New","href":"docs/Whats-New.html","topicHref":"docs/Whats-New.html"},{"name":"Development","items":[{"name":"Add-On To App Migration","href":"docs/development/Add-On-To-App-Migration.html","topicHref":"docs/development/Add-On-To-App-Migration.html"},{"name":"Concepts","href":"docs/development/Concepts.html","topicHref":"docs/development/Concepts.html"},{"name":"Technical Requirements And Best Practices","href":"docs/development/Technical-Requirements-And-Best-Practices.html","topicHref":"docs/development/Technical-Requirements-And-Best-Practices.html"},{"name":"Lifecycle","href":"docs/development/Lifecycle.html","topicHref":"docs/development/Lifecycle.html"},{"name":"Multi-Region","href":"docs/development/Multi-Region.html","topicHref":"docs/development/Multi-Region.html"},{"name":"App Descriptor","href":"docs/development/App-Descriptor.html","topicHref":"docs/development/App-Descriptor.html"},{"name":"App Versioning","href":"docs/development/App-Versioning.html","topicHref":"docs/development/App-Versioning.html"},{"name":"Authentication","items":[{"name":"Authentication Overview","href":"docs/development/Authentication-Overview.html","topicHref":"docs/development/Authentication-Overview.html"},{"name":"Request Authentication","href":"docs/development/Request-Authentication.html","topicHref":"docs/development/Request-Authentication.html"},{"name":"Trados Cloud Platform API","href":"docs/development/Trados-Cloud-API.html","topicHref":"docs/development/Trados-Cloud-API.html"}]},{"name":"Webhooks","href":"docs/development/Webhooks.html","topicHref":"docs/development/Webhooks.html"},{"name":"Deployment Strategy","href":"docs/development/Deployment-Strategy.html","topicHref":"docs/development/Deployment-Strategy.html"},{"name":"Extensions","items":[{"name":"Automatic Task","href":"docs/development/Automatic-Task-App-development-guide.html","topicHref":"docs/development/Automatic-Task-App-development-guide.html"},{"name":"Machine Translation","href":"docs/development/MT-App-development-guide.html","topicHref":"docs/development/MT-App-development-guide.html"},{"name":"Preview Provider","href":"docs/development/Preview-App-development-guide.html","topicHref":"docs/development/Preview-App-development-guide.html"},{"name":"Verification Provider","href":"docs/development/Verification-App-development-guide.html","topicHref":"docs/development/Verification-App-development-guide.html"},{"name":"User Interface (BETA)","items":[{"name":"User Interface App Development Guide","href":"docs/development/UI-App-development-guide.html","topicHref":"docs/development/UI-App-development-guide.html"},{"name":"Custom Elements and Locations","href":"docs/development/UI-App-custom-elements-locations.html","topicHref":"docs/development/UI-App-custom-elements-locations.html"}]}]},{"name":"Blueprints","items":[{"name":"Getting started","href":"docs/development/blueprints/Getting-Started.html","topicHref":"docs/development/blueprints/Getting-Started.html"},{"name":".NET Blueprint","href":"docs/development/blueprints/Dot-Net-Blueprint.html","topicHref":"docs/development/blueprints/Dot-Net-Blueprint.html"},{"name":".NET Migration Blueprint","href":"docs/development/blueprints/Dot-Net-Migration-Blueprint.html","topicHref":"docs/development/blueprints/Dot-Net-Migration-Blueprint.html"},{"name":"Java Blueprint","href":"docs/development/blueprints/Java-Blueprint.html","topicHref":"docs/development/blueprints/Java-Blueprint.html"},{"name":"Java Migration Blueprint","href":"docs/development/blueprints/Java-Migration-Blueprint.html","topicHref":"docs/development/blueprints/Java-Migration-Blueprint.html"},{"name":"Testing","href":"docs/development/blueprints/Testing.html","topicHref":"docs/development/blueprints/Testing.html"},{"name":"Testing with Docker","href":"docs/development/blueprints/Testing-with-Docker.html","topicHref":"docs/development/blueprints/Testing-with-Docker.html"}]},{"name":"Samples","items":[{"name":"Java","href":"docs/development/samples/Java-Samples.html","topicHref":"docs/development/samples/Java-Samples.html"},{"name":".NET","href":"docs/development/samples/Dot-Net-Samples.html","topicHref":"docs/development/samples/Dot-Net-Samples.html"}]},{"name":"Integrate With Trados Cloud Platform API","href":"docs/development/Integrate-With-Trados-Cloud-Platform-API.html","topicHref":"docs/development/Integrate-With-Trados-Cloud-Platform-API.html"}]},{"name":"App Management","items":[{"name":"Foreword","href":"docs/appManagement/Foreword.html","topicHref":"docs/appManagement/Foreword.html"},{"name":"Registering","href":"docs/appManagement/Registering.html","topicHref":"docs/appManagement/Registering.html"},{"name":"Installing","href":"docs/appManagement/Installing.html","topicHref":"docs/appManagement/Installing.html"},{"name":"Validating","href":"docs/appManagement/Validating.html","topicHref":"docs/appManagement/Validating.html"},{"name":"Sharing","href":"docs/appManagement/Sharing.html","topicHref":"docs/appManagement/Sharing.html"},{"name":"Approvals","href":"docs/appManagement/Approvals.html","topicHref":"docs/appManagement/Approvals.html"},{"name":"Publishing","href":"docs/appManagement/Publishing.html","topicHref":"docs/appManagement/Publishing.html"},{"name":"Updating","href":"docs/appManagement/Updating.html","topicHref":"docs/appManagement/Updating.html"},{"name":"Retiring","href":"docs/appManagement/Retiring.html","topicHref":"docs/appManagement/Retiring.html"}]},{"name":"Machine Translation","href":"docs/consumer/MT-App-consumer-guide.html","topicHref":"docs/consumer/MT-App-consumer-guide.html"},{"name":"Automatic Task","href":"docs/consumer/Automatic-Task-App-consumer-guide.html","topicHref":"docs/consumer/Automatic-Task-App-consumer-guide.html"},{"name":"Dynamic Preview","href":"docs/consumer/Dynamic-Preview-guide.html","topicHref":"docs/consumer/Dynamic-Preview-guide.html"},{"name":"APIs","items":[{"name":"Extensibility API","href":"api/Extensibility-API.v1-fv.html","topicHref":"api/Extensibility-API.v1-fv.html"}]}]}
2+
{"items":[{"name":"What's New","href":"docs/Whats-New.html","topicHref":"docs/Whats-New.html"},{"name":"Development","items":[{"name":"Add-On To App Migration","href":"docs/development/Add-On-To-App-Migration.html","topicHref":"docs/development/Add-On-To-App-Migration.html"},{"name":"Concepts","href":"docs/development/Concepts.html","topicHref":"docs/development/Concepts.html"},{"name":"Technical Requirements And Best Practices","href":"docs/development/Technical-Requirements-And-Best-Practices.html","topicHref":"docs/development/Technical-Requirements-And-Best-Practices.html"},{"name":"Lifecycle","href":"docs/development/Lifecycle.html","topicHref":"docs/development/Lifecycle.html"},{"name":"Multi-Region","href":"docs/development/Multi-Region.html","topicHref":"docs/development/Multi-Region.html"},{"name":"App Descriptor","href":"docs/development/App-Descriptor.html","topicHref":"docs/development/App-Descriptor.html"},{"name":"App Versioning","href":"docs/development/App-Versioning.html","topicHref":"docs/development/App-Versioning.html"},{"name":"Authentication","items":[{"name":"Authentication Overview","href":"docs/development/Authentication-Overview.html","topicHref":"docs/development/Authentication-Overview.html"},{"name":"Request Authentication","href":"docs/development/Request-Authentication.html","topicHref":"docs/development/Request-Authentication.html"},{"name":"Trados Cloud Platform API","href":"docs/development/Trados-Cloud-API.html","topicHref":"docs/development/Trados-Cloud-API.html"}]},{"name":"Webhooks","href":"docs/development/Webhooks.html","topicHref":"docs/development/Webhooks.html"},{"name":"Deployment Strategy","href":"docs/development/Deployment-Strategy.html","topicHref":"docs/development/Deployment-Strategy.html"},{"name":"Extensions","items":[{"name":"Automatic Task","href":"docs/development/Automatic-Task-App-development-guide.html","topicHref":"docs/development/Automatic-Task-App-development-guide.html"},{"name":"Machine Translation","href":"docs/development/MT-App-development-guide.html","topicHref":"docs/development/MT-App-development-guide.html"},{"name":"Preview Provider","href":"docs/development/Preview-App-development-guide.html","topicHref":"docs/development/Preview-App-development-guide.html"},{"name":"Verification Provider","href":"docs/development/Verification-App-development-guide.html","topicHref":"docs/development/Verification-App-development-guide.html"},{"name":"User Interface (BETA)","items":[{"name":"User Interface App Development Guide","href":"docs/development/UI-App-development-guide.html","topicHref":"docs/development/UI-App-development-guide.html"},{"name":"Custom Elements and Locations","href":"docs/development/UI-App-custom-elements-locations.html","topicHref":"docs/development/UI-App-custom-elements-locations.html"}]}]},{"name":"Blueprints","items":[{"name":"Getting started","href":"docs/development/blueprints/Getting-Started.html","topicHref":"docs/development/blueprints/Getting-Started.html"},{"name":".NET Blueprint","href":"docs/development/blueprints/Dot-Net-Blueprint.html","topicHref":"docs/development/blueprints/Dot-Net-Blueprint.html"},{"name":".NET Migration Blueprint","href":"docs/development/blueprints/Dot-Net-Migration-Blueprint.html","topicHref":"docs/development/blueprints/Dot-Net-Migration-Blueprint.html"},{"name":"Java Blueprint","href":"docs/development/blueprints/Java-Blueprint.html","topicHref":"docs/development/blueprints/Java-Blueprint.html"},{"name":"Java Migration Blueprint","href":"docs/development/blueprints/Java-Migration-Blueprint.html","topicHref":"docs/development/blueprints/Java-Migration-Blueprint.html"},{"name":"Testing","href":"docs/development/blueprints/Testing.html","topicHref":"docs/development/blueprints/Testing.html"},{"name":"Testing with Docker","href":"docs/development/blueprints/Testing-with-Docker.html","topicHref":"docs/development/blueprints/Testing-with-Docker.html"}]},{"name":"Samples","items":[{"name":"Java","href":"docs/development/samples/Java-Samples.html","topicHref":"docs/development/samples/Java-Samples.html"},{"name":".NET","href":"docs/development/samples/Dot-Net-Samples.html","topicHref":"docs/development/samples/Dot-Net-Samples.html"}]},{"name":"Integrate With Trados Cloud Platform API","href":"docs/development/Integrate-With-Trados-Cloud-Platform-API.html","topicHref":"docs/development/Integrate-With-Trados-Cloud-Platform-API.html"}]},{"name":"App Management","items":[{"name":"Foreword","href":"docs/appManagement/Foreword.html","topicHref":"docs/appManagement/Foreword.html"},{"name":"Registering","href":"docs/appManagement/Registering.html","topicHref":"docs/appManagement/Registering.html"},{"name":"Installing","href":"docs/appManagement/Installing.html","topicHref":"docs/appManagement/Installing.html"},{"name":"Validating","href":"docs/appManagement/Validating.html","topicHref":"docs/appManagement/Validating.html"},{"name":"Sharing","href":"docs/appManagement/Sharing.html","topicHref":"docs/appManagement/Sharing.html"},{"name":"Approvals","href":"docs/appManagement/Approvals.html","topicHref":"docs/appManagement/Approvals.html"},{"name":"Publishing","href":"docs/appManagement/Publishing.html","topicHref":"docs/appManagement/Publishing.html"},{"name":"Updating","href":"docs/appManagement/Updating.html","topicHref":"docs/appManagement/Updating.html"},{"name":"Retiring","href":"docs/appManagement/Retiring.html","topicHref":"docs/appManagement/Retiring.html"}]},{"name":"Machine Translation","href":"docs/consumer/MT-App-consumer-guide.html","topicHref":"docs/consumer/MT-App-consumer-guide.html"},{"name":"Automatic Task","href":"docs/consumer/Automatic-Task-App-consumer-guide.html","topicHref":"docs/consumer/Automatic-Task-App-consumer-guide.html"},{"name":"Dynamic Preview","href":"docs/consumer/Dynamic-Preview-guide.html","topicHref":"docs/consumer/Dynamic-Preview-guide.html"},{"name":"APIs","items":[{"name":"Extensibility API","href":"api/Extensibility-API.v1.html","topicHref":"api/Extensibility-API.v1.html"}]}]}

articles/LCPublicAPI/api/Data-Bridge-API.v1.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,15 @@
7474
<a href="Data-Bridge-API.v1-fv.html" style="display:inline-block;padding: 8px 15px; background-color: #6f45d9; color: white; text-decoration: none; border-radius: 5px;margin-bottom:10px;">
7575
⤢ View Documentation Fullscreen
7676
</a>
77+
<div style="font-size: 12px; color: #666; margin-top: 5px;">
78+
<em>API examples are only available when viewing in full-screen mode.</em>
79+
</div>
7780
</div>
7881
<div id="stoplight-api-container" style="margin-top:20px;"></div>
7982
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
8083
<script src="https://unpkg.com/@stoplight/elements/web-components.min.js"></script>
8184
<link rel="stylesheet" href="https://unpkg.com/@stoplight/elements/styles.min.css">
82-
<elements-api apidescriptionurl="Data-Bridge-API.v1.json" router="memory" layout="stacked"></elements-api>
85+
<elements-api apidescriptionurl="Data-Bridge-API.v1.json" router="memory" layout="stacked" hidetryit="true" hidetryitpanel="true"></elements-api>
8386

8487
</article>
8588
</div>

0 commit comments

Comments
 (0)