diff --git a/docs/_snippets/accepted-credentials-objects.md b/docs/_snippets/accepted-credentials-objects.md new file mode 100644 index 0000000000..1d0ee86002 --- /dev/null +++ b/docs/_snippets/accepted-credentials-objects.md @@ -0,0 +1,22 @@ +Each member of the `AcceptedCredentials` array is an inner object named `Credential` with the following nested fields: + +| Field | JSON Type | [Internal Type][] | Required? | Description | +|:-----------------|:---------------------|:------------------|:----------|--------------| +| `Issuer` | String - [Address][] | AccountID | Yes | The issuer of the credential. | +| `CredentialType` | String | Blob | Yes | The type of credential, as hexadecimal. This is an arbitrary value from 1 to 64 bytes that the issuer sets when they issue a credential. | + +{% admonition type="info" name="Note" %} +In the usual JSON format, inner objects are wrapped in an object with one field, whose name defines the inner object type. In this case, the wrapping field is named `Credential`. For example: + +```json +"AcceptedCredentials": [ + { + "Credential": { + "Issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", + "CredentialType": "6D795F63726564656E7469616C" + } + }, + // ... additional Credential inner objects ... +] +``` +{% /admonition %} diff --git a/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md b/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md index b28a05ef21..8d5542d111 100644 --- a/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md +++ b/docs/references/protocol/ledger-data/ledger-entry-types/permissioneddomain.md @@ -52,31 +52,9 @@ In addition to the [common fields](../common-fields.md), {% code-page-name /%} e | `PreviousTxnLgrSeq` | Number | UInt32 | Yes | The [index of the ledger][Ledger Index] that contains the transaction that most recently modified this object. | | `Sequence` | Number | UInt32 | Yes | The `Sequence` value of the transaction that created this entry. | - ### AcceptedCredentials Objects -Each member of the `AcceptedCredentials` array is an inner object named `Credential` with the following nested fields: - -| Field | JSON Type | [Internal Type][] | Required? | Description | -|:-----------------|:---------------------|:------------------|:----------|--------------| -| `Issuer` | String - [Address][] | AccountID | Yes | The issuer of the credential. | -| `CredentialType` | String | Blob | Yes | The type of credential, as hexadecimal. This is an arbitrary value from 1 to 64 bytes that the issuer sets when they issue a credential. | - -{% admonition type="info" name="Note" %} -In the usual JSON format, inner objects are wrapped in an object with one field, whose name defines the inner object type. In this case, the wrapping field is named `Credential`. For example: - -```json -"AcceptedCredentials": [ - { - "Credential": { - "Issuer": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "CredentialType": "6D795F63726564656E7469616C" - } - }, - // ... additional Credential inner objects ... -] -``` -{% /admonition %} +{% raw-partial file="/docs/_snippets/accepted-credentials-objects.md" /%} ## {% $frontmatter.seo.title %} Flags diff --git a/docs/references/protocol/transactions/types/permissioneddomainset.md b/docs/references/protocol/transactions/types/permissioneddomainset.md index 690dc3e474..050e5c2a0d 100644 --- a/docs/references/protocol/transactions/types/permissioneddomainset.md +++ b/docs/references/protocol/transactions/types/permissioneddomainset.md @@ -40,6 +40,8 @@ _(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_ | `DomainID` | String - [Hash][] | Hash256 | No | The ledger entry ID of an existing permissioned domain to modify. If omitted, creates a new permissioned domain. | | `AcceptedCredentials` | Array | Array | Yes | A list of 1 to 10 [**Accepted Credentials objects**](#accepted-credentials-objects) that grant access to this domain. The list does not need to be sorted, but it cannot contain duplicates. When modifying an existing domain, this list replaces the existing list. | +### AcceptedCredentials Objects + {% raw-partial file="/docs/_snippets/accepted-credentials-objects.md" /%} ## {% $frontmatter.seo.title %} Flags