Skip to content

Commit

Permalink
Automated commit 'Merge pull request #58 from sailpoint/NEROCKET-1990
Browse files Browse the repository at this point in the history
NEROCKET-1990 API docs for new consolidation endpoints' by github action: 12013174917
  • Loading branch information
developer-relations-sp committed Nov 25, 2024
1 parent 5bf2e45 commit af44222
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
5 changes: 5 additions & 0 deletions nerm/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,11 @@ paths:
# Forms
/forms:
$ref: "./paths/forms.yaml"
# Consolidation
/idproxy/data_records/{id}/reassign:
$ref: "./paths/consolidation_data_record.yaml"
/idproxy/identities/{id}:
$ref: "./paths/consolidation_master_record.yaml"
# Form Attributes
/form_attributes:
$ref: "./paths/form_attributes.yaml"
Expand Down
17 changes: 17 additions & 0 deletions nerm/paths/consolidation_data_record.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
patch:
summary: Reassign data record
operationId: patchDataRecord
description: Consolidation is a deprecated feature, this endpoint provides a mechanism to reassign a data record to a new master record to assist customers.
tags:
- consolidation
parameters:
- $ref: "../parameters/path/id.yaml"
requestBody:
$ref: "../requestBodies/PATCH/Consolidation.yaml"
responses:
'200':
description: The data record has been reassigned.
'400':
$ref: "../responses/400.yaml"
'500':
$ref: "../responses/500.yaml"
23 changes: 23 additions & 0 deletions nerm/paths/consolidation_master_record.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
delete:
summary: Delete a master record
operationId: deleteMasterRecord
description: Consolidation is a deprecated feature, this endpoint provides a mechanism to delete a master record to assist customers.
tags:
- consolidation
parameters:
- $ref: "../parameters/path/id.yaml"
responses:
'200':
description: Master record deleted.
'400':
description: Error deleting master record
content:
application/json:
schema:
type: object
properties:
error:
description: A message describing the error that occurred
type: string
'500':
$ref: "../responses/500.yaml"
5 changes: 5 additions & 0 deletions nerm/requestBodies/PATCH/Consolidation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
required: true
content:
application/json:
schema:
$ref: "../../schemas/PATCH/DataRecords.yaml"
7 changes: 7 additions & 0 deletions nerm/schemas/PATCH/DataRecords.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
type: object
properties:
master_record_id:
type: string
description: The id of the master record
example: "456738c9ba999a0076cf8a9b"

0 comments on commit af44222

Please sign in to comment.