Skip to content

Commit

Permalink
ci: fix: Jenkins build error (#1349)
Browse files Browse the repository at this point in the history
Signed-off-by: edgex-jenkins <collab-it+edgex@linuxfoundation.org>
  • Loading branch information
edgex-jenkins committed Mar 28, 2024
1 parent 3c10629 commit 79d1105
Show file tree
Hide file tree
Showing 71 changed files with 2,783 additions and 842 deletions.
36 changes: 18 additions & 18 deletions 3.1/V3TopLevelMigration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3130,12 +3130,12 @@ <h3 id="configuration-file">Configuration File</h3>
<p>The <a href="https://www.convertsimple.com/convert-toml-to-yaml/">tool here</a> can be used to convert your customized service configuration file from TOML to YAML. This should be done once all the common configuration has been removed.</p>
<p>The following are where you can find the configuration migration specifics for individual EdgeX services</p>
<ul>
<li><a href="../microservices/core/data/Ch-CoreData/#v3-configuration-migration-guide">Core Data</a> </li>
<li><a href="../microservices/core/metadata/Ch-Metadata/#v3-configuration-migration-guide">Core Metadata</a> </li>
<li><a href="../microservices/core/command/Ch-Command/#v3-configuration-migration-guide">Core Command</a></li>
<li><a href="../microservices/support/notifications/Ch-AlertsNotifications/#v3-configuration-migration-guide">Support Notifications</a></li>
<li><a href="../microservices/support/scheduler/Ch-Scheduler/#v3-configuration-migration-guide">Support Scheduler</a></li>
<li><a href="../microservices/application/V3Migration/#configuration">Application Services</a></li>
<li><a href="#core-data">Core Data</a> </li>
<li><a href="#core-metadata">Core Metadata</a> </li>
<li><a href="#core-command">Core Command</a></li>
<li><a href="#support-notifications">Support Notifications</a></li>
<li><a href="#support-scheduler">Support Scheduler</a></li>
<li><a href="#application-services">Application Services</a></li>
<li><a href="../microservices/device/V3Migration/#configuration">Device Services (common)</a></li>
<li><a href="../microservices/device/V3Migration/#device-mqtt">Device MQTT</a></li>
<li><a href="../microservices/device/V3Migration/#device-onvif-camera">Device ONVIF Camera</a></li>
Expand Down Expand Up @@ -3179,7 +3179,7 @@ <h4 id="api-change">API Change</h4>
<li>Add Event
To identify which device service generating the new event, POST endpoint is now changed from <code>/event/{profileName}/{deviceName}/{sourceName}</code> to <code>/event/{serviceName}/{profileName}/{deviceName}/{sourceName}</code></li>
</ul>
<p>See <a href="../api/core/Ch-APICoreData">Core Data API Reference</a> for complete details.</p>
<p>See <a href="../microservices/core/data/ApiReference/">Core Data API Reference</a> for complete details.</p>
<h4 id="reading">Reading</h4>
<ul>
<li>Added <code>tags</code> field in reading.</li>
Expand Down Expand Up @@ -3227,7 +3227,7 @@ <h4 id="api-change_1">API Change</h4>
</ul>
</li>
</ul>
<p>See <a href="../api/core/Ch-APICoreMetadata">Core Metadata API Reference</a> for complete details.</p>
<p>See <a href="../microservices/core/metadata/ApiReference/">Core Metadata API Reference</a> for complete details.</p>
<h3 id="core-command">Core Command</h3>
<h4 id="api-change_2">API Change</h4>
<ul>
Expand All @@ -3236,26 +3236,26 @@ <h4 id="api-change_2">API Change</h4>
</ul>
</li>
</ul>
<p>See <a href="../api/core/Ch-APICoreCommand">Core Command API Reference</a> for complete details.</p>
<p>See <a href="../microservices/core/command/ApiReference/">Core Command API Reference</a> for complete details.</p>
<h3 id="support-notifications">Support Notifications</h3>
<p>Any <code>Subscriptions</code> created via the V2 REST API will have to be recreated using the V3 REST API. The <code>Notification</code> and <code>Transmission</code>collections will be empty until new notifications are sent using EdgeX V3 </p>
<h3 id="support-scheduler">Support Scheduler</h3>
<h4 id="api-change_3">API Change</h4>
<ul>
<li>Added <code>authmethod</code> to support-scheduler actions DTO, which indicates how to authenticate the outbound URL. Use <code>NONE</code> when running in non-secure mode and <code>JWT</code> when running in secure mode.</li>
</ul>
<p>See <a href="../api/support/Ch-APISupportScheduler">Support Scheduler API Reference</a> for complete details.</p>
<p>See <a href="../microservices/support/scheduler/ApiReference/">Support Scheduler API Reference</a> for complete details.</p>
<p>The statically declared <code>Interval</code> and <code>IntervalAction</code> will be created automatically. Any <code>Interval</code> and/or <code>IntervalAction</code> created via the V2 REST API will have to be recreated using the V3 REST API. If you have created a custom configuration with additional statically declared <code>Interval</code>s and <code>IntervalActions</code> see the <a href="#configuration-file">Configuration File</a> section under <a href="#customized-configuration">Customized Configuration</a> below.</p>
<h3 id="application-services">Application Services</h3>
<p>Application services use the database only when the <a href="../microservices/application/AdvancedTopics/#store-and-forward">Store and Forward</a> capability is enabled. If you do not use this capability you can skip this section. This data collection only has data when that data could not be exported. It is recommended not to upgrade to V3 while the Store and Forward data collection is not empty or you are certain the data is no longer needed. You can determine if the Store and Forward data collection is empty by setting the Application Service's log level to <code>DEBUG</code> and look for the following message which is logged every <code>RetryInterval</code>:</p>
<p>Application services use the database only when the <a href="../microservices/application/sdk/details/StoreAndForward/">Store and Forward</a> capability is enabled. If you do not use this capability you can skip this section. This data collection only has data when that data could not be exported. It is recommended not to upgrade to V3 while the Store and Forward data collection is not empty or you are certain the data is no longer needed. You can determine if the Store and Forward data collection is empty by setting the Application Service's log level to <code>DEBUG</code> and look for the following message which is logged every <code>RetryInterval</code>:</p>
<div class="admonition example">
<p class="admonition-title">Example</p>
<div class="highlight"><pre><span></span><code>msg=" 0 stored data items found for retrying"
</code></pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code>RetryInterval</code> is in the <code>app-services</code> section of <a href="../microservices/configuration/CommonConfiguration">common configuration</a>. Changing it there will apply to all Application Services that have the <a href="../microservices/application/AdvancedTopics/#store-and-forward">Store and Forward</a> capability enabled.</p>
<p>The <code>RetryInterval</code> is in the <code>app-services</code> section of <a href="../microservices/configuration/CommonConfiguration">common configuration</a>. Changing it there will apply to all Application Services that have the <a href="../microservices/application/sdk/details/StoreAndForward/">Store and Forward</a> capability enabled.</p>
</div>
<h3 id="clearing-redis-database">Clearing Redis Database</h3>
<h4 id="docker">Docker</h4>
Expand All @@ -3270,19 +3270,19 @@ <h4 id="local">Local</h4>
</code></pre></div>
<p>This will not work if running EdgeX in running in secure mode since you will not have the random generated Redis password unless you created an Admin password when you installed Redis.</p>
<h2 id="custom-device-service">Custom Device Service</h2>
<p>If you have custom Device Services they will need to be migrated to the V3 version of the Device SDK. See <a href="../microservices/device/V3Migration">Device Service V3 Migration Guide</a> for complete details.</p>
<p>If you have custom Device Services they will need to be migrated to the V3 version of the Device SDK. See <a href="../microservices/device/V3Migration/">Device Service V3 Migration Guide</a> for complete details.</p>
<h2 id="custom-device-profile">Custom Device Profile</h2>
<p>If you have custom V2 Device Profile(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Device Profiles. See <a href="../microservices/device/V3Migration#device-profiles">Device Service V3 Migration Guide</a> for complete details.</p>
<p>If you have custom V2 Device Profile(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Device Profiles. See <a href="../microservices/device/V3Migration/#device-profile">Device Service V3 Migration Guide</a> for complete details.</p>
<h2 id="custom-pre-defined-device">Custom Pre-Defined Device</h2>
<p>If you have custom V2 Pre-Defined Device(s) for one of the EdgeX Device Services they will need to be migrated to the V3 version of Pre-Defined Devices. See <a href="../microservices/device/V3Migration/#device-files">Device Service V3 Migration Guide</a> for complete details.</p>
<h2 id="custom-applications-service">Custom Applications Service</h2>
<p>If you have custom Application Services they will need to be migrated to the V3 version of the App Functions SDK. See <a href="../microservices/application/V3Migration">Application Services V3 Migration Guide</a> for complete details.</p>
<p>If you have custom Application Services they will need to be migrated to the V3 version of the App Functions SDK. See <a href="../microservices/application/V3Migration/">Application Services V3 Migration Guide</a> for complete details.</p>
<h2 id="security">Security</h2>
<p>If you have an add-on services running in secure mode you will need to use the new names of the environment variables in EdgeX V3. See <a href="../security/V3Migration">Security Services V3 Migration Guide</a> for more details.</p>
<p>If you have an add-on services running in secure mode you will need to use the new names of the environment variables in EdgeX V3. See <a href="../security/V3Migration/">Security Services V3 Migration Guide</a> for more details.</p>
<h3 id="api-gateway-configuration">API Gateway configuration</h3>
<p>The API gateway has changed in EdgeX V3. See <a href="../security/V3Migration">Security Services V3 Migration Guide</a> for more details.</p>
<p>The API gateway has changed in EdgeX V3. See <a href="../security/V3Migration/">Security Services V3 Migration Guide</a> for more details.</p>
<h3 id="authenticated-rest-apis">Authenticated REST APIs</h3>
<p>When security is enable, all V3 EdgeX services REST APIs require a JWT authorization token. See <a href="../security/V3Migration">Security Services V3 Migration Guide</a> for more details.</p>
<p>When security is enable, all V3 EdgeX services REST APIs require a JWT authorization token. See <a href="../security/V3Migration/">Security Services V3 Migration Guide</a> for more details.</p>
<h2 id="ekuiper">eKuiper</h2>
<h3 id="rules">Rules</h3>
<h4 id="rest-action">Rest Action</h4>
Expand Down
4 changes: 2 additions & 2 deletions 3.1/api/core/Ch-APICoreCommand/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2649,7 +2649,7 @@
<h1 id="core-command">Core Command</h1>
<p>EdgeX Foundry's Command microservice is a conduit for other services to
trigger action on devices and sensors through their managing Device
Services. See <a href="../../../microservices/core/command/Ch-Command/">Core Command</a> for more details about this service.</p>
Services. See <a href="../../../microservices/core/command/GettingStarted/">Core Command</a> for more details about this service.</p>
<p>The service provides an API to get the list of commands that
can be issued for all devices or a single device. Commands are divided
into two groups for each device:</p>
Expand All @@ -2664,7 +2664,7 @@ <h1 id="core-command">Core Command</h1>
dimmer light.</li>
</ul>
<h2 id="swagger">Swagger</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="ee589ad4" src="swagger-ee589ad4.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="81b27042" src="swagger-81b27042.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
</div>
</div>
Expand Down
120 changes: 120 additions & 0 deletions 3.1/api/core/Ch-APICoreCommand/swagger-81b27042.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../../assets/stylesheets/swagger-ui-dark.css" />

</head>

<body style="overflow:hidden;background: ;">
<div id="swagger-ui"></div>
<script src="../../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
<script src="../../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
<script>
window.onload = function () {
window.ui = SwaggerUIBundle({
dom_id: "#swagger-ui",
onComplete: onComplete,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],

url: "https://raw.githubusercontent.com/edgexfoundry/edgex-go/v3.1/openapi/v3/core-command.yaml",


"oauth2RedirectUrl": new URL("../../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,

"validatorUrl": "none",

"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
"supportedSubmitMethods": [
"get",
"put",
"post",
"delete",
"options",
"head",
"patch",
"trace"
],
"validatorUrl": "none",
"extra_css": [],
"dark_scheme_name": "slate",
"syntaxHighlight.theme": "agate"

})



const scheme = parent.scheme
if (scheme === "slate") {
enable_dark_mode();
}
}

enable_dark_mode = function(){
document.getElementById("slate-css").media = ""
}

disable_dark_mode = function(){
document.getElementById("slate-css").media = "none"
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("81b27042");
});

// start observing for resizing
resize_ob.observe(document.querySelector("body"));

// authorize modal position
var modal_top = 0;

const mutation_ob = new MutationObserver(function (mutations) {
if(mutations && mutations[0].addedNodes && mutations[0].addedNodes.length > 0){
update_modal_top()
}
});

onComplete = function(){
// start observing for auth-wrapper after Swagger UI loaded
const div = document.querySelector("div.auth-wrapper");
if(div){
mutation_ob.observe(div, {
childList: true,
});
}
}

update_top_val = function(top){
modal_top = top
update_modal_top()
}

update_modal_top = function(){
let modal_list = document.getElementsByClassName('modal-ux')
if(modal_list.length > 0){
let modal = modal_list.item(0)
const modal_height = modal.offsetHeight
const padding = 60
min = parseInt(modal_height/2 + padding)
max = document.body.scrollHeight - min + padding
if (modal_top < min) {
modal.style.top = `${min}px`
} else if (modal_top > max) {
modal.style.top = `${max}px`
} else {
modal.style.top = `${modal_top}px`
}
}
}
</script>
</body>

</html>
2 changes: 1 addition & 1 deletion 3.1/api/core/Ch-APICoreMetadata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2652,7 +2652,7 @@ <h1 id="core-metadata">Core Metadata</h1>
device provisioning service deposits and manages device metadata through
this service's API. See <a href="../../../microservices/core/metadata/Purpose/">Core Metadata</a> for more details about this service.</p>
<h2 id="swagger">Swagger</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="2ca41d3d" src="swagger-2ca41d3d.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="686b085e" src="swagger-686b085e.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
</div>
</div>
Expand Down
120 changes: 120 additions & 0 deletions 3.1/api/core/Ch-APICoreMetadata/swagger-686b085e.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
<!DOCTYPE html>
<html lang="en">

<head>
<meta charset="UTF-8">
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="../../../assets/stylesheets/swagger-ui.css" />
<link rel="stylesheet" type="text/css" id="slate-css" media="none" href="../../../assets/stylesheets/swagger-ui-dark.css" />

</head>

<body style="overflow:hidden;background: ;">
<div id="swagger-ui"></div>
<script src="../../../assets/javascripts/swagger-ui-bundle.js" charset="UTF-8"> </script>
<script src="../../../assets/javascripts/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
<script>
window.onload = function () {
window.ui = SwaggerUIBundle({
dom_id: "#swagger-ui",
onComplete: onComplete,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],

url: "https://raw.githubusercontent.com/edgexfoundry/edgex-go/v3.1/openapi/v3/core-metadata.yaml",


"oauth2RedirectUrl": new URL("../../../assets/swagger-ui/oauth2-redirect.html",window.location.href).href,

"validatorUrl": "none",

"docExpansion": "list",
"filter": false,
"tryItOutEnabled": false,
"supportedSubmitMethods": [
"get",
"put",
"post",
"delete",
"options",
"head",
"patch",
"trace"
],
"validatorUrl": "none",
"extra_css": [],
"dark_scheme_name": "slate",
"syntaxHighlight.theme": "agate"

})



const scheme = parent.scheme
if (scheme === "slate") {
enable_dark_mode();
}
}

enable_dark_mode = function(){
document.getElementById("slate-css").media = ""
}

disable_dark_mode = function(){
document.getElementById("slate-css").media = "none"
}

const resize_ob = new ResizeObserver(function(entries) {
parent.update_swagger_ui_iframe_height("686b085e");
});

// start observing for resizing
resize_ob.observe(document.querySelector("body"));

// authorize modal position
var modal_top = 0;

const mutation_ob = new MutationObserver(function (mutations) {
if(mutations && mutations[0].addedNodes && mutations[0].addedNodes.length > 0){
update_modal_top()
}
});

onComplete = function(){
// start observing for auth-wrapper after Swagger UI loaded
const div = document.querySelector("div.auth-wrapper");
if(div){
mutation_ob.observe(div, {
childList: true,
});
}
}

update_top_val = function(top){
modal_top = top
update_modal_top()
}

update_modal_top = function(){
let modal_list = document.getElementsByClassName('modal-ux')
if(modal_list.length > 0){
let modal = modal_list.item(0)
const modal_height = modal.offsetHeight
const padding = 60
min = parseInt(modal_height/2 + padding)
max = document.body.scrollHeight - min + padding
if (modal_top < min) {
modal.style.top = `${min}px`
} else if (modal_top > max) {
modal.style.top = `${max}px`
} else {
modal.style.top = `${modal_top}px`
}
}
}
</script>
</body>

</html>
2 changes: 1 addition & 1 deletion 3.1/api/devices/Ch-APIDeviceSDK/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2650,7 +2650,7 @@ <h1 id="device-services">Device Services</h1>
<p>The EdgeX Foundry Device Service Software Development Kit (SDK) takes the Developer through the step-by-step process to create an EdgeX Foundry Device Service microservice. See <a href="../../../microservices/device/sdk/Purpose/">Device Service SDK</a> for more details on this SDK.</p>
<p>The Device Service SDK provides a RESTful API that all Device Services inherit from the SDK.</p>
<h2 id="swagger">Swagger</h2>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="f89bd7e8" src="swagger-f89bd7e8.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
<p><iframe class="swagger-ui-iframe" frameborder="0" id="3cdb8ca1" src="swagger-3cdb8ca1.html" style="overflow:hidden;width:100%;" width="100%"></iframe></p>
</article>
</div>
</div>
Expand Down
Loading

0 comments on commit 79d1105

Please sign in to comment.