Type of issue

Missing information

Feedback

Not sure if this an issue with the documentation of the WebApplicationInfo or VersionOverrides elements and/or related office.js SSO example manifiest.xml code snippet, but documentation on the WebApplicationInfo should called out that it has to be the last child in the VersionOverrides element.

How I got here was attempting to update an existing app registration, i was unable to update the registration with a new version of the manifest.xml file, where the only changes were:

• incrementing the version number /OfficeApp/Version
• adding the WebApplicationInfo as the first child of the OfficeApp/VersionOverrides element.

which resulted in the following generic error:

Upload failed. Please check the manifest file and try again.

When reviewing the documentation, I noticed the example had the WebApplicationInfo element as the last child of the VersionOverrides element. After all other attempts failed to resolved the above error, i cut the existing WebApplicationInfo from being the first child element of the VersionOverrides element and pasted it as the last child element instead.

Attemping to update the registration again in o365 with this newly updated manifest file results in...

Manifest file validated

XML is a structured document, but the ordering of child elements is usual agnostic. In my case the VersionOverrides schmea was:

<VersionOverrides 
    xmlns="http://schemas.microsoft.com/office/taskpaneappversionoverrides" 
    xsi:type="VersionOverridesV1_0">

Drilling down into the schema there is a defined sequence.

<xs:sequence>
  <xs:element name="Description" .../>
  <xs:element name="Requirements" .../>
  <xs:element name="Hosts" .../>
  <xs:element name="Resources" .../>
  <xs:element name="WebApplicationInfo" type="WebApplicationInfo" minOccurs="0" maxOccurs="1"/>
  ...
</xs:sequence>

The documentation and related code document examples (see https://learn.microsoft.com/en-us/office/dev/add-ins/develop/create-sso-office-add-ins-nodejs) should call this out and to make it more prevalent as a requirement.

Page URL

https://learn.microsoft.com/en-us/javascript/api/manifest/webapplicationinfo?view=common-js-preview

Content source URL

https://github.com/OfficeDev/office-js-docs-reference/blob/live/docs/manifest/webapplicationinfo.md

Author

@o365devx

Document Id

a9b151fc-b563-6ba9-d9ba-dbca9e9953e6

Platform Id

b40702d5-a1bd-e335-b2e0-7d4d87e617e3