mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 20:37:50 +00:00
61 lines
2.0 KiB
YAML
61 lines
2.0 KiB
YAML
allOf:
|
|
- type: object
|
|
description: Service Desk integration's specification.
|
|
required:
|
|
- name
|
|
- description
|
|
- type
|
|
- attributes
|
|
properties:
|
|
name:
|
|
description: Service Desk integration's name. The name must be unique.
|
|
type: string
|
|
example: Service Desk Integration Name
|
|
description:
|
|
description: Service Desk integration's description.
|
|
type: string
|
|
example: A very nice Service Desk integration
|
|
type:
|
|
description: |
|
|
Service Desk integration types:
|
|
|
|
- ServiceNowSDIM
|
|
- ServiceNow
|
|
type: string
|
|
default: ServiceNowSDIM
|
|
example: ServiceNowSDIM
|
|
ownerRef:
|
|
allOf:
|
|
- $ref: '../../v3/schemas/OwnerDto.yaml'
|
|
clusterRef:
|
|
allOf:
|
|
- $ref: '../../v3/schemas/SourceClusterDto.yaml'
|
|
cluster:
|
|
description: Cluster ID for the Service Desk integration (replaced by clusterRef, retained for backward compatibility).
|
|
type: string
|
|
example: xyzzy999
|
|
deprecated: true
|
|
managedSources:
|
|
description: Source IDs for the Service Desk integration (replaced by provisioningConfig.managedSResourceRefs, but retained here for backward compatibility).
|
|
type: array
|
|
items:
|
|
type: string
|
|
deprecated: true
|
|
example:
|
|
- 2c9180835d191a86015d28455b4a2329
|
|
- 2c5680835d191a85765d28455b4a9823
|
|
provisioningConfig:
|
|
description: The 'provisioningConfig' property specifies the configuration used to provision integrations.
|
|
$ref: './ProvisioningConfig.yaml'
|
|
attributes:
|
|
description: Service Desk integration's attributes. Validation constraints enforced by the implementation.
|
|
type: object
|
|
additionalProperties: true
|
|
example: {
|
|
property: "value",
|
|
key: "value"
|
|
}
|
|
beforeProvisioningRule:
|
|
allOf:
|
|
- $ref: '../../v3/schemas/BeforeProvisioningRuleDto.yaml'
|