diff --git a/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml b/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml index eddc4243c..c20849abd 100644 --- a/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml +++ b/static/api-specs/idn/beta/schemas/ProvisioningConfig.yaml @@ -5,6 +5,7 @@ properties: description: Specifies whether this configuration is used to manage provisioning requests for all sources from the org. If true, no managedResourceRefs are allowed. type: boolean readOnly: true + example: true managedResourceRefs: description: References to sources for the Service Desk integration template. May only be specified if universalManager is false. type: array @@ -12,6 +13,7 @@ properties: $ref: '../../v3/schemas/BaseReferenceDto.yaml' default: type: SOURCE + example: [] planInitializerScript: description: This is a reference to a plan initializer script. type: object @@ -19,3 +21,4 @@ properties: source: description: This is a Rule that allows provisioning instruction changes. type: string + example: diff --git a/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml b/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml index 5175ce39c..771d21504 100644 --- a/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml +++ b/static/api-specs/idn/beta/schemas/ServiceDeskIntegrationDto.yaml @@ -15,6 +15,7 @@ allOf: description: Type of the Service Desk integration type: string default: ServiceNowSDIM + example: ServiceNowSDIM ownerRef: description: Reference to the identity that is the owner of this Service Desk integration $ref: '../../v3/schemas/BaseReferenceDto.yaml' @@ -36,6 +37,9 @@ allOf: items: type: string deprecated: true + example: + - 2c9180835d191a86015d28455b4a2329 + - 2c5680835d191a85765d28455b4a9823 provisioningConfig: description: The 'provisioningConfig' property specifies the configuration used to provision integrations. $ref: './ProvisioningConfig.yaml' @@ -43,8 +47,16 @@ allOf: description: Attributes of the Service Desk integration. Validation constraints enforced by the implementation. type: object additionalProperties: true + example: { + property: "value", + key: "value" + } beforeProvisioningRule: description: Reference to beforeProvisioningRule for this Service Desk integration $ref: '../../v3/schemas/BaseReferenceDto.yaml' default: type: RULE + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" diff --git a/static/api-specs/idn/beta/schemas/Source.yaml b/static/api-specs/idn/beta/schemas/Source.yaml index aa41c97dc..e4ef26c7f 100644 --- a/static/api-specs/idn/beta/schemas/Source.yaml +++ b/static/api-specs/idn/beta/schemas/Source.yaml @@ -31,6 +31,10 @@ properties: description: >- Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can't be used. + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" managerCorrelationMapping: $ref: './ManagerCorrelationMapping.yaml' description: >- @@ -40,10 +44,18 @@ properties: $ref: '../../v3/schemas/BaseReferenceDto.yaml' description: >- Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" beforeProvisioningRule: $ref: '../../v3/schemas/BaseReferenceDto.yaml' description: >- Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" schemas: type: array items: diff --git a/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml b/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml index d950cc904..c20849abd 100644 --- a/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml +++ b/static/api-specs/idn/v3/schemas/ProvisioningConfig.yaml @@ -13,6 +13,7 @@ properties: $ref: '../../v3/schemas/BaseReferenceDto.yaml' default: type: SOURCE + example: [] planInitializerScript: description: This is a reference to a plan initializer script. type: object diff --git a/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml b/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml index 835e111c5..771d21504 100644 --- a/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml +++ b/static/api-specs/idn/v3/schemas/ServiceDeskIntegrationDto.yaml @@ -56,3 +56,7 @@ allOf: $ref: '../../v3/schemas/BaseReferenceDto.yaml' default: type: RULE + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" diff --git a/static/api-specs/idn/v3/schemas/Source.yaml b/static/api-specs/idn/v3/schemas/Source.yaml index 81d8aad60..5e2bd2984 100644 --- a/static/api-specs/idn/v3/schemas/Source.yaml +++ b/static/api-specs/idn/v3/schemas/Source.yaml @@ -31,6 +31,10 @@ properties: description: >- Reference to a Rule that can do COMPLEX the correlation, should only be used when accountCorrelationConfig can't be used. + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" managerCorrelationMapping: $ref: '../../v3/schemas/ManagerCorrelationMapping.yaml' description: >- @@ -40,10 +44,18 @@ properties: $ref: '../../v3/schemas/BaseReferenceDto.yaml' description: >- Reference to the ManagerCorrelationRule, only used when a simple filter isn't sufficient. + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" beforeProvisioningRule: $ref: '../../v3/schemas/BaseReferenceDto.yaml' description: >- Rule that runs on the CCG and allows for customization of provisioning plans before the connector is called. + example: + type: "RULE" + id: "2c918085708c274401708c2a8a760001" + name: "Example Rule" schemas: type: array items: