Core/app mgmt links #82
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…face itself. Improve requirements. Replace OpenAPI by InterfaceDefinition.
svefredrik
previously requested changes
Mar 4, 2021
Comment on lines
+290
to
+294
| <para>A device should provide an interface description for applications providing a programming API | ||
| for configuration and monitoring purposes. For these applications a device should provide a | ||
| link via the InterfaceDescription information item as defined in <xref linkend="_AppInfo"/>. It allows | ||
| clients to easily integrate application configuration and information retrieval. Examples for | ||
| interface description languages are JSON or YAML descriptions according to OpenAPI.</para> |
There was a problem hiding this comment.
I think it should be a URI to the UI itself not the description of the UI. This will make it easy for the VMS just to link to the UI for configuration of the App. Having the VMS understand the inner workings of the App's configuration is too much.
There was a problem hiding this comment.
This link is about a programmable interface. A link to the UI would also make sense, but from my point of view that would need its own entry point.
There was a problem hiding this comment.
For the webui of app, we could reuse the existing parameter.
Website - "Link to supplementary information about the application or its vendor"
There was a problem hiding this comment.
I think there will be little interest in this API definition URI, especially if it's unclear as above. "Examples for interface description languages are JSON or YAML descriptions according to OpenAPI". It can be anything? What is the VMS going to do with this? It can be OpenAPI? It can be a binary blob that you have to install? I think this belongs in vendor extenstions, and put the URI for the UI in the standardized interface.
sujithhanwha
reviewed
Mar 5, 2021
| <title>Backup and Restore</title> | ||
| <para>A device signals support for backup and restore of individual applications by | ||
| providing the Configuration URI int the application information items (see <xref | ||
| linkend="_AppInfo"/>). Clients can retrieve and backup the current configuration via the |
There was a problem hiding this comment.
typo errors " URI int the application" -> "URI in the application"
sujithhanwha
reviewed
Mar 5, 2021
| providing the Configuration URI int the application information items (see <xref | ||
| linkend="_AppInfo"/>). Clients can retrieve and backup the current configuration via the | ||
| http GET method. Note that the configuration itself is an opache blob. A backed-up | ||
| configuration may be restored at a later time by uploading it to the device via the http |
There was a problem hiding this comment.
typo error "opache" --> "opaque"
There was a problem hiding this comment.
It is supposed to be "Apache blob".
kieran242
requested changes
Mar 16, 2021
Please check, https://en.m.wikipedia.org/wiki/Opaque_binary_blob |
sujithhanwha
approved these changes
Mar 16, 2021
kieran242
approved these changes
Mar 16, 2021
Please file a separate pull request if you want to have a separate URL for an app web page. See also Sujiths response.
HansBusch
added a commit
that referenced
this pull request
Jun 23, 2021
* Update Analytics.xml Change 'shall' to 'should' in partial config updates requirement * Align message source definition with Annex A update. Insert reference to avoid that the items are defined by examples. * Clarify class likelihood. (#78) * Clarify class likelihood. * Range is [0..1]. * Remove requirement that sum shall be <= 1. * Update example. Change-Id: Ie0574ad87e2d6924c5c335e5b18ba20fb8026a6b * Typo Change-Id: I1adb70934a52a318db3772ee0d9af4648f16ce89 * Use enumerations for AudioClassType restriction values (#75) Closes #72 * Add capability to signal no support for discovery. (#74) * added CertPathValidationPolicyID to EventBrokerConfig (#76) * added CertPathValidationPolicyID to EventBrokerConfig * Annex D: updated to include analytics module and rule based on generic description language (#79) * added common requirement for field parameter for region based detector rules (#81) Co-authored-by: Sriram Bhetanabottla <sriramb@axis.com> * Update counting rule based on new rule structure (#53) * Split the counter into line crossing and occupancy counter. * Clarify reset time as local time. * Remove Direction from example to align OccupancyCounter example with specification. * Move sigC definition to 5.4 since it may apply to any signing not onl… (#83) * Move sigC definition to 5.4 since it may apply to any signing not only repeated. Refactor layout since structure got lost in docbook format. * Remove outdated explanation related to obsolete version zero using UUID references. (#84) * Core/attr list (#87) * Align simple item list types with elements for float and int. Reuse onvif.xsd list types instead of redefining. * Remove accidentally added file devicemgmt.xml. * Core/app mgmt links (#82) * Add two optional links for app configuration. * Add error code for version mismatch. * Clarify that the URI refers to the interface definition not the interface itself. Improve requirements. * Improve section on timeout and keep-alive handling. (#88) * Add reference to RTSP 2.0. Improve section on timeout and keep-alive handling. Improve chapter structure of the RTSP section. * Related to #88: remove deprecated method SetTimeout also from chart. * Replace text with xref in links to 5.2.3 section (#89) Some places with links to 5.2.3 section in Analytic service spec are designed as a text instead of <xref linkend="_Ref9001629" />. * Fix maxOccurrs to maxOccurs typo (#93) Occurrence section has typo: maxOccurrs (double 'r') * Fix order of parameter items in tt:LineCounting (#92) Description of tt:LineCounting has invalid order of items inside Parameters. ElementItemDescription shall follow after all SimpleItemDescription according to xml schema of ItemListDescription type. * Fix incorrect xml, Class can only exist once per object (#99) * Analytics/coordinate system (#94) Replace Default by Normalized to align naming of standard coordinate system. Related to ticket ext-2186. * Add combined type bike. (#95) * Update introduction section to GetEventProperties. (#97) Update introduction section to GetEventProperties. * Fix ABNF missing example changes and improve readability by splitting long construct. (#98) * Fix ABNF missing example changes. * Improve readability by splitting long construct. * Change ABNF code to programlisting. * Replace curved double quotes in ABNF by simple double quotes. * Align example output with analytics spec. * Remove superfluous curly bracket in JSON example Co-authored-by: Fredrik Svensson <fredriks@axis.com> * Sync credential.wsdl to 21.06 branch (#102) This appears to have been lost in transition to github and should have been in 20.12. * coordinates system clarification to media2 (#107) * Add PasswordPolicySupported capability (#105) * Add PasswordPolicySupported capability * capabilities as stringlist * Add flow.svg to new Use case examples appendix (annex) (#96) flow.svg is based on source/flow.uml using http://www.plantuml.com Change-Id: Id42e61714ebc6ead2a69a93b716237701175213c Co-authored-by: Johan Adolfsson <johana@axis.com> * doorcontrol.wsdl: Workaround for xs:any not last in Door (#100) When Door extends DoorInfo it got the extensions in the "middle" of the type which gsoap doesn't like causing occurance violation errors. Instead extend DoorInfoBase and add the Capabilities element first to Door type. This solves https://wush.net/trac/onvif/ticket/2727 Change-Id: Ibb95984a41dfed35fa5cdd6ade5fbb9c45745be0 Co-authored-by: Johan Adolfsson <johana@axis.com> * Fix typo in xml example * Remove hidden annotation with wrong restriction (related to ext-2179) (#110) * Remove hidden annotation with wrong restriction (related to ext-2179) * Fix typo related to change. * Change example coordinates to normative (related to ext-2214) (#109) * Update revision information. * Update revision information. * Update version information. * Update version information. * Update version information. * Update version information. * Update version information. * Update version information. * Update version information. * Update version information. * Update replay.wsdl * Update version information. * Update version information. * Apply review findings: 1. short title "AppMgmtSrv" vs "App Mgmt. Service". Other specs omit service. Should be corrected to "App Mgmt." 2. Missing line breaks in 6.2.1 after http codes 3. Missing explanation alignment of list in section 6.3.1 4. GetCapabilities response has wrong namespace timg (both old & new) 5. Figure 1 a bit too large and not centered because wrong dimensions (pixel instead of mm). Fixed media directory name * Review feedback: replace orderedlist because not supported by stylesheets. * Correction of typos from specification review. * Improve formatting based on review feedback. * Move new item CertPathValidationPolicyID to extension point to avoid breaking change. (#117) Co-authored-by: OksanaTyushkina <76164127+OksanaTyushkina@users.noreply.github.com> Co-authored-by: Fredrik Svensson <fredriks@axis.com> Co-authored-by: Matthew Brush <mbrush@codebrainz.ca> Co-authored-by: Davide Cristanelli <davide.cristanelli@videotec.com> Co-authored-by: sujith raman <67031640+sujithhanwha@users.noreply.github.com> Co-authored-by: Sriram Bhetanabottla <1432443+bsriramprasad@users.noreply.github.com> Co-authored-by: Sriram Bhetanabottla <sriramb@axis.com> Co-authored-by: johado <papputten@gmail.com> Co-authored-by: Johan Adolfsson <johana@axis.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add application Configuration and InterfaceDescription properties.