From bd170d6b5ae4b0acbc3b56e95c5489530b52246a Mon Sep 17 00:00:00 2001 From: GitHub Action Bot Date: Thu, 5 Oct 2023 17:08:04 +0000 Subject: [PATCH] Automated commit 'Merge pull request #1421 from sailpoint/devrel-1183 Devrel 1183' by github action: 6422197389 --- idn/beta/schemas/JsonPatchOperation.yaml | 12 ++++++++++-- idn/beta/schemas/Segment.yaml | 15 +++++++++------ idn/v3/schemas/JsonPatchOperation.yaml | 12 ++++++++++-- idn/v3/schemas/Segment.yaml | 14 +++++++------- idn/v3/schemas/access/OwnerReference.yaml | 6 ++++-- .../schemas/access/OwnerReferenceSegments.yaml | 18 ++++++++++++++++++ 6 files changed, 58 insertions(+), 19 deletions(-) create mode 100644 idn/v3/schemas/access/OwnerReferenceSegments.yaml diff --git a/idn/beta/schemas/JsonPatchOperation.yaml b/idn/beta/schemas/JsonPatchOperation.yaml index 68a96af0..f1639efc 100644 --- a/idn/beta/schemas/JsonPatchOperation.yaml +++ b/idn/beta/schemas/JsonPatchOperation.yaml @@ -20,15 +20,23 @@ properties: description: A string JSON Pointer representing the target path to an element to be affected by the operation example: "/description" value: - anyOf: + oneOf: - type: string + example: "New description" + title: string - type: integer + example: 300 + title: integer - type: object + title: object + example: {"attributes": {"name": "philip"}} - type: array + title: array items: anyOf: - type: string - type: integer - type: object + example: ["001","002","003"] description: The value to be used for the operation, required for "add" and "replace" operations - example: "New description" + example: "New description" \ No newline at end of file diff --git a/idn/beta/schemas/Segment.yaml b/idn/beta/schemas/Segment.yaml index 927bc9be..17e271bf 100644 --- a/idn/beta/schemas/Segment.yaml +++ b/idn/beta/schemas/Segment.yaml @@ -2,29 +2,32 @@ type: object properties: id: type: string + description: The segment's ID. example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" name: type: string - description: Segment Business Name + description: The segment's business name. example: "segment-xyz" created: type: string format: date-time - description: The time when this Segment is created + description: The time when the segment is created. example: "2020-01-01T00:00:00.000000Z" modified: type: string format: date-time - description: The time when this Segment is modified + description: The time when the segment is modified. example: "2020-01-01T00:00:00.000000Z" description: type: string - description: Optional description of the Segment + description: The segment's optional description. example: "This segment represents xyz" owner: - $ref: '../../v3/schemas/access/OwnerReference.yaml' + $ref: '../../v3/schemas/access/OwnerReferenceSegments.yaml' visibilityCriteria: $ref: './VisibilityCriteria.yaml' active: type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. + description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. + default: false + example: true diff --git a/idn/v3/schemas/JsonPatchOperation.yaml b/idn/v3/schemas/JsonPatchOperation.yaml index 68a96af0..f1639efc 100644 --- a/idn/v3/schemas/JsonPatchOperation.yaml +++ b/idn/v3/schemas/JsonPatchOperation.yaml @@ -20,15 +20,23 @@ properties: description: A string JSON Pointer representing the target path to an element to be affected by the operation example: "/description" value: - anyOf: + oneOf: - type: string + example: "New description" + title: string - type: integer + example: 300 + title: integer - type: object + title: object + example: {"attributes": {"name": "philip"}} - type: array + title: array items: anyOf: - type: string - type: integer - type: object + example: ["001","002","003"] description: The value to be used for the operation, required for "add" and "replace" operations - example: "New description" + example: "New description" \ No newline at end of file diff --git a/idn/v3/schemas/Segment.yaml b/idn/v3/schemas/Segment.yaml index e2d67c36..17e271bf 100644 --- a/idn/v3/schemas/Segment.yaml +++ b/idn/v3/schemas/Segment.yaml @@ -2,32 +2,32 @@ type: object properties: id: type: string - description: The id of the Segment. + description: The segment's ID. example: "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" name: type: string - description: Segment Business Name + description: The segment's business name. example: "segment-xyz" created: type: string format: date-time - description: The time when this Segment is created + description: The time when the segment is created. example: "2020-01-01T00:00:00.000000Z" modified: type: string format: date-time - description: The time when this Segment is modified + description: The time when the segment is modified. example: "2020-01-01T00:00:00.000000Z" description: type: string - description: Optional description of the Segment + description: The segment's optional description. example: "This segment represents xyz" owner: - $ref: '../../v3/schemas/access/OwnerReference.yaml' + $ref: '../../v3/schemas/access/OwnerReferenceSegments.yaml' visibilityCriteria: $ref: './VisibilityCriteria.yaml' active: type: boolean - description: Whether the Segment is currently active. Inactive segments have no effect. + description: This boolean indicates whether the segment is currently active. Inactive segments have no effect. default: false example: true diff --git a/idn/v3/schemas/access/OwnerReference.yaml b/idn/v3/schemas/access/OwnerReference.yaml index bd1bb745..eed01a87 100644 --- a/idn/v3/schemas/access/OwnerReference.yaml +++ b/idn/v3/schemas/access/OwnerReference.yaml @@ -1,9 +1,11 @@ type: object -nullable: true +nullable: false description: The owner of this object. properties: type: - $ref: '../DtoType.yaml' + type: string + enum: + - IDENTITY description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. example: 'IDENTITY' id: diff --git a/idn/v3/schemas/access/OwnerReferenceSegments.yaml b/idn/v3/schemas/access/OwnerReferenceSegments.yaml new file mode 100644 index 00000000..361da655 --- /dev/null +++ b/idn/v3/schemas/access/OwnerReferenceSegments.yaml @@ -0,0 +1,18 @@ +type: object +nullable: true +description: The owner of this object. +properties: + type: + type: string + enum: + - IDENTITY + description: Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result. + example: 'IDENTITY' + id: + type: string + description: Identity id + example: '2c9180a46faadee4016fb4e018c20639' + name: + type: string + description: Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result. + example: 'support' \ No newline at end of file