openapi: 3.0.2
info:
  version: LTS 2021
  title: Nuxeo Platform ACL Audit API
  termsOfService: https://www.nuxeo.com/about/why-nuxeo/
  contact:
    email: support@nuxeo.com
    url: https://www.nuxeo.com/contact/
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://d1q6f0aelx0por.cloudfront.net/product-logos/library-nuxeo-logo.png
  description: '# Nuxeo Platform https://www.nuxeo.com/

    OpenAPI 3.0 Specification for the Nuxeo Platform.'
servers:
- url: https://{host}:{port}/nuxeo/api/v1
  variables:
    host:
      default: demo.nuxeo.com
      description: Nuxeo Platform Host
    port:
      default: '443'
      description: Nuxeo Platform Port
- url: https://nightly.nuxeo.com/nuxeo/api/v1
  description: Nuxeo Platform Nightly Test Server
tags:
- name: Audit
paths:
  /id/{docId}/@audit:
    get:
      operationId: DocumentIdAuditAdapterGet
      parameters:
      - description: Id of the document
        in: path
        name: docId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogEntries'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: View the audit trail of a document given its id
      tags:
      - Audit
  /path/{docPath}/@audit:
    get:
      operationId: DocumentPathAuditAdapterGet
      parameters:
      - description: 'Path of the document, ex: ''default-domain'''
        in: path
        name: docPath
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogEntries'
        '401':
          description: Not Authorized to get document
        '404':
          description: Document not found
      summary: View the audit trail of a document given its path
      tags:
      - Audit
components:
  schemas:
    LogEntry:
      properties:
        category:
          type: string
          uniqueItems: false
        comment:
          type: string
          uniqueItems: false
        docLifeCycle:
          type: string
          uniqueItems: false
        docPath:
          type: string
          uniqueItems: false
        docType:
          type: string
          uniqueItems: false
        docUUID:
          type: string
          uniqueItems: false
        entity-type:
          type: string
          uniqueItems: false
        eventDate:
          format: date-time
          type: string
          uniqueItems: false
        eventId:
          type: string
          uniqueItems: false
        logDate:
          format: date-time
          type: string
          uniqueItems: false
        principalName:
          type: string
          uniqueItems: false
        repositoryId:
          type: string
          uniqueItems: false
      required:
      - category
      - comment
      - docLifeCycle
      - docPath
      - docType
      - docUUID
      - entity-type
      - eventDate
      - eventId
      - logDate
      - principalName
      - repositoryId
      uniqueItems: false
    LogEntries:
      properties:
        currentPageIndex:
          type: integer
          uniqueItems: false
        currentPageOffset:
          type: integer
          uniqueItems: false
        currentPageSize:
          type: integer
          uniqueItems: false
        entity-type:
          type: string
          uniqueItems: false
        entries:
          items:
            $ref: '#/components/schemas/LogEntry'
          type: array
          uniqueItems: false
        erroMessage:
          type: string
          uniqueItems: false
        hasError:
          type: boolean
          uniqueItems: false
        isLastPageAvailable:
          type: boolean
          uniqueItems: false
        isNext:
          type: boolean
          uniqueItems: false
        isPaginable:
          type: boolean
          uniqueItems: false
        isPreviousPageAvailable:
          type: boolean
          uniqueItems: false
        isSortable:
          type: boolean
          uniqueItems: false
        maxPageSize:
          type: integer
          uniqueItems: false
        numberOfPages:
          type: integer
          uniqueItems: false
        pageCount:
          type: integer
          uniqueItems: false
        pageIndex:
          type: integer
          uniqueItems: false
        pageSize:
          type: integer
          uniqueItems: false
        resultCount:
          type: integer
          uniqueItems: false
        totalSize:
          type: integer
          uniqueItems: false
      required:
      - entity-type
      - entries
      uniqueItems: false
  securitySchemes:
    basic_auth:
      type: http
      scheme: basic
    token:
      type: apiKey
      in: header
      name: X-Authentication-Token
externalDocs:
  description: Nuxeo Documentation
  url: https://doc.nuxeo.com/