$schema: http://support.riverbed.com/apis/service_def/2.2
description: REST API for npm.audit service
id: http://support.riverbed.com/apis/npm.audit/1.0
name: npm.audit
provider: riverbed
resources:
  config:
    additionalProperties: false
    description: Audit subsystem configuration
    links:
      get:
        method: GET
        response: {$ref: '#/resources/config'}
      self: {path: $/config}
      set:
        method: PUT
        request: {$ref: '#/resources/config'}
        response: {$ref: '#/resources/config'}
    properties:
      disabled_types:
        description: Event types that will not be audited. Any subtypes under the
          type namespace will also be disabled.
        items: {description: Event type to disable, type: string}
        type: array
      retention:
        additionalProperties: false
        description: Audit record retention configuration
        properties:
          period: {description: Number of days to store records before pruning. 0
              to disable age-based pruning., minimum: 0, type: integer}
          records: {description: Maximum number of event records to keep. 0 to disable
              maximum record pruning., minimum: 0, type: integer}
        required: [period, records]
        type: object
      system:
        additionalProperties: false
        description: Main audit system configuration
        properties:
          enabled: {description: Globally enable/disable all event auditing, type: boolean}
        required: [enabled]
        type: object
    required: [system, retention, disabled_types]
    type: object
title: NPM Audit Service
version: '1.0'