Skip to content

chore: update doc #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
leotrinh merged 1 commit into from
Mar 5, 2026
Merged

chore: update doc #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/Apps.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/AppsCopy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,7 +860,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/AppsCore.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2001,7 +2001,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/AppsDeployment.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2408,7 +2408,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/BuildPacks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1151,7 +1151,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/CfIgnoreHelper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1115,7 +1115,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/CloudController.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1027,7 +1027,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/CloudControllerBase.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2485,7 +2485,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Domains.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,7 +940,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Events.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -626,7 +626,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/HttpUtils.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1410,7 +1410,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Jobs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1476,7 +1476,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Logs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,7 +725,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Organizations.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2525,7 +2525,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/OrganizationsQuota.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1084,7 +1084,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Routes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1311,7 +1311,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/ServiceBindings.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1127,7 +1127,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
27 changes: 14 additions & 13 deletions doc/ServiceInstances.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,7 +592,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line531">line 531</a>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line534">line 534</a>
</li></ul></dd>


Expand Down Expand Up @@ -1825,7 +1825,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line502">line 502</a>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line505">line 505</a>
</li></ul></dd>


Expand Down Expand Up @@ -2328,8 +2328,9 @@ <h4 class="name" id="startInstance"><span class="type-signature"></span>startIns


<div class="description">
Start a managed Service Instance (v3 only).
Used for HANA and other stoppable managed services on SAP BTP.
Start a managed Service Instance (e.g., HANA Cloud DB).
Sends PATCH with serviceStopped=false parameter.
Only works for managed service instances that support lifecycle operations.
</div>


Expand Down Expand Up @@ -2381,7 +2382,7 @@ <h5>Parameters:</h5>



<td class="description last">[Service Instance GUID]</td>
<td class="description last">Service instance GUID</td>
</tr>


Expand Down Expand Up @@ -2422,7 +2423,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line468">line 468</a>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line469">line 469</a>
</li></ul></dd>


Expand Down Expand Up @@ -2451,7 +2452,7 @@ <h5>Returns:</h5>


<div class="param-desc">
[Resolves with operation job or updated instance]
Resolves when start operation is accepted (202)
</div>


Expand Down Expand Up @@ -2488,8 +2489,8 @@ <h4 class="name" id="stopInstance"><span class="type-signature"></span>stopInsta


<div class="description">
Stop a managed Service Instance (v3 only).
Used for HANA and other stoppable managed services on SAP BTP.
Stop a managed Service Instance (e.g., HANA Cloud DB).
Sends PATCH with serviceStopped=true parameter.
</div>


Expand Down Expand Up @@ -2541,7 +2542,7 @@ <h5>Parameters:</h5>



<td class="description last">[Service Instance GUID]</td>
<td class="description last">Service instance GUID</td>
</tr>


Expand Down Expand Up @@ -2582,7 +2583,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line485">line 485</a>
<a href="model_cloudcontroller_ServiceInstances.js.html">model/cloudcontroller/ServiceInstances.js</a>, <a href="model_cloudcontroller_ServiceInstances.js.html#line487">line 487</a>
</li></ul></dd>


Expand Down Expand Up @@ -2611,7 +2612,7 @@ <h5>Returns:</h5>


<div class="param-desc">
[Resolves with operation job or updated instance]
Resolves when stop operation is accepted (202)
</div>


Expand Down Expand Up @@ -2907,7 +2908,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/ServicePlans.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -952,7 +952,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Services.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1148,7 +1148,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Spaces.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2770,7 +2770,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/SpacesQuota.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1084,7 +1084,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Stacks.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/UserProvidedServices.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1096,7 +1096,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
2 changes: 1 addition & 1 deletion doc/Users.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -940,7 +940,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Apps.html
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 19:01:34 GMT+0700 (Indochina Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.11</a> on Thu Mar 05 2026 22:52:02 GMT+0700 (Indochina Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading