Changelog moved. Divisions promoted.

GallagherSecurity · Dec 6, 2024 · ce04f3a · ce04f3a
1 parent dde21ad
commit ce04f3a
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 20 deletions.
diff --git a/ref/cardholders.html b/ref/cardholders.html
@@ -13265,7 +13265,7 @@ <h3 id="notes">Notes</h3>
                       <span class="json-property-range" title="Value limits"></span>
                     </dt>
                     <dd>
-                      <p>A block containing the href of the changed cardholder. You can GET this URL to find the cardholder&#39;s current state (or you could add the cardholder block to the change using <code>fields=cardholder</code> in the query).</p>
+                      <p>A block containing the href of the changed cardholder. You can GET this URL to find the cardholder&#39;s current state, or you could add the cardholder block to the change using <code>fields=cardholder</code> in the query. Note that you can add individual cardholder fields such as PDFs using <code>fields=defaults,cardholder.personalDataFields</code>.</p>
                     </dd>
                     <dt data-property-name="operator" class="has-description">
                       <span class="json-property-name">operator:</span>

diff --git a/ref/events.html b/ref/events.html
@@ -57,7 +57,7 @@ <h5>Operations</h5>
             <a href="#tag-Divisions">Divisions</a>
             <ul>
               <li>
-                <a href="#operation--api-divisions-post"> Create a division [coming soon] </a>
+                <a href="#operation--api-divisions-post"> Create a division </a>
               </li>
               <li>
                 <a href="#operation--api-divisions--operation--get"> List divisions </a>
@@ -66,7 +66,7 @@ <h5>Operations</h5>
                 <a href="#operation--api-divisions--id--get"> Get details of a division </a>
               </li>
               <li>
-                <a href="#operation--api-divisions--id--patch"> Update a division [coming soon] </a>
+                <a href="#operation--api-divisions--id--patch"> Update a division </a>
               </li>
               <li>
                 <a href="#operation--api-divisions--id--delete"> Remove a division </a>
@@ -167,10 +167,9 @@ <h3 id="licensing">Licensing</h3>
                 <p>The server will return a 403 if you attempt an operation for which the server is not licensed.</p>
                 <h3 id="versions">Versions</h3>
                 <p>The body of this document clearly indicates when recent features arrived in the API so that readers with older versions of Command Centre know not to expect them.</p>
-                <h4 id="alarms-events-and-items-api-changes-on-the-roadmap">Alarms, events, and items API changes on the roadmap</h4>
-                <ul>
-                  <li>You will be able to create and delete divisions, and modify some basic fields.</li>
-                </ul>
+                <h4 id="alarms-events-and-items-api-changes">Alarms, events, and items API changes</h4>
+                <p>The changelog is now in the
+                  <a href="index.html">parent page</a>.</p>
                 <h4 id="alarms-and-events-api-changes-in-920">Alarms and events API changes in 9.20</h4>
                 <ul>
                   <li>You can filter by events&#39; direct division. The current division search is recursive: it returns all events that have any of the filter&#39;s divisions anywhere in their ancestry. The new division search is shallow: it only returns events that are direct members of the filter&#39;s divisions.</li>
@@ -1549,7 +1548,7 @@ <h3 id="licensing">Licensing</h3>
             <!-- </div> -->
             <!-- </section> -->
             <h2 class="operation-title">
-              <span class="operation-summary">Create a division [coming soon]</span>
+              <span class="operation-summary">Create a division</span>
             </h2>
             <div class="doc-row">
               <div class="doc-copy">
@@ -1569,7 +1568,7 @@ <h2 class="operation-title">
                   <p>When successful it returns a <code>location</code> header containing the address of the new division.</p>
                   <p>Note that you can only create one division per POST.</p>
                   <p>Do not code this URL into your application. Take it from the results of <code>GET /api</code>. That shows the API features for which you have the necessary licence.</p>
-                  <p>It is coming to a future version of Command Centre.</p>
+                  <p>New to 9.30.</p>
                 </section>
               </div>
             </div>
@@ -2041,7 +2040,7 @@ <h5>Response Example
             <!-- </div> -->
             <!-- </section> -->
             <h2 class="operation-title">
-              <span class="operation-summary">Update a division [coming soon]</span>
+              <span class="operation-summary">Update a division</span>
             </h2>
             <div class="doc-row">
               <div class="doc-copy">
@@ -2058,7 +2057,7 @@ <h2 class="operation-title">
                   <p>The PATCH expects a document in the same format as the
                     <a href="#definition-Division">the division detail</a> but with fewer valid fields. An example is
                     <a href="#definition-Division-PATCH-and-POST-example">this PATCH example</a>.</p>
-                  <p>Patching divisions is coming to a future version of Command Centre.</p>
+                  <p>New to 9.30.</p>
                 </section>
               </div>
             </div>

diff --git a/ref/index.html b/ref/index.html
@@ -101,6 +101,9 @@ <h1 id="topic-API-changes-in-9.30" data-traverse-target="topic-API-changes-in-9.
             <div class="doc-row">
               <div class="doc-copy">
                 <ul>
+                  <li>
+                    <p>You can create, modify, and delete divisions.</p>
+                  </li>
                   <li>
                     <p>The server will accept TLS 1.3 connections when running on suitable versions of Windows. Prior versions would only accept TLS 1.2 connections.</p>
                   </li>

diff --git a/ref/rest.html b/ref/rest.html
@@ -365,7 +365,12 @@ <h3 id="versions">Versions</h3>
                 <p>The body of this document clearly indicates when recent features arrived in the API so that readers with older versions of Command Centre know not to expect them.</p>
                 <h4 id="api-changes-on-the-roadmap">API changes on the roadmap</h4>
                 <ul>
-                  <li>An integration will be able to set its own status text and declare itself faulted, which will raise a Command Centre alarm.</li>
+                  <li>
+                    <p>You will be able to create and delete alarm zones, and modify some basic fields.</p>
+                  </li>
+                  <li>
+                    <p>An integration will be able to set its own status text and declare itself faulted, which will raise a Command Centre alarm.</p>
+                  </li>
                 </ul>
                 <h4 id="changes-in-930">Changes in 9.30</h4>
                 <ul>

diff --git a/swagger/cardholdersApi.yaml b/swagger/cardholdersApi.yaml
@@ -3688,8 +3688,9 @@ definitions:
       item:
         description: |
           A block containing the href of the changed cardholder.  You can GET this URL to find the
-          cardholder's current state (or you could add the cardholder block to the change using
-          `fields=cardholder` in the query).
+          cardholder's current state, or you could add the cardholder block to the change using
+          `fields=cardholder` in the query.  Note that you can add individual cardholder fields such
+          as PDFs using `fields=defaults,cardholder.personalDataFields`.
         type: object
         example: {"href":"https://localhost:8904/api/cardholders/525"}
       operator:

diff --git a/swagger/eventsApi.yaml b/swagger/eventsApi.yaml
@@ -42,9 +42,9 @@ info:
     The body of this document clearly indicates when recent features arrived in the API so that
     readers with older versions of Command Centre know not to expect them.
 
-    #### Alarms, events, and items API changes on the roadmap
+    #### Alarms, events, and items API changes
 
-    * You will be able to create and delete divisions, and modify some basic fields.
+    The changelog is now in the [parent page](index.html).
 
     #### Alarms and events API changes in 9.20
 
@@ -1649,7 +1649,7 @@ paths:
     post:
       tags:
       - Divisions
-      summary: Create a division [coming soon]
+      summary: Create a division
       description: |
         Creates a new division.
 
@@ -1664,7 +1664,7 @@ paths:
         Do not code this URL into your application.  Take it from the results of `GET /api`.  That
         shows the API features for which you have the necessary licence.
 
-        It is coming to a future version of Command Centre.
+        New to 9.30.
 
       parameters:
         - name: "this name not rendered"
@@ -1758,15 +1758,15 @@ paths:
     patch:
       tags:
       - Divisions
-      summary: Update a division [coming soon]
+      summary: Update a division
       description: |
         This is the call you use to update a division's name, description, notes, or parent.
 
         The PATCH expects a document in the same format as the [the division
         detail](#definition-Division) but with fewer valid fields.  An example is [this PATCH
         example](#definition-Division-PATCH-and-POST-example).
 
-        Patching divisions is coming to a future version of Command Centre.
+        New to 9.30.
 
       parameters:
         - name: "this name not rendered"

diff --git a/swagger/indexApi.yaml b/swagger/indexApi.yaml
@@ -78,6 +78,8 @@ x-spectacle-topics:
   API changes in 9.30:
     description: |
 
+      * You can create, modify, and delete divisions.
+
       * The server will accept TLS 1.3 connections when running on suitable versions of Windows.
         Prior versions would only accept TLS 1.2 connections.
 

diff --git a/swagger/restApi.yaml b/swagger/restApi.yaml
@@ -55,6 +55,8 @@ info:
 
     #### API changes on the roadmap
 
+    * You will be able to create and delete alarm zones, and modify some basic fields.
+
     * An integration will be able to set its own status text and declare itself faulted, which will
       raise a Command Centre alarm.