-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Automated commit 'Adi 1661 llmsedv 2 publish api specs (#1628)
* inital commit * update * added sed stats * update * update update update update update update update update update update update update update * update * update * update * adding more routes * update * update * update * update * update * update * update * updated tags * update * update * adding tags in order * fixed typo' by github action: 8617023438
- Loading branch information
1 parent
f2dd786
commit 77ed277
Showing
17 changed files
with
544 additions
and
1 deletion.
There are no files selected for viewing
42 changes: 42 additions & 0 deletions
42
idn/beta/paths/suggested-entitlement-description-approvals.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| post: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| summary: Submit Bulk Approval Request | ||
| description: >- | ||
| Submit Bulk Approval Request for SED. | ||
| Request body takes list of SED Ids. | ||
| API responses with list of SED Approval Status | ||
| operationId: submitSedApproval | ||
| requestBody: | ||
| description: Sed Approval | ||
| content: | ||
| application/json-patch+json: | ||
| schema: | ||
| items: | ||
| $ref: '../schemas/SedApproval.yaml' | ||
| type: array | ||
| required: true | ||
| responses: | ||
| '200': | ||
| description: List of SED Approval Status | ||
| content: | ||
| application/json: | ||
| schema: | ||
| items: | ||
| $ref: '../schemas/SedApprovalStatus.yaml' | ||
| type: array | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:write ] |
38 changes: 38 additions & 0 deletions
38
idn/beta/paths/suggested-entitlement-description-assignments.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| post: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| operationId: submitSedAssignment | ||
| summary: Submit Sed Assignment Request | ||
| description: >- | ||
| Submit Assignment Request. | ||
| Request body has an assignee, and list of SED Ids that are assigned to that assignee | ||
| API responses with batchId that groups all approval requests together | ||
| requestBody: | ||
| description: Sed Assignment Request | ||
| content: | ||
| application/json-patch+json: | ||
| schema: | ||
| $ref: '../schemas/SedAssignment.yaml' | ||
| required: true | ||
| responses: | ||
| '202': | ||
| description: Sed Assignment Response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/SedAssignmentResponse.yaml' | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:write ] |
40 changes: 40 additions & 0 deletions
40
idn/beta/paths/suggested-entitlement-description-batches-stats.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| get: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| operationId: getSedBatchStats | ||
| summary: Submit Sed Batch Stats Request | ||
| description: >- | ||
| Submit Sed Batch Stats Request. | ||
| Submits batchId in the path param (e.g. {batchId}/stats). | ||
| API responses with stats of the batchId. | ||
| parameters: | ||
| - name: batchId | ||
| in: path | ||
| description: Batch Id | ||
| schema: | ||
| type: string | ||
| format: uuid | ||
| example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb | ||
| required: true | ||
| responses: | ||
| '200': | ||
| description: Stats of Sed batch. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/SedBatchStats.yaml' | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:read ] |
68 changes: 68 additions & 0 deletions
68
idn/beta/paths/suggested-entitlement-description-batches.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| get: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| operationId: getSedBatches | ||
| summary: List Sed Batch Request | ||
| description: >- | ||
| List Sed Batches. | ||
| API responses with Sed Batch Status | ||
| responses: | ||
| '200': | ||
| description: Status of batch | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/SedBatchStatus.yaml' | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:read ] | ||
|
|
||
| post: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| operationId: submitSedBatchRequest | ||
| summary: Submit Sed Batch Request | ||
| description: >- | ||
| Submit Sed Batch Request. | ||
| Request body has a list of entitlement Ids that user wants to have description generated by LLM. | ||
| API responses with batchId that groups Ids together | ||
| requestBody: | ||
| description: Sed Batch Request | ||
| content: | ||
| application/json-patch+json: | ||
| schema: | ||
| $ref: '../schemas/SedBatchRequest.yaml' | ||
| responses: | ||
| '200': | ||
| description: Sed Batch Response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/SedBatchResponse.yaml' | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:write ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| get: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| operationId: listSeds | ||
| summary: List Suggested Entitlement Description | ||
| description: List of Suggested Entitlement Description | ||
| parameters: | ||
| - description: >- | ||
| Integer specifying the maximum number of records to return in a single API call. | ||
| The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). | ||
| If it is not specified, a default limit is used. | ||
| schema: | ||
| format: int64 | ||
| type: integer | ||
| in: query | ||
| name: limit | ||
| example: limit=0 | ||
| - description: >- | ||
| Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) | ||
| Filtering is supported for the following fields and operators: | ||
| **batchId**: *eq* | ||
| **status**: *eq, ne, in* | ||
| **displayName**: *eq, co* | ||
| in: query | ||
| name: filters | ||
| example: displayName co "Read and Write" | ||
| schema: | ||
| type: string | ||
| - description: >- | ||
| If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. | ||
| The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). | ||
| Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. | ||
| in: query | ||
| name: count | ||
| example: count=true | ||
| schema: | ||
| type: boolean | ||
| - description: >- | ||
| If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. | ||
| This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. | ||
| in: query | ||
| name: count-only | ||
| example: count-only=true | ||
| schema: | ||
| type: boolean | ||
| - description: >- | ||
| By default, the ListSeds API will only return items that you have requested to be generated. | ||
| This option will allow you to see all items that have been requested | ||
| in: query | ||
| name: requested-by-anyone | ||
| example: requested-by-anyone=true | ||
| schema: | ||
| type: boolean | ||
| - description: Will limit records to items that are in "suggested" or "approved" status | ||
| in: query | ||
| name: show-pending-status-only | ||
| example: show-pending-status-only=true | ||
| schema: | ||
| type: boolean | ||
| responses: | ||
| '200': | ||
| description: List of Suggested Entitlement Details | ||
| content: | ||
| application/json: | ||
| schema: | ||
| items: | ||
| $ref: '../schemas/Sed.yaml' | ||
| type: array | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:read ] | ||
|
|
||
| patch: | ||
| tags: | ||
| - Suggested Entitlement Description | ||
| operationId: patchSed | ||
| summary: Patch Suggested Entitlement Description | ||
| description: Patch Suggested Entitlement Description | ||
| parameters: | ||
| - description: id is sed id | ||
| in: path | ||
| name: id | ||
| example: ebab396f-0af1-4050-89b7-dafc63ec70e7 | ||
| required: true | ||
| schema: | ||
| type: string | ||
| format: uuid | ||
| requestBody: | ||
| description: Sed Patch Request | ||
| content: | ||
| application/json-patch+json: | ||
| schema: | ||
| items: | ||
| $ref: '../schemas/SedPatch.yaml' | ||
| type: array | ||
| required: true | ||
| responses: | ||
| '200': | ||
| description: detail of patched sed | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '../schemas/Sed.yaml' | ||
| '400': | ||
| $ref: '../../v3/responses/400.yaml' | ||
| '401': | ||
| $ref: '../../v3/responses/401.yaml' | ||
| '403': | ||
| $ref: '../../v3/responses/403.yaml' | ||
| '404': | ||
| $ref: '../../v3/responses/404.yaml' | ||
| '429': | ||
| $ref: '../../v3/responses/429.yaml' | ||
| '500': | ||
| $ref: '../../v3/responses/500.yaml' | ||
| security: | ||
| - UserContextAuth: [ idn:sed:write ] |
Oops, something went wrong.