Skip to content

Commit c4b3ed1

Browse files
committed
Updating documentation for version SNAPSHOT
1 parent f8d2f5c commit c4b3ed1

File tree

3 files changed

+9
-23
lines changed

3 files changed

+9
-23
lines changed

documentation/archives/SNAPSHOT/api/cards/swagger-spec.js

-4
Original file line numberDiff line numberDiff line change
@@ -459,10 +459,6 @@ window.swaggerSpec={
459459
"type" : "integer",
460460
"minimum" : 0
461461
},
462-
"toNotify" : {
463-
"type" : "boolean",
464-
"description" : "Is false if the card must not be displayed in the feed and in monitoring screen"
465-
},
466462
"actions" : {
467463
"type" : "array",
468464
"items" : {

documentation/archives/SNAPSHOT/api/users/swagger-spec.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ window.swaggerSpec={
148148
"roles" : {
149149
"type" : "array",
150150
"items" : {
151-
"$ref" : "#/definitions/RolesEnum"
151+
"$ref" : "#/definitions/RoleEnum"
152152
}
153153
}
154154
},
@@ -159,12 +159,12 @@ window.swaggerSpec={
159159
"description" : "Control Room 1"
160160
}
161161
},
162-
"RolesEnum" : {
162+
"RoleEnum" : {
163163
"type" : "string",
164164
"description" : "Different possible roles >\n* ACTIVITY_AREA : Used to display an entity in the activity area screen\n* ACTIVITY_AREA_GROUP : Used to group entities in the activity area screen\n* CARD_SENDER : Allows an entity to send cards\n* CARD_RECEIVER : Allows an entity to receive cards",
165165
"enum" : [ "ACTIVITY_AREA", "ACTIVITY_AREA_GROUP", "CARD_SENDER", "CARD_RECEIVER" ]
166166
},
167-
"RightsEnum" : {
167+
"RightEnum" : {
168168
"type" : "string",
169169
"description" : "Different possible rights >\n* Receive: Only receive rights (receiving card)\n* ReceiveAndWrite: Receive and write rights (receiving card and creating new card)",
170170
"enum" : [ "Receive", "ReceiveAndWrite" ]
@@ -176,7 +176,7 @@ window.swaggerSpec={
176176
"type" : "string"
177177
},
178178
"right" : {
179-
"$ref" : "#/definitions/RightsEnum"
179+
"$ref" : "#/definitions/RightEnum"
180180
},
181181
"filteringNotificationAllowed" : {
182182
"type" : "boolean",
@@ -433,7 +433,7 @@ window.swaggerSpec={
433433
"type" : "string"
434434
},
435435
"rights" : {
436-
"$ref" : "#/definitions/RightsEnum"
436+
"$ref" : "#/definitions/RightEnum"
437437
},
438438
"filteringNotificationAllowed" : {
439439
"type" : "boolean",

documentation/archives/SNAPSHOT/docs/single_page_doc.html

+4-14
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@
531531
<h1>OperatorFabric Documentation</h1>
532532
<div class="details">
533533
<span id="revnumber">version SNAPSHOT,</span>
534-
<span id="revdate">25 December 2024</span>
534+
<span id="revdate">26 December 2024</span>
535535
</div>
536536
<div id="toc" class="toc2">
537537
<div id="toctitle">Table of Contents</div>
@@ -1775,7 +1775,7 @@ <h1>OperatorFabric Documentation</h1>
17751775
</li>
17761776
<li><a href="#_migration_guide_from_release_4_5_x_to_release_4_6_0">96. Migration Guide from release 4.5.X to release 4.6.0</a>
17771777
<ul class="sectlevel2">
1778-
<li><a href="#_deprecated_tonotify_field">96.1. Deprecated <code>toNotify</code> field</a></li>
1778+
<li><a href="#_removed_field_tonotify">96.1. Removed field <code>toNotify</code></a></li>
17791779
<li><a href="#_new_line_added_between_opfab_fields_and_template_in_usercard_form">96.2. New line added between opfab fields and template in usercard form</a></li>
17801780
<li><a href="#_timeline_domain_tr_renamed_rt">96.3. Timeline domain TR renamed RT</a></li>
17811781
<li><a href="#_ui_archives_and_logging_number_of_lines_per_page">96.4. UI archives and logging number of lines per page</a></li>
@@ -3885,16 +3885,6 @@ <h6 id="_secondsbeforetimespanforreminder_secondsbeforetimespanforreminder"><a c
38853885
</div>
38863886
</div>
38873887
<div class="sect5">
3888-
<h6 id="_tonotify_tonotify"><a class="anchor" href="#_tonotify_tonotify"></a>ToNotify (<code>toNotify</code>)</h6>
3889-
<div class="paragraph">
3890-
<p>Boolean attribute. If the card must not be displayed in the feed and in monitoring screen, this field must be set to false.
3891-
In that case, it means the card is stored only in archivedCards collection and not in cards collection.</p>
3892-
</div>
3893-
<div class="paragraph">
3894-
<p>The <code>toNotify</code> field is deprecated, use the <code>STORE_ONLY_IN_ARCHIVES</code> card action instead.</p>
3895-
</div>
3896-
</div>
3897-
<div class="sect5">
38983888
<h6 id="_publisher_type_publishertype"><a class="anchor" href="#_publisher_type_publishertype"></a>Publisher type (<code>publisherType</code>)</h6>
38993889
<div class="ulist">
39003890
<ul>
@@ -22409,9 +22399,9 @@ <h3 id="_rabbitmq_3"><a class="anchor" href="#_rabbitmq_3"></a>95.11. RabbitMQ</
2240922399
<h2 id="_migration_guide_from_release_4_5_x_to_release_4_6_0"><a class="anchor" href="#_migration_guide_from_release_4_5_x_to_release_4_6_0"></a>96. Migration Guide from release 4.5.X to release 4.6.0</h2>
2241022400
<div class="sectionbody">
2241122401
<div class="sect2">
22412-
<h3 id="_deprecated_tonotify_field"><a class="anchor" href="#_deprecated_tonotify_field"></a>96.1. Deprecated <code>toNotify</code> field</h3>
22402+
<h3 id="_removed_field_tonotify"><a class="anchor" href="#_removed_field_tonotify"></a>96.1. Removed field <code>toNotify</code></h3>
2241322403
<div class="paragraph">
22414-
<p>The card field <code>toNotify</code> is deprecated. You should use the <code>actions</code> field including "STORE_ONLY_IN_ARCHIVES" action instead.</p>
22404+
<p>The card field <code>toNotify</code> has been removed. You must use the <code>actions</code> field including "STORE_ONLY_IN_ARCHIVES" action instead.</p>
2241522405
</div>
2241622406
</div>
2241722407
<div class="sect2">

0 commit comments

Comments
 (0)