Automated commit 'Merge pull request #17 from sailpoint/NEROCKET-480

NEROCKET-480 added documentation for synced attributes post.' by github action: 7699793466

nerm/openapi.yaml

@@ -72,6 +72,9 @@ paths:
     $ref: "./paths/profile_types.yaml"
   /profile_types/{id}:
     $ref: "./paths/profile_types_id.yaml"
+# Synced attributes
+  /profile_types/{profile_type_id}/synced_attributes:
+    $ref: "./paths/synced_attributes.yaml"
 # Profile Type Roles
   /profile_type_roles:
     $ref: "./paths/profile_type_roles.yaml" 

nerm/paths/synced_attributes.yaml

@@ -0,0 +1,15 @@
+post:
+  summary: Create a synced attribute
+  operationId: createSyncedAttribute
+  description: Create synced attribute
+  tags:
+    - synced attributes
+  requestBody:
+    $ref: "../requestBodies/POST/SyncedAttributes.yaml"
+  responses:
+    '201':
+      $ref: "../responses/SyncedAttribute.yaml"
+    '400':
+      $ref: "../responses/400.yaml"
+    '500':
+      $ref: "../responses/500.yaml"

nerm/requestBodies/POST/SyncedAttributes.yaml

@@ -0,0 +1,6 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      $ref: "../../schemas/POST/SyncedAttribute.yaml"

nerm/responses/SyncedAttribute.yaml

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

nerm/schemas/GET/SyncedAttribute.yaml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    readOnly: true
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa
+    description: synced attribute's ID
+  profile_type_id:
+    type: string
+    format: uuid
+    readOnly: true
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa
+    description: Profile type ID of synced attribute
+  ne_attribute_id:
+    type: string
+    format: uuid
+    readOnly: true
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa
+    description: Ne attribute ID of synced attribute

nerm/schemas/POST/SyncedAttribute.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  ne_attribute_id:
+    type: string
+    format: uuid
+    example: 1246d8b3-ac29-4015-8154-dea4434a73fa
+    description: synced attribute's ID