Skip to content

Commit

Permalink
Automated commit 'Merge pull request #7 from sailpoint/NEROCKET-183-78
Browse files Browse the repository at this point in the history
NEROCKET-183-78 adding profile type role api docs based on ticket' by github action: 6235671297
  • Loading branch information
developer-relations-sp committed Sep 19, 2023
1 parent 7c4f0b4 commit 63662ed
Show file tree
Hide file tree
Showing 6 changed files with 61 additions and 0 deletions.
3 changes: 3 additions & 0 deletions nerm/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,9 @@ paths:
$ref: "./paths/profile_types.yaml"
/profile_types/{id}:
$ref: "./paths/profile_types_id.yaml"
# Profile Type Roles
/profile_type_roles:
$ref: "./paths/profile_type_roles.yaml"
# Profiles
/profile:
$ref: "./paths/profile.yaml"
Expand Down
15 changes: 15 additions & 0 deletions nerm/paths/profile_type_roles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
post:
summary: Create a profile type role
description: This endpoint can create a profile type role. NOTE- The ability to toggle Allow/Block is done through the Profile Type
operationId: createProfileTypeRole
tags:
- profile type roles
requestBody:
$ref: "../requestBodies/POST/ProfileTypeRoles.yaml"
responses:
'200':
$ref: "../responses/ProfileTypeRoles.yaml"
'400':
$ref: "../responses/400.yaml"
'500':
$ref: "../responses/500.yaml"
9 changes: 9 additions & 0 deletions nerm/requestBodies/POST/ProfileTypeRoles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
required: true
content:
application/json:
schema:
type: object
properties:
form:
type: object
$ref: "../../schemas/POST/ProfileTypeRoles.yaml"
9 changes: 9 additions & 0 deletions nerm/responses/ProfileTypeRoles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
description: Expected response to a valid request
content:
application/json:
schema:
type: object
properties:
form:
type: object
$ref: '../schemas/GET/ProfileTypeRoles.yaml'
14 changes: 14 additions & 0 deletions nerm/schemas/GET/ProfileTypeRoles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: object
properties:
profile_type_id:
type: string
description: The id of the profile type
example: 2eb5773f-2486-452f-bdb3-796133b30862
role_id:
type: string
description: The id of the role
example: 2eb5773f-2486-452f-bdb3-796133b30862
id:
type: string
description: The id of the profile type role
example: 2e06b876-f456-473d-bd65-b6435e0b6b2d
11 changes: 11 additions & 0 deletions nerm/schemas/POST/ProfileTypeRoles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
type: object
properties:
profile_type_id:
type: string
description: The id of the profile type
example: 2eb5773f-2486-452f-bdb3-796133b30862
role_id:
type: string
description: The id of the role
example: 2eb5773f-2486-452f-bdb3-796133b30862

0 comments on commit 63662ed

Please sign in to comment.