diff --git a/static/api-specs/idn/beta/paths/managed-cluster-log-config.yaml b/static/api-specs/idn/beta/paths/managed-cluster-log-config.yaml index 791599e89..28cf2c872 100644 --- a/static/api-specs/idn/beta/paths/managed-cluster-log-config.yaml +++ b/static/api-specs/idn/beta/paths/managed-cluster-log-config.yaml @@ -1,13 +1,13 @@ get: tags: - Managed Clusters - summary: get ManagedCluster Log Configuration for a specified cluster - description: Get log configuration for a managed cluster. + summary: Get managed cluster's log configuration + description: Get managed cluster's log configuration. operationId: getClientLogConfiguration parameters: - name: id in: path - description: ID of the ManagedCluster to get log configuration for + description: ID of ManagedCluster to get log configuration for required: true style: simple explode: false @@ -16,7 +16,7 @@ get: example: aClusterId responses: "200": - description: ManagedCluster log configuration matching the given cluster ID + description: Log configuration of ManagedCluster matching given cluster ID content: application/json: schema: @@ -25,22 +25,28 @@ get: $ref: '../schemas/ClientLogConfiguration.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: - oauth2: [idn:managed-cluster-log-config:read] put: tags: - Managed Clusters - summary: Update log configuration for a specified cluster. - description: Update log configuration for a managed cluster. + summary: Update managed cluster's log configuration + description: Update managed cluster's log configuration operationId: updateClientLogConfiguration parameters: - name: id in: path - description: ID of the ManagedCluster to update log configuration for + description: ID of ManagedCluster to update log configuration for required: true style: simple explode: false @@ -48,7 +54,7 @@ put: type: string example: aClusterId requestBody: - description: ClientLogConfiguration for the given ManagedCluster + description: ClientLogConfiguration for given ManagedCluster content: application/json: schema: @@ -56,16 +62,22 @@ put: required: true responses: "200": - description: Responds with updated ClientLogConfiguration for the given ManagedCluster. + description: Responds with updated ClientLogConfiguration for given ManagedCluster content: application/json: schema: $ref: '../schemas/ClientLogConfiguration.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: - oauth2: [idn:managed-cluster-log-config:write] diff --git a/static/api-specs/idn/beta/schemas/ClientLogConfiguration.yaml b/static/api-specs/idn/beta/schemas/ClientLogConfiguration.yaml index a6e588574..834216b7e 100644 --- a/static/api-specs/idn/beta/schemas/ClientLogConfiguration.yaml +++ b/static/api-specs/idn/beta/schemas/ClientLogConfiguration.yaml @@ -5,11 +5,11 @@ required: - rootLevel properties: clientId: - description: client ID of the Log configuration + description: Log configuration's client ID type: string example: aClientId durationMinutes: - description: duration in minutes for the log configuration to remain in effect before resetting to defaults + description: Duration in minutes for log configuration to remain in effect before resetting to defaults type: integer format: int32 example: 120 @@ -17,17 +17,17 @@ properties: maximum: 1440 expiration: description: Expiration date-time of the log configuration request - example: 120 + example: "2020-12-15T19:13:36.079Z" type: string format: date-time rootLevel: - description: Root Log level to apply + description: Root log level to apply, the default level for all logs. For more information about logging levels, refer to the "Logging Levels" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). default: INFO example: TRACE $ref: './StandardLevel.yaml' logLevels: - description: Map of LogLevel by key + description: Map of log level by key. The keys are logging classes, and the values are logging levels. To see the available connectors and their logging classes, refer to the "Logging Classes" table in [Enabling Connector Logging in IdentityNow](https://community.sailpoint.com/t5/IdentityNow-Articles/Enabling-Connector-Logging-in-IdentityNow/ta-p/188107). example: '{ - level:WARN + "sailpoint.connector.ADLDAPConnector": "TRACE" }' $ref: './LogLevelSpec.yaml'