Release_iOS-15_macOS-12

declarative/protocol/declarationitemsresponse.yaml

@@ -0,0 +1,84 @@
+title: Declaration Items Response
+description: The set of available declarations on the server.
+payload:
+  requesttype: DeclarationItemsResponse
+  supportedOS:
+    iOS:
+      introduced: '15.0'
+payloadkeys:
+- key: Declarations
+  title: Manifest Declaration Items
+  type: <dictionary>
+  presence: required
+  content: The set of available declarations on the server.
+  subkeys:
+  - key: Activations
+    title: Activations
+    type: <array>
+    presence: required
+    content: The list of available activation declarations on the server.
+    subkeytype: DeclarationItem
+    subkeys:
+    - key: _Activations
+      title: Manifest Declaration
+      type: <dictionary>
+      content: Information about an available declaration on the server.
+      subkeytype: DeclarationItem
+      subkeys: &id001
+      - key: Identifier
+        title: Declaration Identifier
+        type: <string>
+        presence: required
+        content: The declaration's identifier.
+      - key: ServerToken
+        title: Declaration Server Token
+        type: <string>
+        presence: required
+        content: |-
+          The 'ServerToken' value of the declaration.
+          The client uses this to determine if the actual payload is different from the one on the client. Servers must compute the token over the entire declaration content to ensure the value always changes whenever there's any change to the content.
+  - key: Configurations
+    title: Configurations
+    type: <array>
+    presence: required
+    content: The list of available configuration declarations on the server.
+    subkeytype: DeclarationItem
+    subkeys:
+    - key: _Configurations
+      title: Manifest Declaration
+      type: <dictionary>
+      content: Information about an available declaration on the server.
+      subkeytype: DeclarationItem
+      subkeys: *id001
+  - key: Assets
+    title: Assets
+    type: <array>
+    presence: required
+    content: The list of available asset declarations on the server.
+    subkeytype: DeclarationItem
+    subkeys:
+    - key: _Assets
+      title: Manifest Declaration
+      type: <dictionary>
+      content: Information about an available declaration on the server.
+      subkeytype: DeclarationItem
+      subkeys: *id001
+  - key: Management
+    title: Management
+    type: <array>
+    presence: required
+    content: The list of available management declarations on the server.
+    subkeytype: DeclarationItem
+    subkeys:
+    - key: _Management
+      title: Manifest Declaration
+      type: <dictionary>
+      content: Information about an available declaration on the server.
+      subkeytype: DeclarationItem
+      subkeys: *id001
+- key: DeclarationsToken
+  title: Declarations Token
+  type: <string>
+  presence: required
+  content: The current value of the declarations token. Clients use this to detect
+    when declarations change so they can refetch the token.

declarative/protocol/statusreport.yaml

@@ -0,0 +1,57 @@
+title: Status Report
+description: Status sent by the client.
+payload:
+  requesttype: StatusReport
+  supportedOS:
+    iOS:
+      introduced: '15.0'
+payloadkeys:
+- key: StatusItems
+  title: Status Items
+  type: <dictionary>
+  presence: required
+  content: The status items for this report.
+- key: Errors
+  title: Errors
+  type: <array>
+  presence: required
+  content: An array of errors for this status report.
+  subkeys:
+  - key: _Errors
+    title: Error
+    type: <dictionary>
+    content: Error information for a status item that cannot be returned.
+    subkeys:
+    - key: StatusItem
+      title: Status Item
+      type: <string>
+      presence: required
+      content: The status item that this error pertains to.
+    - key: Reasons
+      title: Status Reasons
+      type: <array>
+      presence: optional
+      content: An array of reasons for the error.
+      subkeytype: StatusReason
+      subkeys:
+      - key: _Reasons
+        title: Status Reason
+        type: <dictionary>
+        content: Information about a status error.
+        subkeytype: StatusReason
+        subkeys:
+        - key: Code
+          title: Error Code
+          type: <string>
+          presence: required
+          content: The error code for this error.
+        - key: Description
+          title: Error Description
+          type: <string>
+          presence: optional
+          content: The description for this error.
+        - key: Details
+          title: Error Details
+          type: <dictionary>
+          presence: optional
+          content: A dictionary that contains further details about this error.

declarative/protocol/tokensresponse.yaml

@@ -0,0 +1,16 @@
+title: Tokens Response
+description: The server's synchronization tokens.
+payload:
+  requesttype: TokensResponse
+  supportedOS:
+    iOS:
+      introduced: '15.0'
+payloadkeys:
+- key: SyncTokens
+  title: Synchronization Tokens
+  type: <dictionary>
+  presence: required
+  content: A dictionary of synchronization tokens that describes the state of different
+    types of data on the server. The client uses these tokens to determine which endpoints
+    it needs to use to fetch new or updated data on the server.
+  subkeytype: SynchronizationTokens