Automated commit 'Merge pull request #19 from sailpoint/NEROCKET-479

NEROCKET-479 added documentation for profile_type/ne_attributes with …' by github action: 7699854506

nerm/openapi.yaml

@@ -73,6 +73,8 @@ paths:
   /profile_types/{id}:
     $ref: "./paths/profile_types_id.yaml"
 # Synced attributes
+  /profile_types/{profile_type_id}/ne_attributes:
+    $ref: "./paths/profile_type_attributes.yaml"
   /profile_types/{profile_type_id}/synced_attributes:
     $ref: "./paths/synced_attributes.yaml"
   /profile_types/{profile_type_id}/synced_attributes/{ne_attribute_id}:

nerm/parameters/path/attribute_id.yaml

@@ -4,4 +4,5 @@ description: The id of the attachment attribute
 required: true
 schema:
   type: string
-  format: uuid
+  format: uuid
+  example: 1246d8b3-ac29-4015-8154-dea4434a73fa

nerm/parameters/query/page.yaml

@@ -0,0 +1,9 @@
+name: page
+in: query
+description: Pagination page number
+required: false
+schema:
+  type: integer
+  format: int32
+  minimum: 1
+  example: 5

nerm/parameters/query/per_page.yaml

@@ -0,0 +1,9 @@
+name: page
+in: query
+description: Pagination items per page
+required: false
+schema:
+  type: integer
+  format: int32
+  minimum: 1
+  example: 5

nerm/parameters/query/search.yaml

@@ -0,0 +1,7 @@
+name: search
+in: query
+description: Filter by string
+required: false
+schema:
+  type: string
+  example: search

nerm/parameters/query/sort.yaml

@@ -0,0 +1,15 @@
+name: sort
+in: query
+description: How records should be sorted
+required: false
+schema:
+  type: object
+  example: { attr: "sync", order: "asc" }
+  properties:
+    attr:
+      type: string
+      example: sync
+    order:
+      type: string
+      enum: [asc, desc]
+      example: asc

nerm/parameters/query/synced_attribute_active_filter.yaml

@@ -0,0 +1,8 @@
+name: active_filter
+in: query
+description: Filter for profile type synced attributes
+required: false
+schema:
+  type: string
+  enum: [synced, unsynced, all]
+  example: all

nerm/paths/profile_type_attributes.yaml

@@ -0,0 +1,20 @@
+get:
+  summary: profile_types/ne_attributes synced status
+  operationId: getProfileTypeAttributes
+  description: Get ne attributes and synced attribute relationship to profile type.
+  tags:
+    - synced attributes
+  parameters:
+    - $ref: "../parameters/path/profile_type_id.yaml"
+    - $ref: "../parameters/query/synced_attribute_active_filter.yaml"
+    - $ref: "../parameters/query/search.yaml"
+    - $ref: "../parameters/query/page.yaml"
+    - $ref: "../parameters/query/per_page.yaml"
+    - $ref: "../parameters/query/sort.yaml"
+  responses:
+    '200':
+      $ref: "../responses/ProfileTypeAttributes_Meta.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/responses/ProfileTypeAttributes_Meta.yaml

@@ -0,0 +1,9 @@
+description: Expected response to a valid request
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        form:
+          type: object
+          $ref: '../schemas/GET/ProfileTypeAttributes.yaml'

nerm/schemas/GET/ProfileTypeAttribute.yaml

@@ -0,0 +1,26 @@
+type: object
+properties:
+  id:
+    description: ID of ne attribute
+    type: string
+    format: uuid
+    readOnly: true
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa
+  uid:
+    description: Ne attribute's uid
+    type: string
+    minLength: 32
+    maxLength: 32
+    readOnly: true
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa
+  label:
+    description: Ne attribute's label
+    type: string
+    required: true
+    readOnly: true
+    example: object
+  synced:
+    description: synced_attribute ID if there is one
+    type: uuid
+    required: false
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa

nerm/schemas/GET/ProfileTypeAttributes.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  count:
+    type: integer
+    format: int32
+    description: How many ne attribute records exist
+    example: 5
+  records:
+    type: array
+    items:
+      $ref: './ProfileTypeAttribute.yaml'