Skip to content

Commit eca481c

Browse files
Clarify renewal configuration not limited to credentials. (#723)
* Clarify renewal configuration not limited to credentials. * fixed misspell * clarified as 'configuration including credentials'
1 parent eb66316 commit eca481c

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

doc/Core.xml

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6482,10 +6482,7 @@ onvif://www.onvif.org/name/ARV-453
64826482
</section>
64836483
<section>
64846484
<title>Configuration Renewal</title>
6485-
<para>
6486-
The configuration allows for a renewal endpoint to be set. If the device supports this feature, it shall automatically renew the credentials
6487-
when they are about to expire.
6488-
</para>
6485+
<para> The configuration allows for a renewal endpoint to be set.</para>
64896486
<para>
64906487
The device shall do a GET request to the configured <literal>RenewalEndpoint</literal> with the access token retrieved from the configured
64916488
<literal>AuthorizationServer</literal>. The endpoint shall respond with a JSON payload with the following structure:
@@ -6501,16 +6498,15 @@ onvif://www.onvif.org/name/ARV-453
65016498
}]]></programlisting>
65026499
Any null value in the response shall clear the corresponding optional parameter in the configuration used by the device.
65036500
</para>
6504-
<para>
6505-
When the device receives a configuration with the <literal>ConfigurationRenewal</literal> set, it shall immediately contact
6506-
the renewal endpoint to get up-to-date credentials. The device may use the credentials available in the configuration in the
6507-
meantime to avoid service disruption.
6508-
</para>
6509-
<para>
6510-
The device shall ensure to renew the configuration before the expiration provided by the <literal>expiresAt</literal> field.
6511-
If the renewal endpoint fails to provide a valid response, the device shall continue to use the existing configuration and retry
6512-
later using an exponential backoff strategy.
6513-
</para>
6501+
<para> When the device receives a configuration with the
6502+
<literal>ConfigurationRenewal</literal> set, it shall immediately contact the renewal
6503+
endpoint to get up-to-date renewal configuration payload including credentials. The device
6504+
may use the current credentials available in the configuration in the meantime to avoid
6505+
service disruption. </para>
6506+
<para> The device shall ensure to renew the configuration including credentials before the
6507+
expiration provided by the <literal>expiresAt</literal> field. If the renewal endpoint
6508+
fails to provide a valid response, the device shall continue to use the existing
6509+
configuration and retry later using an exponential backoff strategy. </para>
65146510
</section>
65156511
<section>
65166512
<title>GetStorageConfigurations</title>

wsdl/ver10/actionengine.wsdl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -809,7 +809,7 @@ IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FO
809809
</xs:element>
810810
<xs:element name="FtpAuthentication" type="tae:FtpAuthenticationConfiguration">
811811
<xs:annotation>
812-
<xs:documentation>User credentials confguration for target FTP Server</xs:documentation>
812+
<xs:documentation>User credentials configuration for target FTP Server</xs:documentation>
813813
</xs:annotation>
814814
</xs:element>
815815
<xs:element name="Extension" type="tae:FtpDestinationConfigurationExtension" minOccurs="0"/>

0 commit comments

Comments
 (0)