diff --git a/static/api-specs/idn/beta/paths/entitlements.yaml b/static/api-specs/idn/beta/paths/entitlements.yaml index 14a19c3db..529310801 100644 --- a/static/api-specs/idn/beta/paths/entitlements.yaml +++ b/static/api-specs/idn/beta/paths/entitlements.yaml @@ -23,7 +23,7 @@ get: description: >- The account ID. If specified, returns only entitlements associated with the given Account. - Can not be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or + Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). example: ef38f94347e94562b5bb8424a56397d8 required: false @@ -36,7 +36,7 @@ get: are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. - Can not be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a + Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. example: me required: false @@ -49,7 +49,7 @@ get: If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. - Can not be specified with the **account-id** or **segmented-for-identity** param(s). + Cannot be specified with the **account-id** or **segmented-for-identity** param(s). example: 041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649 required: false - in: query diff --git a/static/api-specs/idn/beta/paths/role-mining-session-potential-role-summary.yaml b/static/api-specs/idn/beta/paths/role-mining-session-potential-role-summary.yaml index 138109fcd..4ebdfad38 100644 --- a/static/api-specs/idn/beta/paths/role-mining-session-potential-role-summary.yaml +++ b/static/api-specs/idn/beta/paths/role-mining-session-potential-role-summary.yaml @@ -55,7 +55,7 @@ patch: * `saved` - >**NOTE: All other fields can not be modified.** + >**NOTE: All other fields cannot be modified.** parameters: - in: path name: sessionId diff --git a/static/api-specs/idn/v3/paths/account.yaml b/static/api-specs/idn/v3/paths/account.yaml index 95ee4bbf2..1520a2208 100644 --- a/static/api-specs/idn/v3/paths/account.yaml +++ b/static/api-specs/idn/v3/paths/account.yaml @@ -50,7 +50,7 @@ patch: * `manuallyCorrelated` - >**NOTE: All other fields can not be modified.** + >**NOTE: All other fields cannot be modified.** The request must provide a JSONPatch payload. diff --git a/static/api-specs/idn/v3/paths/saved-searches-id.yaml b/static/api-specs/idn/v3/paths/saved-searches-id.yaml index 811772f6f..02f076c78 100644 --- a/static/api-specs/idn/v3/paths/saved-searches-id.yaml +++ b/static/api-specs/idn/v3/paths/saved-searches-id.yaml @@ -2,10 +2,12 @@ put: tags: - Saved Search description: | - Updates an existing saved search. + Updates an existing saved search. + + >**NOTE: You cannot update the `owner` of the saved search.** summary: | Updates an existing saved search - operationId: updateSavedSearch + operationId: putSavedSearch parameters: - $ref: '../parameters/path/search/id.yaml' requestBody: @@ -24,14 +26,20 @@ put: $ref: '../schemas/search/saved/SavedSearch.yaml' '400': $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' '403': $ref: '../responses/403.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' get: tags: - Saved Search description: | Returns the specified saved search. - summary: Return a saved search by ID + summary: Return saved search by ID operationId: getSavedSearch parameters: - $ref: '../parameters/path/search/id.yaml' @@ -42,14 +50,24 @@ get: application/json: schema: $ref: '../schemas/search/saved/SavedSearch.yaml' + '400': + $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' + '403': + $ref: '../responses/403.yaml' '404': $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml' delete: tags: - Saved Search description: | Deletes the specified saved search. - summary: Delete a document by ID + summary: Delete document by ID operationId: deleteSavedSearch parameters: - $ref: '../parameters/path/search/id.yaml' @@ -58,7 +76,13 @@ delete: description: No Content - Indicates the request was successful but there is no content to be returned in the response. '400': $ref: '../responses/400.yaml' + '401': + $ref: '../responses/401.yaml' '403': $ref: '../responses/403.yaml' '404': $ref: '../responses/404.yaml' + '429': + $ref: '../responses/429.yaml' + '500': + $ref: '../responses/500.yaml'