Skip to main content
Version: ACAP version 13 Preview

Manifest schemas

The ACAP manifest schema defines the structure and content of the manifest.json. It acts as an agreement between the ACAP and the AXIS OS, describing metadata, runtime behavior, and the resources that the application needs. By using the manifest, ACAP applications can be validated before installation, declare their required capabilities, remain uniform in structure, and operate consistently across devices and AXIS OS versions.

The pages listed in the table of contents below present detailed descriptions of the fields in the generated manifest schema.

info

AXIS OS 13 requires a manifest.json with schemaVersion v2. For guidance see:

Information about manifest schema v1 is available in the ACAP version 12 documetation.

Overview​

  • The SDK is bundled with manifest schemas of various versions.
  • When you run acap-build, it validates your manifest.json file against a specific manifest schema version.
  • The manifest schema is versioned separately from the SDK.
  • Newer SDK versions include newer manifest schema versions. See Manifest schema version mapping for details.

Required fields​

The structure of the fields can be seen by the list level. A required field in a sub-section means it's only required if the section above is chosen.

Validation​

The manifest.json file is validated in multiple stages:

During build​

When running acap-build, the manifest is validated against the manifest schema version specified in schemaVersion.

During signing​

When signing the application in the ACAP Service Portal, the manifest is validated again. It always validates against the latest manifest schema version within the same major version you specified in schemaVersion.

To avoid signing issues, it's recommended to validate your application against the latest manifest schema version within the same major version during development and build time.

info

To sign an ACAP application the minimum manifest schema version possible to use is 1.3, which introduced the for signing mandatory field architecture.

Manifest schema version mapping​

The tables below show the SDK version in which each manifest schema version was released, along with a description of the changes.

Manifest schema version 2​

SchemaAXIS OSSDKDescription
2.0.012.1012.10.0Initial version of manifest schema version 2. For upgrade instructions, see Upgrade to schema v2.x.
- New required fields compatibleOsVersions and vendorId, and architecture is now required.
- New resource deepLearningProcessor for specifying if the application requires or desires access to the Deep Learning Processing Unit (DLPU).
- Removed embeddedSdkVersion field, and containers configuration.