Automated commit 'Merge pull request #22 from sailpoint/NEROCKET-607

NEROCKET-607 updated ne_attribute schemas.' by github action: 8268099783

nerm/parameters/query/data_type.yaml

@@ -5,3 +5,4 @@ required: false
 schema:
   type: string
   enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search]
+  example: text field

nerm/parameters/query/label.yaml

@@ -4,3 +4,4 @@ description: The attribute label to filter by
 required: false
 schema:
   type: string
+  example: birthday

nerm/paths/ne_attributes.yaml

@@ -16,3 +16,18 @@ get:
       $ref: "../responses/400.yaml"
     '500':
       $ref: "../responses/500.yaml"
+post:
+  summary: Create an attribute
+  operationId: createAttribute
+  description: This endpoint can create an attribute
+  tags:
+    - attributes
+  requestBody:
+    $ref: "../requestBodies/POST/Attribute.yaml"
+  responses:
+    '201':
+      $ref: "../responses/Attribute.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/paths/ne_attributes_id.yaml

@@ -13,3 +13,20 @@ get:
       $ref: "../responses/400.yaml"
     '500':
       $ref: "../responses/500.yaml"
+patch:
+  summary: Update attribute data by id
+  operationId: updateAttribute
+  description: Update info for a specific attribute
+  tags:
+    - attributes
+  parameters:
+    - $ref: "../parameters/path/id.yaml"
+  requestBody:
+    $ref: "../requestBodies/PATCH/Attribute.yaml"
+  responses:
+    '200':
+      $ref: "../responses/Attribute.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/requestBodies/PATCH/Attribute.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        ne_attribute_option:
+          type: object
+          $ref: "../../schemas/PATCH/Attribute.yaml"

nerm/requestBodies/POST/Attribute.yaml

@@ -0,0 +1,9 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        ne_attribute_option:
+          type: object
+          $ref: "../../schemas/POST/Attribute.yaml"

nerm/schemas/GET/Attribute.yaml

@@ -4,67 +4,82 @@ properties:
     type: string
     format: uuid
     readOnly: true
+    description: The id of the attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
   uid:
     type: string
     minLength: 32
     maxLength: 32
     readOnly: true
+    description: The uid of the attribute
+    example: myattribute
   label:
     type: string
+    description: The label for the attribute
+    example: birthday
   description:
     type: string
+    description: A description of the attribute
+    example: Your birthday
   tool_tip:
     type: string
-  crypt:
+    description: The helper text that accompanies the attribute
-    type: boolean
+    example: Put your birthday here mm-dd-yyyy
   archived:
     type: boolean
-  archived_on:
+    description: Whether the attribute is archived
-    type: string
+    example: false
-    format: date-time
-    readOnly: true
-  created_at:
-    type: string
-    format: date-time
-    readOnly: true
-  updated_at:
-    type: string
-    format: date-time
-    readOnly: true
   date_format:
     type: string
     enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
+    description: The format of the date input if it is a date input
+    example: mm/dd/yyyy
   selectable_status:
     type: string
-  risk_score_setting:
+    description: The status of the profiles that can be selected
-    type: string
+    example: Active
   risk_type:
     type: string
+    description: Type of risk that applies to the attribute
+    example: OverallRisk
   ownership_driver:
     type: boolean
+    description: Only shows profiles that the user currently has access to, to be selected
+    example: true
   allow_multiple_selections:
     type: boolean
+    description: Whether or not multiple selections can be made on something like a contributor search.
+    example: true
   filtered_by_ne_attribute:
     type: boolean
+    description: Whether or not the attribute is filtered by another attribute
+    example: true
   filtering_ne_attribute_id:
     type: string
     format: uuid
+    description: The ID of the filtering attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
   ne_attribute_filter_id:
     type: string
     format: uuid
-  reverse_association_attribute_id:
+    description: The ID of the attribute filter
-    type: string
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
-    format: uuid
+  reverse_association_attribute:
+    $ref: './AttributeProperties.yaml'
   profile_type_id:
     type: string
     format: uuid
-  legacy_id:
+    description: The ID of the profile type the attribute applies to
-    type: integer
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
-  tmp_created_at:
+  data_type:
     type: string
-    format: date-time
+    enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search]
-    readOnly: true
+    description: The type of data that applies to the attribute
-  tmp_updated_at:
+    example: text field
+  type:
     type: string
-    format: date-time
+    enum: [AttachmentAttribute, CheckBoxesAttribute, ContributorSearchAttribute, ContributorSelectAttribute,
-    readOnly: true
+        DateAttribute, DropDownAttribute, OwnerSearchAttribute, OwnerSelectAttribute, ProfileSearchAttribute, ProfileSelectAttribute,
+        RadioButtonsAttribute, TagsAttribute, TextAreaAttribute, TextFieldAttribute]
+    description: The attribute's type
+    example: AttachmentAttribute

nerm/schemas/GET/AttributeProperties.yaml

@@ -0,0 +1,119 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+    description: The id of the attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  uid:
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+    description: The uid of the attribute
+    example: myattribute
+  label:
+    type: string
+    description: The label for the attribute
+    example: birthday
+  description:
+    type: string
+    description: A description of the attribute
+    example: Your birthday
+  tool_tip:
+    type: string
+    description: The helper text that accompanies the attribute
+    example: Put your birthday here mm-dd-yyyy
+  crypt:
+    type: boolean
+    description: Whether or not the attribute is encrypted
+    example: false
+  archived:
+    type: boolean
+    description: Whether the attribute is archived
+    example: false
+  archived_on:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was archived
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  created_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was created
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was last updated
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  date_format:
+    type: string
+    enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
+    description: The format of the date input if it is a date input
+    example: mm/dd/yyyy
+  selectable_status:
+    type: string
+    description: The status of the profiles that can be selected
+    example: Active
+  risk_score_setting:
+    type: string
+    description: What setting is used for the risk score
+    example: standard
+  risk_type:
+    type: string
+    description: Type of risk that applies to the attribute
+    example: OverallRisk
+  ownership_driver:
+    type: boolean
+    description: Only shows profiles that the user currently has access to, to be selected
+    example: true
+  allow_multiple_selections:
+    type: boolean
+    description: Whether or not multiple selections can be made on something like a contributor search.
+    example: true
+  filtered_by_ne_attribute:
+    type: boolean
+    description: Whether or not the attribute is filtered by another attribute
+    example: true
+  filtering_ne_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the filtering attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  ne_attribute_filter_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute filter
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  reverse_association_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute used with reverse association
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  profile_type_id:
+    type: string
+    format: uuid
+    description: The ID of the profile type the attribute applies to
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  legacy_id:
+    type: string
+    format: uuid
+    description: The legacy ID
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  tmp_created_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: the temp of when attribute was created
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  tmp_updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: the temp of when attribute was last updated
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00

nerm/schemas/PATCH/Attribute.yaml

@@ -0,0 +1,99 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+    description: The id of the attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  uid:
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+    description: The uid of the attribute
+    example: myattribute
+  label:
+    type: string
+    description: The label for the attribute
+    example: birthday
+  description:
+    type: string
+    description: A description of the attribute
+    example: Your birthday
+  tool_tip:
+    type: string
+    description: The helper text that accompanies the attribute
+    example: Put your birthday here mm-dd-yyyy
+  archived:
+    type: boolean
+    description: Whether the attribute is archived
+    example: false
+  date_format:
+    type: string
+    enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
+    description: The format of the date input if it is a date input
+    example: mm/dd/yyyy
+  selectable_status:
+    type: string
+    description: The status of the profiles that can be selected
+    example: Active
+  risk_type:
+    type: string
+    description: Type of risk that applies to the attribute
+    example: OverallRisk
+  ownership_driver:
+    type: boolean
+    description: Only shows profiles that the user currently has access to, to be selected
+    example: true
+  allow_multiple_selections:
+    type: boolean
+    description: Whether or not multiple selections can be made on something like a contributor search.
+    example: true
+  filtered_by_ne_attribute:
+    type: boolean
+    description: Whether or not the attribute is filtered by another attribute
+    example: true
+  filtering_ne_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the filtering attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  ne_attribute_filter_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute filter
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  reverse_association_attribute:
+    $ref: './AttributeProperties.yaml'
+  profile_type_id:
+    type: string
+    format: uuid
+    description: The ID of the profile type the attribute applies to
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  data_type:
+    type: string
+    enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search]
+    description: The type of data that applies to the attribute
+    example: text field
+  type:
+    type: string
+    enum: [AttachmentAttribute, CheckBoxesAttribute, ContributorSearchAttribute, ContributorSelectAttribute, DateAttribute, DropDownAttribute, OwnerSearchAttribute, OwnerSelectAttribute, ProfileSearchAttribute, ProfileSelectAttribute, RadioButtonsAttribute, TagsAttribute, TextAreaAttribute, TextFieldAttribute]
+    description: The attribute's type
+    example: AttachmentAttribute
+  validations_attributes:
+    type: object
+    properties:
+      validation_method:
+        type: string
+        enum: [required, unique, date_format, days, characters, extension, numericality, email_format, custom_format, no_special_chars]
+        description: The type of validation to be applied
+        example: required
+      value:
+        type: string
+        description: The value of the validator
+        example: "mm-dd-yyyy"
+      _destroy:
+        type: boolean
+        description: If the validator should be removed
+        example: false

nerm/schemas/PATCH/AttributeProperties.yaml

@@ -0,0 +1,119 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+    description: The id of the attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  uid:
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+    description: The uid of the attribute
+    example: myattribute
+  label:
+    type: string
+    description: The label for the attribute
+    example: birthday
+  description:
+    type: string
+    description: A description of the attribute
+    example: Your birthday
+  tool_tip:
+    type: string
+    description: The helper text that accompanies the attribute
+    example: Put your birthday here mm-dd-yyyy
+  crypt:
+    type: boolean
+    description: Whether or not the attribute is encrypted
+    example: false
+  archived:
+    type: boolean
+    description: Whether the attribute is archived
+    example: false
+  archived_on:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was archived
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  created_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was created
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was last updated
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  date_format:
+    type: string
+    enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
+    description: The format of the date input if it is a date input
+    example: mm/dd/yyyy
+  selectable_status:
+    type: string
+    description: The status of the profiles that can be selected
+    example: Active
+  risk_score_setting:
+    type: string
+    description: What setting is used for the risk score
+    example: standard
+  risk_type:
+    type: string
+    description: Type of risk that applies to the attribute
+    example: OverallRisk
+  ownership_driver:
+    type: boolean
+    description: Only shows profiles that the user currently has access to, to be selected
+    example: true
+  allow_multiple_selections:
+    type: boolean
+    description: Whether or not multiple selections can be made on something like a contributor search.
+    example: true
+  filtered_by_ne_attribute:
+    type: boolean
+    description: Whether or not the attribute is filtered by another attribute
+    example: true
+  filtering_ne_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the filtering attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  ne_attribute_filter_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute filter
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  reverse_association_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute used with reverse association
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  profile_type_id:
+    type: string
+    format: uuid
+    description: The ID of the profile type the attribute applies to
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  legacy_id:
+    type: string
+    format: uuid
+    description: The legacy ID
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  tmp_created_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: the temp of when attribute was created
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  tmp_updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: the temp of when attribute was last updated
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00

nerm/schemas/POST/Attribute.yaml

@@ -0,0 +1,99 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+    description: The id of the attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  uid:
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+    description: The uid of the attribute
+    example: myattribute
+  label:
+    type: string
+    description: The label for the attribute
+    example: birthday
+  description:
+    type: string
+    description: A description of the attribute
+    example: Your birthday
+  tool_tip:
+    type: string
+    description: The helper text that accompanies the attribute
+    example: Put your birthday here mm-dd-yyyy
+  archived:
+    type: boolean
+    description: Whether the attribute is archived
+    example: false
+  date_format:
+    type: string
+    enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
+    description: The format of the date input if it is a date input
+    example: mm/dd/yyyy
+  selectable_status:
+    type: string
+    description: The status of the profiles that can be selected
+    example: Active
+  risk_type:
+    type: string
+    description: Type of risk that applies to the attribute
+    example: OverallRisk
+  ownership_driver:
+    type: boolean
+    description: Only shows profiles that the user currently has access to, to be selected
+    example: true
+  allow_multiple_selections:
+    type: boolean
+    description: Whether or not multiple selections can be made on something like a contributor search.
+    example: true
+  filtered_by_ne_attribute:
+    type: boolean
+    description: Whether or not the attribute is filtered by another attribute
+    example: true
+  filtering_ne_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the filtering attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  ne_attribute_filter_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute filter
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  reverse_association_attribute:
+    $ref: './AttributeProperties.yaml'
+  profile_type_id:
+    type: string
+    format: uuid
+    description: The ID of the profile type the attribute applies to
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  data_type:
+    type: string
+    enum: [text field, text area, drop-down, radio buttons, check boxes, date, tags, attachment, profile select, profile search, owner select, owner search, contributor select, contributor search]
+    description: The type of data that applies to the attribute
+    example: text field
+  type:
+    type: string
+    enum: [AttachmentAttribute, CheckBoxesAttribute, ContributorSearchAttribute, ContributorSelectAttribute, DateAttribute, DropDownAttribute, OwnerSearchAttribute, OwnerSelectAttribute, ProfileSearchAttribute, ProfileSelectAttribute, RadioButtonsAttribute, TagsAttribute, TextAreaAttribute, TextFieldAttribute]
+    description: The attribute's type
+    example: AttachmentAttribute
+  validations_attributes:
+    type: object
+    properties:
+      validation_method:
+        type: string
+        enum: [required, unique, date_format, days, characters, extension, numericality, email_format, custom_format, no_special_chars]
+        description: The type of validation to be applied
+        example: required
+      value:
+        type: string
+        description: The value of the validator
+        example: "mm-dd-yyyy"
+      _destroy:
+        type: boolean
+        description: If the validator should be removed
+        example: false

nerm/schemas/POST/AttributeProperties.yaml

@@ -0,0 +1,119 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+    description: The id of the attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  uid:
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+    description: The uid of the attribute
+    example: myattribute
+  label:
+    type: string
+    description: The label for the attribute
+    example: birthday
+  description:
+    type: string
+    description: A description of the attribute
+    example: Your birthday
+  tool_tip:
+    type: string
+    description: The helper text that accompanies the attribute
+    example: Put your birthday here mm-dd-yyyy
+  crypt:
+    type: boolean
+    description: Whether or not the attribute is encrypted
+    example: false
+  archived:
+    type: boolean
+    description: Whether the attribute is archived
+    example: false
+  archived_on:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was archived
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  created_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was created
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: When the attribute was last updated
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  date_format:
+    type: string
+    enum: [mm/dd/yyyy, mm-dd-yyyy, dd/mm/yyyy, dd-mm-yyyy, yyyy/mm/dd, yyyy-mm-dd]
+    description: The format of the date input if it is a date input
+    example: mm/dd/yyyy
+  selectable_status:
+    type: string
+    description: The status of the profiles that can be selected
+    example: Active
+  risk_score_setting:
+    type: string
+    description: What setting is used for the risk score
+    example: standard
+  risk_type:
+    type: string
+    description: Type of risk that applies to the attribute
+    example: OverallRisk
+  ownership_driver:
+    type: boolean
+    description: Only shows profiles that the user currently has access to, to be selected
+    example: true
+  allow_multiple_selections:
+    type: boolean
+    description: Whether or not multiple selections can be made on something like a contributor search.
+    example: true
+  filtered_by_ne_attribute:
+    type: boolean
+    description: Whether or not the attribute is filtered by another attribute
+    example: true
+  filtering_ne_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the filtering attribute
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  ne_attribute_filter_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute filter
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  reverse_association_attribute_id:
+    type: string
+    format: uuid
+    description: The ID of the attribute used with reverse association
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  profile_type_id:
+    type: string
+    format: uuid
+    description: The ID of the profile type the attribute applies to
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  legacy_id:
+    type: string
+    format: uuid
+    description: The legacy ID
+    example: ac4aae0b-4140-49a4-a84c-126762fd0c8f
+  tmp_created_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: the temp of when attribute was created
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00
+  tmp_updated_at:
+    type: string
+    format: date-time
+    readOnly: true
+    description: the temp of when attribute was last updated
+    example: Wed, 07 Feb 2024 12:55:20.456682000 EST -05:00