components:
  schemas:
    Body_oauthTokenResponse:
      properties:
        client_id:
          description: Unique client ID, generated in the Platform API app.
          title: Client ID
          type: string
        client_secret:
          description: Unique client secret, generated in the Platform API app.
          title: Client Secret
          type: string
        grant_type:
          default: client_credentials
          description: Use the default value.
          title: Grant Type
          type: string
      title: Body_oauthTokenResponse
      type: object
    BoxFolderResponse:
      properties:
        next:
          serialization_alias: _next
          title: Next
          type: string
        results:
          items:
            $ref: '#/components/schemas/Subfolder'
          title: Results
          type: array
        total_count_label:
          title: Total Count Label
          type: string
      required:
      - results
      title: BoxFolderResponse
      type: object
    BoxUserEntry:
      properties:
        address:
          title: Address
          type: string
        id:
          title: Id
          type: string
        login:
          format: email
          title: Login
          type: string
        modified_at:
          format: date-time
          title: Modified At
          type: string
        name:
          title: Name
          type: string
        phone:
          title: Phone
          type: string
        role:
          title: Role
          type: string
        status:
          title: Status
          type: string
        type:
          title: Type
          type: string
      required:
      - type
      - id
      - name
      - login
      - role
      - status
      - modified_at
      title: BoxUserEntry
      type: object
    BoxUserResponse:
      properties:
        entries:
          items:
            $ref: '#/components/schemas/BoxUserEntry'
          title: Entries
          type: array
        limit:
          title: Limit
          type: integer
        next_marker:
          title: Next Marker
          type: string
      required:
      - entries
      - limit
      - next_marker
      title: BoxUserResponse
      type: object
    ConfigType:
      description: An enumeration.
      enum:
      - s3
      - box
      - ebox
      - confluence
      - dropbox
      - edropbox
      - gcs
      - gdrive
      - egdrive
      - github
      - gmail
      - gsuite
      - jira
      - eworkplace
      - miro
      - msteams
      - emsteams
      - office365
      - onedrive
      - eonedrive
      - mgraphmail
      - quip
      - equip
      - salesforce
      - sharepoint
      - slack
      - eslack
      - twitter
      - zendesk
      - zoom
      title: ConfigType
      type: string
    CreateCollectionRequestBody:
      additionalProperties: false
      example:
        name: My collection
        onna_parent_id: b7c6f55fa54c4a3e821e825bd6262c0f
        type: ebox
      properties:
        name:
          description: Display name of the Collection.
          title: Name
          type: string
        onna_parent_id:
          description: The ID of the parent Workspace.
          title: Parent ID
          type: string
        type:
          description: The type of the collection.
          enum:
          - ebox
          - eslack
          title: Type
          type: string
      required:
      - name
      - onna_parent_id
      - type
      title: CreateCollectionRequestBody
      type: object
    CreateCollectionResponseBody:
      additionalProperties: false
      example:
        onna_id: 8a8ead66ba6f4862b922a911dd67c439
        type: BoxEDatasource
      properties:
        onna_id:
          description: Unique identifier for the Collection.
          title: Onna ID
          type: string
        type:
          description: The type of the collection.
          enum:
          - ebox
          - eslack
          title: Type
          type: string
      required:
      - onna_id
      - type
      title: CreateCollectionResponseBody
      type: object
    CreateCustomFieldRequestBody:
      additionalProperties: false
      example:
        description: My custom field description
        name: My custom field
        required: false
        type: keyword
      properties:
        description:
          description: Description
          title: Description
          type: string
        name:
          description: Name
          title: Name
          type: string
        required:
          description: Required
          title: Required
          type: boolean
        type:
          description: Type
          title: Type
          type: string
      required:
      - name
      - type
      - description
      - required
      title: CreateCustomFieldRequestBody
      type: object
    CreateCustomFieldResponseBody:
      example:
        onna_id: cf-my-custom-field-b20696ae9
      properties:
        onna_id:
          description: Alphanumeric unique identifier of the custom field.
          title: Onna Id
          type: string
      required:
      - onna_id
      title: CreateCustomFieldResponseBody
      type: object
    CreateFileBody:
      additionalProperties: false
      example:
        comment: Creative Commons PDF
        creation_date: '2022-07-21T09:02:40.083388+00:00'
        creator: Creative Commons ORG
        description: Creative Commons PDF
        name: Creativecommons-what-is-creative-commons_eng.pdf
        onna_parent_id: 0ec85634bf2c4d8db453a65551c36b8d
        origin_tags:
        - creative commons
        path: /images/3/35
        ref: Creativecommons-what-is-creative-commons_eng
        type: pdf
        update_date: '2022-07-21T09:02:40.083388+00:00'
        updater: Bob
        url: https://wiki.creativecommons.org/images/3/35/Creativecommons-what-is-creative-commons_eng.pdf
      properties:
        comment:
          description: Comment type of file.
          title: Comment
          type: string
        creation_date:
          description: Date when file was created.
          format: date-time
          title: Creation Date
          type: string
        creator:
          description: User that created the file.
          title: Creator
          type: string
        deleter:
          description: User that deleted the file.
          title: Deleter
          type: string
        deletion_date:
          description: Date when file was deleted.
          format: date-time
          title: Deletion Date
          type: string
        description:
          description: File description.
          title: Description
          type: string
        name:
          description: File name.
          title: Name
          type: string
        onna_parent_id:
          description: The ID of the parent Workspace or Folder.
          title: Parent ID
          type: string
        origin_tags:
          description: List of tags associated to the file in the origin.
          items:
            type: string
          maxItems: 1000
          title: Origin Tags
          type: array
        path:
          description: Path to file, at the origin.
          title: Path
          type: string
        ref:
          description: The Reference Number or ID for the file at the origin.
          title: Reference
          type: string
        share_url:
          description: Link or invite to share file (at origin).
          title: Share URL
          type: string
        status:
          description: 'File status: Deleted, Archived, etc.'
          title: Status
          type: string
        type:
          description: Type of file.
          title: Type
          type: string
        update_date:
          description: Date when the file was last updated.
          format: date-time
          title: Update Date
          type: string
        updater:
          description: The last user to update the file.
          title: Updater
          type: string
        url:
          description: A Unique Resource Locator for the file at the origin.
          title: URL
          type: string
        version:
          description: Version.
          title: Version
          type: string
      required:
      - onna_parent_id
      - ref
      - url
      title: CreateFileBody
      type: object
    CreateFileResponse:
      additionalProperties: false
      properties:
        onna_id:
          description: The ID for the Onna resource.
          title: Onna ID
          type: string
      required:
      - onna_id
      title: CreateFileResponse
      type: object
    CreateFolderRequestBody:
      additionalProperties: false
      example:
        name: My folder
        onna_parent_id: b7c6f55fa54c4a3e821e825bd6262c0f
      properties:
        name:
          description: Display name of the Folder.
          title: Name
          type: string
        onna_parent_id:
          description: The ID of the parent Workspace or Folder.
          title: Parent ID
          type: string
      required:
      - name
      - onna_parent_id
      title: CreateFolderRequestBody
      type: object
    CreateFolderResponseBody:
      additionalProperties: false
      example:
        onna_id: 8a8ead66ba6f4862b922a911dd67c439
      properties:
        onna_id:
          description: Unique identifier for the Folder.
          title: Onna ID
          type: string
      required:
      - onna_id
      title: CreateFolderResponseBody
      type: object
    CreateTicketBody:
      additionalProperties: false
      example:
        assignee_group: IT Support
        assignees:
        - Bob
        - Alice
        author: Bob
        category: incident
        comments:
        - author: Bob
          creation_date: '2022-07-21T09:02:40.083388+00:00'
          text: Ticket comment
        creation_date: '2022-07-21T09:02:40.083388+00:00'
        description: Ticket description
        followers:
        - Alice
        - Charlie
        name: CS0001401
        onna_parent_id: da72de92fef04c6a9cc5cfe018fa9cd6
        origin_tags:
        - critical
        - backend
        priority: medium
        reactions:
        - like
        - love
        ref: f352dc9387632300d6b0a7da0acb0b60
        requester: Alice
        severity: low
        status: open
        subcategory: hardware
        type: incident
        update_date: '2022-07-21T09:02:40.083388+00:00'
        updater: Bob
        url: https://instance.servicenow.com/api/sn_customerservice/case/f352dc9387632300d6b0a7da0acb0b60
      properties:
        assignee_group:
          description: Assignee group.
          title: Assignee Group
          type: string
        assignees:
          description: List of users assigned to the ticket.
          items:
            type: string
          maxItems: 1000
          title: Assignees
          type: array
        author:
          description: The user that created the ticket.
          title: Author
          type: string
        category:
          description: Category.
          title: Category
          type: string
        comments:
          description: List of messages associated to the ticket.
          items:
            $ref: '#/components/schemas/TicketMessage'
          maxItems: 5000
          title: Comments
          type: array
        creation_date:
          description: Date when the ticket was created.
          format: date-time
          title: Creation Date
          type: string
        description:
          description: Description.
          title: Description
          type: string
        followers:
          description: List of users following the ticket.
          items:
            type: string
          maxItems: 1000
          title: Followers
          type: array
        name:
          description: Title.
          title: Name
          type: string
        onna_parent_id:
          description: The ID of the parent Folder.
          title: Parent ID
          type: string
        origin_tags:
          description: List of tags associated to the ticket in the origin.
          items:
            type: string
          maxItems: 1000
          title: Origin Tags
          type: array
        priority:
          description: 'Priority: `high`, `medium`, `low`, etc.'
          title: Priority
          type: string
        reactions:
          description: List of reactions.
          items:
            type: string
          maxItems: 1000
          title: Reactions
          type: array
        ref:
          description: The Reference Number or ID for the ticket at the origin.
          title: Reference
          type: string
        requester:
          description: The user that requested the ticket.
          title: Requester
          type: string
        severity:
          description: 'Severity: `high`, `medium`, `low`, etc.'
          title: Severity
          type: string
        status:
          description: 'Ticket status: `open`, `closed`, `archived`, etc.'
          title: Status
          type: string
        subcategory:
          description: Subcategory.
          title: Subcategory
          type: string
        type:
          description: Type of ticket.
          title: Type
          type: string
        update_date:
          description: Date when the ticket was last updated.
          format: date-time
          title: Update Date
          type: string
        updater:
          description: The last user to update the ticket.
          title: Updater
          type: string
        url:
          description: A Unique Resource Locator for the ticket at the origin.
          title: URL
          type: string
      required:
      - onna_parent_id
      - ref
      - url
      - name
      title: CreateTicketBody
      type: object
    CreateTicketResponse:
      additionalProperties: false
      properties:
        onna_id:
          description: The ID for the Onna resource.
          title: Onna ID
          type: string
      required:
      - onna_id
      title: CreateTicketResponse
      type: object
    CreateWalletEntryRequestBody:
      additionalProperties: false
      example:
        credentials: ASECR3TT0K3N
        metadata:
          key: value
        name: wallet1
      properties:
        credentials:
          anyOf:
          - type: string
          - type: object
          description: Credentials to store in the wallet entry.
          title: Credentials
        metadata:
          description: Metadata associated with the credentials to store.
          title: Metadata
          type: object
        name:
          default: Public API Wallet Entry
          description: Display name of the wallet entry.
          title: Name
          type: string
      required:
      - credentials
      title: CreateWalletEntryRequestBody
      type: object
    CreateWalletEntryResponseBody:
      additionalProperties: false
      example:
        onna_id: 006334fe06174ccaa2d1710a37e6d7f6
      properties:
        onna_id:
          description: Alphanumeric unique identifier of the wallet entry.
          title: Onna ID
          type: string
      required:
      - onna_id
      title: CreateWalletEntryResponseBody
      type: object
    CreateWorkspaceRequestBody:
      additionalProperties: false
      example:
        description: My personal workspace
        embeddings_enabled: true
        name: My workspace
        tags:
        - project-x
        - feature
      properties:
        description:
          description: Short description of the workspace.
          title: Description
          type: string
        embeddings_enabled:
          description: Flag to enable or disable embeddings calculation for the workspace.
          title: Embeddings Enabled
          type: boolean
        name:
          description: Display name of the workspace.
          title: Name
          type: string
        tags:
          description: Labels attached to the workspace for the purpose of identification
            or to give meta information.
          items:
            type: string
          maxItems: 10000
          title: Tags
          type: array
      required:
      - name
      title: CreateWorkspaceRequestBody
      type: object
    CreateWorkspaceResponseBody:
      example:
        onna_id: ws6f0c5339de42f9964e6afe9bf20469
        type: BoxEDatasource
      properties:
        onna_id:
          description: Alphanumeric unique identifier of the workspace.
          title: Onna ID
          type: string
      required:
      - onna_id
      title: CreateWorkspaceResponseBody
      type: object
    CurrentUser:
      additionalProperties: false
      example:
        account_id: foo
        id: test.user@onna.com
        name: Test
        surname: User
      properties:
        account_id:
          description: The ID of the account to which the user is associated.
          title: Account ID
          type: string
        id:
          description: Unique identifier of the current user. For most users this
            will be the same as the email.
          title: ID
          type: string
        name:
          description: Name of the authenticated user.
          title: Name
          type: string
        surname:
          description: Surname of the authenticated user.
          title: Surname
          type: string
      required:
      - id
      - account_id
      - name
      title: CurrentUser
      type: object
    CustomFieldPageResponseBody:
      example:
        items:
        - name: My custom field
          onna_id: cf-my-custom-field-b20696ae9
          required: false
          type: keyword
          usage_count: 0
      properties:
        cursor:
          description: The parameter to get the next page.
          title: Cursor
          type: string
        items:
          description: List of results.
          items:
            $ref: '#/components/schemas/CustomFieldResponseBody'
          title: Items
          type: array
      required:
      - items
      title: CustomFieldPageResponseBody
      type: object
    CustomFieldResponseBody:
      additionalProperties: false
      example:
        name: My custom field
        onna_id: cf-my-custom-field-b20696ae9
        required: false
        type: keyword
        usage_count: 0
      properties:
        description:
          description: Description
          title: Description
          type: string
        name:
          description: Name
          title: Name
          type: string
        onna_id:
          description: Alphanumeric unique identifier of the custom field.
          title: Onna Id
          type: string
        required:
          description: Required
          title: Required
          type: boolean
        type:
          description: Type
          title: Type
          type: string
        usage_count:
          description: Usage count
          title: Usage Count
          type: integer
      required:
      - name
      - type
      - description
      - required
      - onna_id
      - usage_count
      title: CustomFieldResponseBody
      type: object
    EnableWorkspaceCustomFieldRequestBody:
      example:
        onna_id: cf-b20696ae9
      properties:
        onna_id:
          description: Alphanumeric unique identifier of the workspace.
          title: Onna ID
          type: string
      required:
      - onna_id
      title: EnableWorkspaceCustomFieldRequestBody
      type: object
    ExportsPageResponseBody:
      additionalProperties: false
      properties:
        cursor:
          description: The parameter to get the next page.
          title: Cursor
          type: string
        items:
          description: List of results.
          items:
            $ref: '#/components/schemas/ReadExportResponseBody'
          title: Items
          type: array
      required:
      - items
      title: ExportsPageResponseBody
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    HealthResponseBody:
      additionalProperties: false
      example:
        release_id: 1.0.0
        status: pass
        version: v1
      properties:
        release_id:
          description: Service version.
          title: Release Id
          type: string
        status:
          description: Result of the status check as 'pass' or 'fail'.
          title: Status
          type: string
        version:
          description: API version.
          title: Version
          type: string
      required:
      - status
      - version
      - release_id
      title: HealthResponseBody
      type: object
    JsonApiErrors401:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX401_unauthorized
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '401'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors401
      type: object
    JsonApiErrors403:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX403_forbidden
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '403'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors403
      type: object
    JsonApiErrors404:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX404_not_found
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '404'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors404
      type: object
    JsonApiErrors405:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX405_method_not_allowed
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '405'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors405
      type: object
    JsonApiErrors412:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX412_precondition_failed
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '412'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors412
      type: object
    JsonApiErrors422:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX422_unprocessable_entity
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '422'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors422
      type: object
    JsonApiErrors500:
      additionalProperties: false
      description: 'JSON:API "error object": https://jsonapi.org/format/#errors'
      example:
        errors:
        - code: XX500_internal_server_error
          id: 1bd5c180-d2c5-4bfb-9444-a3a19dd9926b
          status: '500'
      properties:
        code:
          description: An application-specific error code, expressed as a string value.
          title: Code
          type: string
        detail:
          description: A human-readable explanation specific to this occurrence of
            the problem.
          title: Detail
          type: string
        id:
          description: A unique identifier for this particular occurrence of the problem.
          title: ID
          type: string
        links:
          description: Leads to further details about this occurrence of the problem.
          title: Links
          type: object
        source:
          description: An object containing references to the source of the error.
          title: Source
          type: object
        status:
          description: The HTTP status code applicable to this problem, expressed
            as a string value.
          title: Status
          type: string
        title:
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem.
          title: Title
          type: string
      required:
      - status
      - code
      title: JsonApiErrors500
      type: object
    OauthTokenResponse:
      example:
        access_token: <BEARER_TOKEN>
        expires_in: 3599
        token_type: bearer
      properties:
        access_token:
          title: Access Token
          type: string
        expires_in:
          default: 0
          title: Expires In
          type: integer
        token_type:
          title: Token Type
          type: string
      required:
      - access_token
      - token_type
      title: OauthTokenResponse
      type: object
    PageItemResponseBody:
      properties:
        name:
          default: ''
          description: Item name.
          title: Name
          type: string
        onna_id:
          description: Item identifier.
          title: Onna Id
          type: string
      required:
      - onna_id
      title: PageItemResponseBody
      type: object
    PageResponseBody:
      properties:
        cursor:
          description: The parameter to get the next page.
          title: Cursor
          type: string
        items:
          description: List of results.
          items:
            $ref: '#/components/schemas/PageItemResponseBody'
          title: Items
          type: array
      required:
      - items
      title: PageResponseBody
      type: object
    PathElement:
      properties:
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
      required:
      - id
      - name
      title: PathElement
      type: object
    ReadCollectionResponseBody:
      additionalProperties: false
      example:
        configured: 'false'
        name: My new collection
        onna_id: f3fb1c53300a4127945274779272d4b0
        sync_filters: 'null'
        sync_status: created
        type: ebox
        type_sync: one
      properties:
        configured:
          description: Whether the collection is configured and ready to sync or not.
          title: Configured
          type: boolean
        name:
          description: Display name of the Collection.
          title: Name
          type: string
        onna_id:
          description: Unique identifier for the Collection.
          title: Onna ID
          type: string
        sync_filters:
          additionalProperties:
            $ref: '#/components/schemas/SyncFilter'
          description: Sync filters for the collection.
          title: Sync Filters
          type: object
        sync_status:
          description: The sync status of the collection.
          title: Sync Status
          type: string
        type:
          description: The type of the collection.
          enum:
          - ebox
          - eslack
          title: Type
          type: string
        type_sync:
          description: The sync type of the collection (One, Auto or Archive).
          title: Type Sync
          type: string
      required:
      - onna_id
      - name
      - sync_status
      - type_sync
      - configured
      - type
      title: ReadCollectionResponseBody
      type: object
    ReadExportResponseBody:
      additionalProperties: false
      example:
        doc_count: 2
        export_size: 55685
        metadata_url: https://api.onna.com/v1/exports/.../metadata?key=<KEY>
        name: Export workspace - test workspace 3 - 2025-04-29
        onna_id: f2ea35a783a94a119bd44b2aca18382f
        status: ready
      properties:
        doc_count:
          description: Number of documents in the export.
          title: Doc Count
          type: integer
        export_size:
          description: Size of the export in bytes.
          title: Export Size
          type: integer
        metadata_url:
          description: URL to download the metadata of the export
          title: Metadata Url
          type: string
        name:
          description: Display name of the Export.
          title: Name
          type: string
        onna_id:
          description: Unique identifier for the Export.
          title: Onna ID
          type: string
        status:
          description: Status of the export.
          title: Status
          type: string
      required:
      - onna_id
      - name
      - export_size
      - status
      - doc_count
      title: ReadExportResponseBody
      type: object
    ReadFileResponse:
      additionalProperties: false
      example:
        comment: Creative Commons PDF
        creation_date: '2022-07-21T09:02:40.083388+00:00'
        creator: Creative Commons ORG
        description: Creative Commons PDF
        name: Creativecommons-what-is-creative-commons_eng.pdf
        onna_parent_id: 0ec85634bf2c4d8db453a65551c36b8d
        origin_tags:
        - creative commons
        path: /images/3/35
        ref: Creativecommons-what-is-creative-commons_eng
        type: pdf
        update_date: '2022-07-21T09:02:40.083388+00:00'
        updater: Bob
        url: https://wiki.creativecommons.org/images/3/35/Creativecommons-what-is-creative-commons_eng.pdf
      properties:
        comment:
          description: Comment type of file.
          title: Comment
          type: string
        creation_date:
          description: Date when file was created.
          format: date-time
          title: Creation Date
          type: string
        creator:
          description: User that created the file.
          title: Creator
          type: string
        deleter:
          description: User that deleted the file.
          title: Deleter
          type: string
        deletion_date:
          description: Date when file was deleted.
          format: date-time
          title: Deletion Date
          type: string
        description:
          description: File description.
          title: Description
          type: string
        extension:
          description: File extension.
          title: Extension
          type: string
        filename:
          description: File name.
          title: Filename
          type: string
        md5:
          description: MD5 hash.
          title: Md5
          type: string
        mime_type:
          description: MIME type of file.
          title: Mime Type
          type: string
        name:
          description: File name.
          title: Name
          type: string
        onna_id:
          description: The ID for the Onna resource.
          title: Onna ID
          type: string
        onna_parent_id:
          description: The ID of the parent Workspace or Folder.
          title: Parent ID
          type: string
        onna_url:
          description: The URL for the Onna resource.
          title: Onna URL
          type: string
        origin_tags:
          description: List of tags associated to the file in the origin.
          items:
            type: string
          maxItems: 1000
          title: Origin Tags
          type: array
        path:
          description: Path to file, at the origin.
          title: Path
          type: string
        processing_date:
          description: Date when file was processed.
          format: date-time
          title: Processing Date
          type: string
        processing_exception:
          description: Processing exception.
          title: Processing Exception
          type: string
        ref:
          description: The Reference Number or ID for the file at the origin.
          title: Reference
          type: string
        share_url:
          description: Link or invite to share file (at origin).
          title: Share URL
          type: string
        size:
          description: Binary size.
          title: Size
          type: integer
        status:
          description: 'File status: Deleted, Archived, etc.'
          title: Status
          type: string
        type:
          description: Type of file.
          title: Type
          type: string
        update_date:
          description: Date when the file was last updated.
          format: date-time
          title: Update Date
          type: string
        updater:
          description: The last user to update the file.
          title: Updater
          type: string
        url:
          description: A Unique Resource Locator for the file at the origin.
          title: URL
          type: string
        version:
          description: Version.
          title: Version
          type: string
      required:
      - onna_parent_id
      - ref
      - url
      - onna_id
      - onna_url
      title: ReadFileResponse
      type: object
    ReadFolderResponseBody:
      additionalProperties: false
      example:
        name: My folder
        onna_id: fd9f0c5339de42f9964e6afe9bf20259
      properties:
        name:
          description: Display name of the Folder.
          title: Name
          type: string
        onna_id:
          description: Unique identifier for the Folder.
          title: Onna ID
          type: string
      required:
      - onna_id
      - name
      title: ReadFolderResponseBody
      type: object
    ReadTicketResponse:
      additionalProperties: false
      example:
        assignee_group: IT Support
        assignees:
        - Bob
        - Alice
        author: Bob
        category: incident
        comments:
        - author: Bob
          creation_date: '2022-07-21T09:02:40.083388+00:00'
          text: Ticket comment
        creation_date: '2022-07-21T09:02:40.083388+00:00'
        description: Ticket description
        followers:
        - Alice
        - Charlie
        name: CS0001401
        onna_parent_id: da72de92fef04c6a9cc5cfe018fa9cd6
        origin_tags:
        - critical
        - backend
        priority: medium
        reactions:
        - like
        - love
        ref: f352dc9387632300d6b0a7da0acb0b60
        requester: Alice
        severity: low
        status: open
        subcategory: hardware
        type: incident
        update_date: '2022-07-21T09:02:40.083388+00:00'
        updater: Bob
        url: https://instance.servicenow.com/api/sn_customerservice/case/f352dc9387632300d6b0a7da0acb0b60
      properties:
        assignee_group:
          description: Assignee group.
          title: Assignee Group
          type: string
        assignees:
          description: List of users assigned to the ticket.
          items:
            type: string
          maxItems: 1000
          title: Assignees
          type: array
        author:
          description: The user that created the ticket.
          title: Author
          type: string
        category:
          description: Category.
          title: Category
          type: string
        comments:
          description: List of messages associated to the ticket.
          items:
            $ref: '#/components/schemas/TicketMessage'
          maxItems: 5000
          title: Comments
          type: array
        creation_date:
          description: Date when the ticket was created.
          format: date-time
          title: Creation Date
          type: string
        description:
          description: Description.
          title: Description
          type: string
        followers:
          description: List of users following the ticket.
          items:
            type: string
          maxItems: 1000
          title: Followers
          type: array
        name:
          description: Title.
          title: Name
          type: string
        onna_id:
          description: The ID for the Onna resource.
          title: Onna ID
          type: string
        onna_parent_id:
          description: The ID of the parent Folder.
          title: Parent ID
          type: string
        onna_url:
          description: The URL for the Onna resource.
          title: Onna URL
          type: string
        origin_tags:
          description: List of tags associated to the ticket in the origin.
          items:
            type: string
          maxItems: 1000
          title: Origin Tags
          type: array
        priority:
          description: 'Priority: `high`, `medium`, `low`, etc.'
          title: Priority
          type: string
        reactions:
          description: List of reactions.
          items:
            type: string
          maxItems: 1000
          title: Reactions
          type: array
        ref:
          description: The Reference Number or ID for the ticket at the origin.
          title: Reference
          type: string
        requester:
          description: The user that requested the ticket.
          title: Requester
          type: string
        severity:
          description: 'Severity: `high`, `medium`, `low`, etc.'
          title: Severity
          type: string
        status:
          description: 'Ticket status: `open`, `closed`, `archived`, etc.'
          title: Status
          type: string
        subcategory:
          description: Subcategory.
          title: Subcategory
          type: string
        type:
          description: Type of ticket.
          title: Type
          type: string
        update_date:
          description: Date when the ticket was last updated.
          format: date-time
          title: Update Date
          type: string
        updater:
          description: The last user to update the ticket.
          title: Updater
          type: string
        url:
          description: A Unique Resource Locator for the ticket at the origin.
          title: URL
          type: string
      required:
      - onna_parent_id
      - ref
      - url
      - name
      - onna_id
      - onna_url
      title: ReadTicketResponse
      type: object
    ReadWalletEntryResponseBody:
      additionalProperties: false
      example:
        creation_datetime: '2021-08-25T12:00:00Z'
        metadata:
          key: value
        modification_datetime: '2021-08-25T12:00:00Z'
        name: Public API Wallet Entry
        onna_id: ws6f0c5339de42f9964e6afe9bf20469
      properties:
        creation_datetime:
          description: The date and time when the wallet entry was created. The format
            follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard,
            with up to microsecond precision.
          format: date-time
          title: Creation Datetime
          type: string
        metadata:
          description: Metadata associated with the credentials to store.
          title: Metadata
          type: object
        modification_datetime:
          description: The date and time when the wallet entry was last updated. The
            format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
            standard, with up to  microsecond precision. Updates include editing metadata,
            sharing, and tagging the wallet entry.
          format: date-time
          title: Modification Datetime
          type: string
        name:
          description: Display name of the wallet entry.
          title: Name
          type: string
        onna_id:
          description: Alphanumeric unique identifier of the wallet entry.
          title: Onna ID
          type: string
      required:
      - onna_id
      - name
      title: ReadWalletEntryResponseBody
      type: object
    SelectedItem:
      properties:
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
      required:
      - id
      title: SelectedItem
      type: object
    Subfolder:
      properties:
        id:
          title: Id
          type: string
        link:
          title: Link
          type: string
        name:
          title: Name
          type: string
        sorted_path_elements:
          default: []
          items:
            $ref: '#/components/schemas/PathElement'
          title: Sorted Path Elements
          type: array
      required:
      - name
      - link
      - id
      title: Subfolder
      type: object
    SyncFilter:
      properties:
        all_selected:
          title: All Selected
          type: boolean
        excluded:
          items:
            $ref: '#/components/schemas/SelectedItem'
          title: Excluded
          type: array
        filter_name:
          title: Filter Name
          type: string
        filter_type:
          title: Filter Type
          type: string
        selected:
          items:
            $ref: '#/components/schemas/SelectedItem'
          title: Selected
          type: array
      required:
      - all_selected
      - selected
      - excluded
      - filter_type
      - filter_name
      title: SyncFilter
      type: object
    TicketMessage:
      additionalProperties: false
      properties:
        author:
          title: Author
          type: string
        creation_date:
          format: date-time
          title: Creation Date
          type: string
        text:
          title: Text
          type: string
      required:
      - author
      - creation_date
      - text
      title: TicketMessage
      type: object
    UpdateCollectionRequestBody:
      additionalProperties: false
      example:
        name: My updated collection name
        sync_filters:
          '2262844940':
            all_selected: 'true'
            excluded: []
            filter_name: User folders
            filter_type: user_folders
            selected:
            - id: '0'
            - id: '35567496586'
        sync_status: pending
        type_sync: one
      properties:
        name:
          description: Display name of the Collection.
          title: Name
          type: string
        sync_filters:
          additionalProperties:
            $ref: '#/components/schemas/SyncFilter'
          description: Sync filters for the collection.
          title: Sync Filters
          type: object
        sync_status:
          description: The sync status of the collection.
          title: Sync Status
          type: string
        type_sync:
          description: The sync type of the collection (One, Auto or Archive).
          title: Type Sync
          type: string
      title: UpdateCollectionRequestBody
      type: object
    UpdateFileBody:
      additionalProperties: false
      example:
        tags:
        - test
        - bug
        - urgent
      properties:
        tags:
          description: List of onna tags to update for the file.
          items:
            type: string
          title: Tags
          type: array
      title: UpdateFileBody
      type: object
    UpdateFolderRequestBody:
      additionalProperties: false
      example:
        name: My updated folder name
      properties:
        name:
          description: Display name of the Folder.
          title: Name
          type: string
      required:
      - name
      title: UpdateFolderRequestBody
      type: object
    UpdateTicketBody:
      additionalProperties: false
      example:
        tags:
        - critical
        - backend
      properties:
        tags:
          description: List of onna tags to update for the ticket.
          items:
            type: string
          title: Tags
          type: array
      title: UpdateTicketBody
      type: object
    UpdateWalletEntryRequestBody:
      additionalProperties: false
      example:
        credentials: ASECR3TT0K3N
        metadata:
          key: value
        name: wallet1
      properties:
        credentials:
          anyOf:
          - type: string
          - type: object
          description: Credentials to store in the wallet entry.
          title: Credentials
        metadata:
          description: Metadata associated with the credentials to store.
          title: Metadata
          type: object
        name:
          description: Display name of the wallet entry.
          title: Name
          type: string
      title: UpdateWalletEntryRequestBody
      type: object
    UpdateWorkspaceCustomValueRequestBody:
      example:
        value: My custom field value
      properties:
        value:
          description: Custom field value
          title: Value
          type: string
      required:
      - value
      title: UpdateWorkspaceCustomValueRequestBody
      type: object
    UpdateWorkspaceRequestBody:
      additionalProperties: false
      example:
        description: My personal workspace
        embeddings_enabled: true
        name: My workspace
        tags:
        - project-x
        - feature
      properties:
        description:
          description: Short description of the workspace.
          title: Description
          type: string
        embeddings_enabled:
          description: Flag to enable or disable embeddings calculation for the workspace.
          title: Embeddings Enabled
          type: boolean
        name:
          description: Display name of the workspace.
          title: Name
          type: string
        tags:
          description: Labels attached to the workspace for the purpose of identification
            or to give meta information.
          items:
            type: string
          maxItems: 10000
          title: Tags
          type: array
      title: UpdateWorkspaceRequestBody
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    WorkspaceCustomValueResponseBody:
      example:
        onna_id: cf-b20696ae9
        value: My custom field value
      properties:
        onna_id:
          description: Alphanumeric unique identifier of the workspace.
          title: Onna ID
          type: string
        value:
          description: Custom field value
          title: Value
      required:
      - onna_id
      title: WorkspaceCustomValueResponseBody
      type: object
    WorkspaceResponseBody:
      example:
        creation_datetime: '2025-04-29T08:51:06.803407+00:00'
        description: My personal workspace
        modification_datetime: '2025-04-29T08:51:06.803407+00:00'
        name: My workspace
        onna_id: ws6f0c5339de42f9964e6afe9bf20469
        tags:
        - project-x
        - feature
      properties:
        creation_datetime:
          description: The date and time when the workspace was created. The format
            follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard,
            with up to microsecond precision.
          format: date-time
          title: Creation Datetime
          type: string
        description:
          default: ''
          description: Short description of the workspace.
          title: Description
          type: string
        modification_datetime:
          description: The date and time when the workspace was last updated. The
            format follows the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
            standard, with up to  microsecond precision. Updates include editing metadata,
            sharing, and tagging the workspace.
          format: date-time
          title: Modification Datetime
          type: string
        name:
          description: Display name of the workspace.
          title: Name
          type: string
        onna_id:
          description: Alphanumeric unique identifier of the workspace.
          title: Onna ID
          type: string
        tags:
          default: []
          description: Labels attached to the workspace for the purpose of identification
            or to give meta information.
          items:
            type: string
          maxItems: 10000
          title: Tags
          type: array
      required:
      - onna_id
      - name
      title: WorkspaceResponseBody
      type: object
  securitySchemes:
    OAuth2:
      description: The API uses API keys to [authenticate requests](https://dev.onna.com/get-started/authentication).
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://api.onna.com/v1/oauth/token
      type: oauth2
info:
  contact:
    name: Onna Help
    url: https://dev.onna.com/help
  description: "# Introduction\n\nThe Onna Platform API enables you to programmatically\
    \ upload your data into our Knowledge Integration Platform.\nThis unlocks the\
    \ possibility to have all your data in one place\nand turn it into knowledge\u2014\
    even data we don't support directly with one of [our connectors](https://onna.com/connectors/\
    \ \"List of available connectors\").\n\n## Key concepts\n\nBefore starting to\
    \ use the API, we recommend to become familiar with some key concepts.\nFor more\
    \ information on the key concepts, see [API basics](https://dev.onna.com/fundamentals/api-basics\
    \ \"Documentation about API basics\").\n\n## Requirements\n\nTo use this API,\
    \ you must have an active account on an [Enterprise Plan](https://onna.com/pricing/\
    \ \"Onna pricing page\")\nand have the [Developer role assigned](https://dev.onna.com/get-started/authentication#assign-developer-role\
    \ \"Sections on how to assign a developer role\").\n\nFor more information, see\
    \ [Requirements](https://dev.onna.com/fundamentals/api-basics#requirements \"\
    Section about requirements\").\n\n## Security\n\nThis API requires that all requests\
    \ are made using [HTTPS](https://en.wikipedia.org/wiki/HTTPS \"Wikipedia entry\
    \ for HTTPS\")\nand must be [authenticated with a valid token](https://dev.onna.com/get-started/authentication\
    \ \"Article about authentication\").\n\n## Response codes\n\nA full list of the\
    \ response codes returned by this API is available at [Response codes](https://dev.onna.com/fundamentals/response-codes\
    \ \"List of supported response codes\").\n\n## Versioning\n\nThis API uses semantic\
    \ versioning to ensure that your client doesn't break.\nThe version is declared\
    \ in the URL so that you can lock to a specific one by prefix the URL.\n\nWhen\
    \ the version declared in the URL is not supported, you will receive a 400 response.\n\
    \nFor more information, see [Versioning](https://dev.onna.com/fundamentals/api-basics#versioning\
    \ \"Section about versioning\").\n\n## Date and time format\n\nThis API supports\
    \ dates and times in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601 \"Wikipedia\
    \ entry for the IS0 8601 standard\") format.\n\n## Pagination\n\nThis API uses\
    \ cursoring to divide large sets of results in multiple pages.\nFor more information,\
    \ see [Pagination](https://dev.onna.com/fundamentals/api-basics/#pagination \"\
    Section about supported pagination\").\n\n## Parameters\n\nThere are many ways\
    \ to pass parameters when making requests to this API.\nFor more information,\
    \ see [Parameters](https://dev.onna.com/fundamentals/api-basics#parameters \"\
    Section about supported parameters\").\n\n## Resource types\n\nYou can ingest\
    \ various type of resources. For more information, see [Resource types](https://dev.onna.com/fundamentals/resource-types\
    \ \"Article about supported resource types\")."
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://dev.onna.com/legal
  title: Onna Platform API
  version: v1.1.0
openapi: 3.1.0
paths:
  /collections:
    post:
      description: Create a collection in a workspace.
      operationId: createCollection
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCollectionRequestBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Collection
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST \\\n--url 'https://api.onna.com/v1/collections'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"name\": \"My collection\",\n  \"onna_parent_id\": \"b7c6f55fa54c4a3e821e825bd6262c0f\"\
          ,\n  \"type\": \"ebox\"\n}'"
  /collections/authorization_url/{source_type}:
    get:
      description: Authenticate to a given source type.
      operationId: authSource
      parameters:
      - description: Source to authenticate to.
        in: path
        name: source_type
        required: true
        schema:
          allOf:
          - $ref: '#/components/schemas/ConfigType'
          description: Source to authenticate to.
          title: Source Type
      - description: Final URL to redirect to.
        in: query
        name: redirect_to
        required: true
        schema:
          description: Final URL to redirect to.
          title: Redirect To
          type: string
      - description: Type of scopes to request.
        in: query
        name: scopes_type
        required: false
        schema:
          description: Type of scopes to request.
          title: Scopes Type
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              default: {}
              description: Extra data to send with authentication.
              title: Extra
              type: object
      responses:
        '302':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Authenticate Source
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location ''https://api.onna.com/v1/collections/authorization_url/<SOURCE_TYPE>?redirect_to=<YOUR_CALLBACK>''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'''
  /collections/{onna_id}:
    delete:
      description: "Delete the collection. \U0001F4CC This also deletes all resources\
        \ contained in it!"
      operationId: deleteCollection
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Delete Collection
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request DELETE \

          --url ''https://api.onna.com/v1/collections/fd9f0c5339de42f9964e6afe9bf20259''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json''

          '
    get:
      description: Retrieve information related to a collection.
      operationId: getCollectionInfo
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadCollectionResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Retrieve Collection Info
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET \

          --url ''https://api.onna.com/v1/collections/fd9f0c5339de42f9964e6afe9bf20259''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'' \


          '
    patch:
      description: Update the collection. For example, rename it from `My collection`
        to `My updated collection name`.
      operationId: updateCollection
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCollectionRequestBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update Collection
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request PATCH 'https://api.onna.com/v1/collections/fd9f0c5339de42f9964e6afe9bf20259'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"name\": \"My updated collection name\"\n  \"sync_status\": \"pending\"\
          ,\n  \"sync_filters\": {\n    \"2262844940\": {\n        \"all_selected\"\
          : true,\n        \"selected\": [\n            {\n                \"id\"\
          : \"0\"\n            },\n            {\n                \"id\": \"35567496586\"\
          \n            }\n        ],\n        \"excluded\": [],\n        \"filter_type\"\
          : \"user_folders\",\n        \"filter_name\": \"User folders\"\n    }\n\
          \  },\n  \"type_sync\": \"one\"\n}'"
  /collections/{onna_id}/folders:
    get:
      description: Get list of Folders from the 3rd party service.
      operationId: getFoldersFilter
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxFolderResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: List of folders
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET \

          --url ''https://api.onna.com/v1/collections/a859397e23bd44d6a5e7a9f68b9f9ae9/folders''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'''
  /collections/{onna_id}/pair_credentials:
    post:
      description: Pair a credential to a source.
      operationId: pairCredential
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: Authorization code from source.
        in: query
        name: auth_code
        required: true
        schema:
          description: Authorization code from source.
          title: Auth Code
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Pair credential with Source.
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location --request POST ''https://api.onna.com/v1/collections/<COLLECTION_ID>/pair_credentials?auth_code=<AUTH_CODE>''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'''
  /collections/{onna_id}/start:
    post:
      description: Start the sync process for the collection.
      operationId: startSync
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Start Sync
      tags:
      - Collections
  /collections/{onna_id}/users:
    get:
      description: Get list of Users from the 3rd party service.
      operationId: getUsersFilter
      parameters:
      - description: Unique ID of the collection.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the collection.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoxUserResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: List of users
      tags:
      - Collections
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET \

          --url ''https://api.onna.com/v1/collections/a859397e23bd44d6a5e7a9f68b9f9ae9/users''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'''
  /customFields:
    get:
      description: List custom fields.
      operationId: listCustomFields
      parameters:
      - description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
        example: '2022-02-22T11:11:11.12345'
        in: query
        name: cursor
        required: false
        schema:
          description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
          title: Cursor
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomFieldPageResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: List Custom Fields
      tags:
      - CustomFields
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/customFields'' \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    post:
      description: Create a custom field.
      operationId: createCustomField
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCustomFieldRequestBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCustomFieldResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Custom Field
      tags:
      - CustomFields
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request GET 'https://api.onna.com/v1/customFields' \\\n--header\
          \ 'Accept: application/json' \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>'\
          \ \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\"\
          : \"My custom field\",\n    \"type\": \"keyword\",\n    \"description\"\
          : \"My custom field description\",\n    \"required\": false\n}'"
  /download/{onna_id}:
    get:
      description: Download the content of a resource, either binary file or html
        rendered content.
      operationId: downloadResourceContent
      parameters:
      - in: path
        name: onna_id
        required: true
        schema:
          title: The ID of the resource to download
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors405'
          description: Method Not Allowed
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors412'
          description: Precondition Failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Download Resource Content
      tags:
      - Download
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/download/fd9f0c5339de42f9964e6afe9bf20259''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'''
  /exports:
    get:
      description: List exports.
      operationId: listExports
      parameters:
      - description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
        example: '2022-02-22T11:11:11.12345'
        in: query
        name: cursor
        required: false
        schema:
          description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
          title: Cursor
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportsPageResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: List Exports
      tags:
      - Exports
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/exports'' \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
  /exports/{onna_id}:
    get:
      description: Retrieve information related to an Export.
      operationId: getExportInfo
      parameters:
      - description: Unique ID of the Export.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the Export.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadExportResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Retrieve export info
      tags:
      - Exports
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/exports/fs3f0c5339de42f9964e6afe9bf20169''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
  /exports/{onna_id}/metadata:
    get:
      description: Download the metadata of an Export.
      operationId: downloadExportMetadata
      parameters:
      - description: Unique ID of the Export.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the Export.
          title: ID
          type: string
      - description: Temporary key to download the metadata.
        in: query
        name: key
        required: true
        schema:
          description: Temporary key to download the metadata.
          title: Key
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Download export metadata
      tags:
      - Exports
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/exports/fs3f0c5339de42f9964e6afe9bf20169/metadata?key=R9OXYeXjSiLT3oLSxfs5H6HhhmBnd''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
  /folders:
    post:
      description: Create a folder in a workspace.
      operationId: createFolder
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFolderRequestBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFolderResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Folder
      tags:
      - Folders
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST \\\n--url 'https://api.onna.com/v1/folders' \\\
          \n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"name\": \"My folder\",\n  \"onna_parent_id\": \"b7c6f55fa54c4a3e821e825bd6262c0f\"\
          \n}'"
  /folders/{onna_id}:
    delete:
      description: "Delete the folder. \U0001F4CC This also deletes all resources\
        \ contained in it!"
      operationId: deleteFolder
      parameters:
      - description: Unique ID of the folder.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the folder.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Delete Folder
      tags:
      - Folders
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request DELETE \

          --url ''https://api.onna.com/v1/folders/fd9f0c5339de42f9964e6afe9bf20259''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json''

          '
    get:
      description: Retrieve information related to a folder.
      operationId: getFolderInfo
      parameters:
      - description: Unique ID of the folder.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the folder.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadFolderResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Retrieve Folder Info
      tags:
      - Folders
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET \

          --url ''https://api.onna.com/v1/folders/fd9f0c5339de42f9964e6afe9bf20259''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'' \


          '
    patch:
      description: Update the folder. For example, rename it from `My folder` to `My
        updated folder name`.
      operationId: updateFolder
      parameters:
      - description: Unique ID of the folder.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the folder.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFolderRequestBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update Folder
      tags:
      - Folders
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request PATCH 'https://api.onna.com/v1/folders/fd9f0c5339de42f9964e6afe9bf20259'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"name\": \"My updated folder name\"\n}'"
  /health:
    get:
      description: Check service status, version and build.
      operationId: healthResponse
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthResponseBody'
          description: Successful Response
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Health Check
      tags:
      - Utils
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET \

          --url ''https://api.onna.com/v1/health'' \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'' \

          '
  /oauth/token:
    post:
      description: Exchange credentials for an access token.
      operationId: oauthTokenResponse
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Body_oauthTokenResponse'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OauthTokenResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Login
      tags:
      - Authentication
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST \\\n  --url 'https://api.onna.com/v1/oauth/token'\
          \ \\\n  --header 'Content-Type: application/x-www-form-urlencoded' \\\n\
          \  --data-urlencode 'client_id=YOUR_CLIENT_ID' \\\n  --data-urlencode 'client_secret=YOUR_CLIENT_SECRET'\
          \ \\\n  --data-urlencode 'grant_type=client_credentials'"
  /oauth/user:
    get:
      description: Return information about the currently authenticated user.
      operationId: currentUser
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUser'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Current User
      tags:
      - Authentication
  /resources/files:
    post:
      description: Create a file resource.
      operationId: createFile
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFileBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFileResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create File
      tags:
      - 'Resources: Files'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST 'https://api.onna.com/v1/resources/files' \\\n\
          --header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--data '{\n  \"onna_parent_id\": \"0ec85634bf2c4d8db453a65551c36b8d\"\
          ,\n  \"ref\": \"Creativecommons-what-is-creative-commons_eng\",\n  \"url\"\
          : \"https://wiki.creativecommons.org/images/3/35/Creativecommons-what-is-creative-commons_eng.pdf\"\
          ,\n  \"comment\": \"Creative Commons PDF\",\n  \"creation_date\": \"2022-07-21T09:02:40.083388+00:00\"\
          ,\n  \"creator\": \"Creative Commons ORG\",\n  \"description\": \"Creative\
          \ Commons PDF\",\n  \"name\": \"Creativecommons-what-is-creative-commons_eng.pdf\"\
          ,\n  \"path\": \"/images/3/35\",\n  \"origin_tags\": [\n    \"creative commons\"\
          \n  ],\n  \"type\": \"pdf\",\n  \"update_date\": \"2022-07-21T09:02:40.083388+00:00\"\
          ,\n  \"updater\": \"Bob\"\n}'"
  /resources/files/{onna_id}:
    delete:
      description: Delete the file.
      operationId: deleteFile
      parameters:
      - description: Unique ID of the file.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the file.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Delete File
      tags:
      - 'Resources: Files'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request DELETE ''https://api.onna.com/v1/resources/files/fs3f0c5339de42f9964e6afe9bf20169''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    get:
      description: Retrieve a file resource.
      operationId: retrieveFile
      parameters:
      - description: Unique ID of the file.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the file.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadFileResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Read File
      tags:
      - 'Resources: Files'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/resources/files/fs3f0c5339de42f9964e6afe9bf20169''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    patch:
      description: Update a file resource.
      operationId: updateFile
      parameters:
      - description: Unique ID of the file resource.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the file resource.
          title: File ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFileBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update File
      tags:
      - 'Resources: Files'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request PATCH 'https://api.onna.com/v1/resources/files/tk3f0c5339de42f9964e6afe9bf20358'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"tags\": [\"test\", \"bug\", \"urgent\"]\n}'"
  /resources/tickets:
    post:
      description: Create a ticket resource.
      operationId: createTicket
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTicketBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTicketResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Ticket
      tags:
      - 'Resources: Tickets'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST 'https://api.onna.com/v1/resources/tickets' \\\
          \n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"name\": \"CS0001401\",\n  \"onna_parent_id\": \"da72de92fef04c6a9cc5cfe018fa9cd6\"\
          ,\n  \"ref\": \"f352dc9387632300d6b0a7da0acb0b60\",\n  \"url\": \"https://instance.servicenow.com/api/sn_customerservice/case/f352dc9387632300d6b0a7da0acb0b60\"\
          ,\n  \"description\": \"Ticket description\",\n  \"type\": \"incident\"\
          ,\n  \"category\": \"incident\",\n  \"subcategory\": \"hardware\",\n  \"\
          status\": \"open\",\n  \"priority\": \"medium\",\n  \"severity\": \"low\"\
          ,\n  \"author\": \"Bob\",\n  \"requester\": \"Alice\",\n  \"assignees\"\
          : [\"Bob\", \"Alice\"],\n  \"updater\": \"Bob\",\n  \"creation_date\": \"\
          2022-07-21T09:02:40.083388+00:00\",\n  \"update_date\": \"2022-07-21T09:02:40.083388+00:00\"\
          ,\n  \"comments\": [\n      {\n          \"author\": \"Bob\",\n        \
          \  \"creation_date\": \"2022-07-21T09:02:40.083388+00:00\",\n          \"\
          text\": \"Ticket comment\",\n      }\n  ],\n  \"origin_tags\": [\"critical\"\
          , \"backend\"],\n  \"reactions\": [\"like\", \"love\"],\n  \"assignee_group\"\
          : \"IT Support\",\n  \"followers\": [\"Alice\", \"Charlie\"]\n}'"
  /resources/tickets/{onna_id}:
    delete:
      description: Delete the ticket.
      operationId: deleteTicket
      parameters:
      - description: Unique ID of the ticket.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the ticket.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Delete Ticket
      tags:
      - 'Resources: Tickets'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request DELETE ''https://api.onna.com/v1/resources/tickets/tk3f0c5339de42f9964e6afe9bf20358''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    get:
      description: Retrieve a ticket resource.
      operationId: retrieveTicket
      parameters:
      - description: Unique ID of the ticket.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the ticket.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadTicketResponse'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Read Ticket
      tags:
      - 'Resources: Tickets'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/resources/tickets/tk3f0c5339de42f9964e6afe9bf20358''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    patch:
      description: Update a ticket resource.
      operationId: updateTicket
      parameters:
      - description: Unique ID of the ticket.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the ticket.
          title: Ticket ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTicketBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update Ticket
      tags:
      - 'Resources: Tickets'
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request PATCH 'https://api.onna.com/v1/resources/tickets/tk3f0c5339de42f9964e6afe9bf20358'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"tags\": [\"test\", \"bug\", \"urgent\"]\n}'"
  /upload/{id}/tus:
    head:
      description: '[HEAD](https://tus.io/protocols/resumable-upload.html#head) a
        resource''s file, for use with the TUS protocol.'
      operationId: headUploads
      parameters:
      - in: path
        name: id
        required: true
        schema:
          title: Id
          type: string
      - description: 'The `Tus-Resumable` header is included in every request and
          response.


          ```bash

          Tus-Resumable: 1.0.0

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: tus-resumable
        required: false
        schema:
          description: 'The `Tus-Resumable` header is included in every request and
            response.


            ```bash

            Tus-Resumable: 1.0.0

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Tus-Resumable
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors405'
          description: Method Not Allowed
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors412'
          description: Precondition Failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Head Resource File Resumable Upload
      tags:
      - Upload
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl -i 'https://api.onna.com/v1/upload/d3m0d3m0d3m0d3m0d3m0d3m0d3m0d3m0/tus'\
          \ \\\n  -X 'HEAD' \\\n  -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n \
          \ -H 'content-type: application/offset+octet-stream' \\\n  -H 'tus-resumable:\
          \ 1.0.0' \\\n"
    options:
      description: TUS [OPTIONS](https://tus.io/protocols/resumable-upload.html#options)
        may be used to gather information about the Server's current configuration.
      operationId: optionsUploads
      parameters:
      - in: path
        name: id
        required: true
        schema:
          title: Id
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors405'
          description: Method Not Allowed
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors412'
          description: Precondition Failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Options Resource File
      tags:
      - Upload
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl -i 'https://api.onna.com/v1/upload/d3m0d3m0d3m0d3m0d3m0d3m0d3m0d3m0/tus'\
          \ \\\n  -X 'OPTIONS' \\\n  -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n\
          \  -H 'content-type: application/offset+octet-stream' \\\n"
    patch:
      description: TUS [PATCH](https://tus.io/protocols/resumable-upload.html#patch)
        applies partial modifications to a resource.
      operationId: patchUploads
      parameters:
      - in: path
        name: id
        required: true
        schema:
          title: Id
          type: string
      - description: 'The `Content-Length` header indicates the size of the message
          body, in bytes, sent to the recipient.


          ```bash

          Content-Length: 512

          ```


          For more information on headers, see ["the MDN Web Docs"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length).'
        in: header
        name: content-length
        required: false
        schema:
          description: 'The `Content-Length` header indicates the size of the message
            body, in bytes, sent to the recipient.


            ```bash

            Content-Length: 512

            ```


            For more information on headers, see ["the MDN Web Docs"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Length).'
          title: Content-Length
          type: string
      - description: 'The `Content-Type` representation header is used to indicate
          the original media type of the resource (prior to any content encoding applied
          for sending).


          ```bash

          Content-Type: application/json; charset=utf-8

          ```


          For more information on headers, see ["the MDN Web Docs"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).'
        in: header
        name: content-type
        required: false
        schema:
          description: 'The `Content-Type` representation header is used to indicate
            the original media type of the resource (prior to any content encoding
            applied for sending).


            ```bash

            Content-Type: application/json; charset=utf-8

            ```


            For more information on headers, see ["the MDN Web Docs"](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type).'
          title: Content-Type
          type: string
      - description: 'The `Upload-Offset` request and response header indicates a
          byte offset within a resource. The value MUST be a non-negative integer.


          ```bash

          Upload-Offset: 64

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: upload-offset
        required: false
        schema:
          description: 'The `Upload-Offset` request and response header indicates
            a byte offset within a resource. The value MUST be a non-negative integer.


            ```bash

            Upload-Offset: 64

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Upload-Offset
          type: string
      - description: 'The `Tus-Resumable` header is included in every request and
          response.


          ```bash

          Tus-Resumable: 1.0.0

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: tus-resumable
        required: false
        schema:
          description: 'The `Tus-Resumable` header is included in every request and
            response.


            ```bash

            Tus-Resumable: 1.0.0

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Tus-Resumable
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors405'
          description: Method Not Allowed
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors412'
          description: Precondition Failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Resume Resource File Upload
      tags:
      - Upload
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl 'https://api.onna.com/v1/upload/d3m0d3m0d3m0d3m0d3m0d3m0d3m0d3m0/tus'\
          \ \\\n  -X 'PATCH' \\\n  -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n\
          \  -H 'content-type: application/offset+octet-stream' \\\n  -H 'tus-resumable:\
          \ 1.0.0' \\\n  -H 'upload-offset: 0' \\\n  --data $'%PDF-1.4\\v3ryl0ngstr1ng0fR4wD4t4'\
          \ \\\n  --compressed"
    post:
      description: 'TUS [CREATION](https://tus.io/protocols/resumable-upload.html#creation)
        endpoint.


        The created file has the same URL as the current endpoint, since a resource
        can only have a single file.'
      operationId: postUploads
      parameters:
      - in: path
        name: id
        required: true
        schema:
          title: Id
          type: string
      - description: 'The `Upload-Defer-Length` request and response header indicates
          that the size of the upload is not known currently and will be transferred
          later.

          Its value MUST be 1. If the length of an upload is not deferred, this header
          MUST be omitted.


          ```bash

          Upload-Defer-Length: 1

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: upload-defer-length
        required: false
        schema:
          description: 'The `Upload-Defer-Length` request and response header indicates
            that the size of the upload is not known currently and will be transferred
            later.

            Its value MUST be 1. If the length of an upload is not deferred, this
            header MUST be omitted.


            ```bash

            Upload-Defer-Length: 1

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Upload-Defer-Length
          type: string
      - description: 'The `Upload-Length` request and response header indicates the
          size of the entire upload in bytes. The value MUST be a non-negative integer.


          ```bash

          Upload-Length: 512

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: upload-length
        required: false
        schema:
          description: 'The `Upload-Length` request and response header indicates
            the size of the entire upload in bytes. The value MUST be a non-negative
            integer.


            ```bash

            Upload-Length: 512

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Upload-Length
          type: string
      - description: 'The `Upload-Metadata` request and response header MUST consist
          of one or more comma-separated key-value pairs. The key and value MUST be
          separated by a space.

          The key MUST NOT contain spaces and commas and MUST NOT be empty. The key
          SHOULD be ASCII encoded and the value MUST be Base64 encoded. All keys MUST
          be unique.

          The value MAY be empty. In these cases, the space, which would normally
          separate the key and the value, MAY be left out.


          ```bash

          Upload-Metadata: filename d29ybGRfZG9taW5hdGlvbl9wbGFuLnBkZg==,is_confidential

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: upload-metadata
        required: false
        schema:
          description: 'The `Upload-Metadata` request and response header MUST consist
            of one or more comma-separated key-value pairs. The key and value MUST
            be separated by a space.

            The key MUST NOT contain spaces and commas and MUST NOT be empty. The
            key SHOULD be ASCII encoded and the value MUST be Base64 encoded. All
            keys MUST be unique.

            The value MAY be empty. In these cases, the space, which would normally
            separate the key and the value, MAY be left out.


            ```bash

            Upload-Metadata: filename d29ybGRfZG9taW5hdGlvbl9wbGFuLnBkZg==,is_confidential

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Upload-Metadata
          type: string
      - description: 'The `Tus-Resumable` header is included in every request and
          response.


          ```bash

          Tus-Resumable: 1.0.0

          ```


          For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
        in: header
        name: tus-resumable
        required: false
        schema:
          description: 'The `Tus-Resumable` header is included in every request and
            response.


            ```bash

            Tus-Resumable: 1.0.0

            ```


            For more information on the headers used by TUS, see ["the protocol specification"](https://tus.io/protocols/resumable-upload.html).'
          title: Tus-Resumable
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors405'
          description: Method Not Allowed
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors412'
          description: Precondition Failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Resource File Resumable Upload
      tags:
      - Upload
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl 'https://api.onna.com/v1/upload/d3m0d3m0d3m0d3m0d3m0d3m0d3m0d3m0/tus'\
          \ \\\n  -X 'POST' \\\n  -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n \
          \ -H 'content-length: 0' \\\n  -H 'tus-resumable: 1.0.0' \\\n  -H 'upload-length:\
          \ 44251' \\\n  -H 'upload-metadata: name Q3JlYXRpdmVjb21tb25zLXdoYXQtaXMtY3JlYXRpdmUtY29tbW9uc19lbmcucGRm'\
          \ \\\n  --compressed"
    put:
      description: Create single request for resource file upload.
      operationId: putUploads
      parameters:
      - in: path
        name: id
        required: true
        schema:
          title: Id
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '201':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '405':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors405'
          description: Method Not Allowed
        '412':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors412'
          description: Precondition Failed
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Resource File Single Request
      tags:
      - Upload
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl -i 'https://api.onna.com/v1/upload/d3m0d3m0d3m0d3m0d3m0d3m0d3m0d3m0/tus'\
          \ \\\n  -X 'PUT' \\\n  -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n  -H\
          \ 'content-type: application/offset+octet-stream' \\"
  /wallet:
    post:
      description: Create a wallet entry.
      operationId: createWalletEntry
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWalletEntryRequestBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWalletEntryResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Wallet Entry
      tags:
      - Wallet
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST \\\n--url 'https://api.onna.com/v1/wallet' \\\
          \n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--data '{\n    \"name\":\"My wallet\",\n    \"credentials\"\
          :\"token\",\n    \"metadata\":{\"a_field\":\"a_value\"}\n}'\n"
  /wallet/{onna_id}:
    delete:
      description: Delete a wallet entry
      operationId: deleteWalletEntry
      parameters:
      - description: Unique ID of the wallet entry.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the wallet entry.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Delete wallet entry
      tags:
      - Wallet
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location --request DELETE ''https://api.onna.com/v1/wallet/f601fdfadf5c4bea99186f24bc7aa306''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    get:
      description: Retrieve information related to a wallet entry.
      operationId: getWalletEntryInfo
      parameters:
      - description: Unique ID of the wallet entry.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the wallet entry.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadWalletEntryResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Retrieve wallet entry info
      tags:
      - Wallet
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET \

          --url ''https://api.onna.com/v1/wallet/f601fdfadf5c4bea99186f24bc7aa306''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'' \


          '
    patch:
      description: Update the wallet entry. For example, rename it, update the credentials
        or the metadata.
      operationId: updateWalletEntry
      parameters:
      - description: Unique ID of the wallet entry.
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the wallet entry.
          title: ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWalletEntryRequestBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update Wallet Entry
      tags:
      - Wallet
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --location --request PATCH 'https://api.onna.com/v1/wallet/f601fdfadf5c4bea99186f24bc7aa306'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \    \"name\":\"My wallet\",\n    \"credentials\":\"token\",\n    \"metadata\"\
          :{\"a_field\":\"a_value\"}\n}'"
  /workspaces:
    get:
      description: List workspaces.
      operationId: listWorkspaces
      parameters:
      - description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
        example: '2022-02-22T11:11:11.12345'
        in: query
        name: cursor
        required: false
        schema:
          description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
          title: Cursor
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: List Workspaces
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location --request GET ''https://api.onna.com/v1/workspaces?cursor=100''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    post:
      description: Create a workspace.
      operationId: createWorkspace
      parameters:
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceRequestBody'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Create Workspace
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request POST \\\n--url 'https://api.onna.com/v1/workspaces'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"name\": \"My workspace\",\n  \"description\": \"My personal workspace\"\
          ,\n  \"embeddings_enabled\": \"true\",\n  \"tags\": [\n    \"project-x\"\
          ,\n    \"feature\"\n  ]\n}'\n"
  /workspaces/{onna_id}:
    delete:
      description: Delete a Workspace.
      operationId: deleteWorkspace
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Delete Workspace
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location --request DELETE ''https://api.onna.com/v1/workspaces/ws6f0c5339de42f9964e6afe9bf20469''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    get:
      description: Retrieve information related to a workspace.
      operationId: retrieveWorkspaceInfo
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Retrieve Workspace Info
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location --request GET ''https://api.onna.com/v1/workspaces/ws6f0c5339de42f9964e6afe9bf20469''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'
    patch:
      description: Update the workspace. For example, rename it from `my-workspace`
        to `my-new-workspace`.
      operationId: updateWorkspace
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceRequestBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update Workspace
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --location --request PATCH 'https://api.onna.com/v1/workspaces/ws6f0c5339de42f9964e6afe9bf20469'\
          \ \\\n--header 'Authorization: Bearer <ACCESS_TOKEN>' \\\n--header 'Content-Type:\
          \ application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n\
          \  \"description\": \"A random workspace\",\n  \"name\": \"My updated workspace\"\
          ,\n  \"tags\": [\n    \"random\",\n    \"my-company\"\n  ]\n}'"
  /workspaces/{onna_id}/customFields:
    get:
      description: List custom fields for a workspace.
      operationId: listWorkspaceCustomFields
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
        example: '2022-02-22T11:11:11.12345'
        in: query
        name: cursor
        required: false
        schema:
          description: The API uses [cursoring for pagination.](https://dev.onna.com/fundamentals/api-basics/#pagination)
          title: Cursor
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: List Workspace Custom Fields
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --request GET ''https://api.onna.com/v1/workspaces/0c5dfdeb9df34e44a754975a2ad9473d/customFields''
          \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'' \

          --header ''Accept: application/json'''
    patch:
      description: Enable custom field for a workspace.
      operationId: setWorkspaceCustomField
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnableWorkspaceCustomFieldRequestBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Enable Workspace Custom Field
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --request PATCH 'https://stage.intra.onna.internal/api/v1/workspaces/0c5dfdeb9df34e44a754975a2ad9473d/customFields'\
          \ \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer\
          \ <ACCESS_TOKEN>' \\\n--header 'Content-Type: application/json' \\\n--data\
          \ '{\n    \"onna_id\":\"cf-testdates\"\n}'"
  /workspaces/{onna_id}/customFields/{field_id}:
    get:
      description: Get custom field value for a workspace.
      operationId: readWorkspaceCustomValue
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: Unique ID of the field.
        example: cf-b20696ae9
        in: path
        name: field_id
        required: true
        schema:
          description: Unique ID of the field.
          title: Field ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCustomValueResponseBody'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Read Workspace Custom Value
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: 'curl --location ''https://stage.intra.onna.internal/api/v1/workspaces/0c5dfdeb9df34e44a754975a2ad9473d/customFields/cf-testdates''
          \

          --header ''Accept: application/json'' \

          --header ''Authorization: Bearer <ACCESS_TOKEN>'''
    patch:
      description: Set custom field value for a workspace.
      operationId: updateWorkspaceCustomValue
      parameters:
      - description: Unique ID of the workspace.
        example: myworkspace-ZPM9Jf4zQ
        in: path
        name: onna_id
        required: true
        schema:
          description: Unique ID of the workspace.
          title: Workspace ID
          type: string
      - description: Unique ID of the field.
        example: cf-b20696ae9
        in: path
        name: field_id
        required: true
        schema:
          description: Unique ID of the field.
          title: Field ID
          type: string
      - description: '`Authorization: Bearer ACCESS_TOKEN`


          The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
          for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
        in: header
        name: authorization
        required: false
        schema:
          description: '`Authorization: Bearer ACCESS_TOKEN`


            The Authorization header must contain a [Bearer Token](https://oauth.net/2/bearer-tokens/),
            for more information see ["Obtaining an access token"](https://dev.onna.com/get-started/authentication/).'
          title: Authorization
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceCustomValueRequestBody'
        required: true
      responses:
        '204':
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors401'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors403'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors404'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors422'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonApiErrors500'
          description: Internal Server Error
      summary: Update Workspace Custom Value
      tags:
      - Workspaces
      x-codeSamples:
      - label: cURL
        lang: cURL
        source: "curl --location --request PATCH 'https://stage.intra.onna.internal/api/v1/workspaces/0c5dfdeb9df34e44a754975a2ad9473d/customFields/cf-teststring'\
          \ \\\n--header 'Accept: application/json' \\\n--header 'Authorization: Bearer\
          \ <ACCESS_TOKEN>' \\\n--header 'Content-Type: application/json' \\\n--data\
          \ '{\n  \"value\": \"My custom field value\"\n}'"
security:
- OAuth2: []
servers:
- description: Production Server
  url: https://api.onna.com/v1
tags:
- description: 'Our API uses OAuth 2''s Client Credentials Grant to authenticate your
    requests.

    This grant type is especially suited for machine-to-machine (M2M) applications,

    such as the applications you build on top of the Onna platform.


    For more information please check our detailed [authentication docs](https://dev.onna.com/get-started/authentication).'
  name: Authentication
- description: '[Workspaces](https://help.onna.com/hc/en-us/articles/4628449003292-Creating-and-Managing-Workspaces)
    are locations where you can collect data coming from different sources, organize
    it,

    and collaborate with other members of your team.


    You can share workspaces with collaborators with various permission levels and
    roles.

    Permission levels are dependent on the type of expected collaboration.

    You can also search across an entire workspace and export the results of your
    searches or entire data collections.


    This collection includes all the endpoints that enable you to work and collaborate
    inside workspaces.'
  name: Workspaces
- description: '**Collections** are designed to facilitate the management and collaboration
    of data within workspaces. Workspaces serve as centralized locations where data
    from multiple sources can be organized and shared with team members.


    Collaborators can be assigned different roles and permissions based on collaboration
    needs. These endpoints allow searching across the workspace and exporting results
    or entire data collections.


    This collection provides all necessary endpoints to enable seamless collaboration
    and efficient data handling within workspaces.'
  name: Collections
- description: 'Folders are containers for your files or other folders. A place where
    you can group your resources together, like in any desktop operating system.


    This collection includes all the endpoints that enable you to handle folders,
    such as creating, retrieving, or deleting them.'
  name: Folders
- description: 'You can ingest a wide range of raw files.


    Here''s the details of what raw files you can view in the UI:


    - Media (Audio, Video, Images)

    - PDFs

    - Microsoft Documents (DOC, DOCX, PPT, PPTX), rendered as PDFs

    - Microsoft Spreadsheets (Worksheets rendered as tabs)

    - Plain text (CSV, TXT), rendered as PDFs

    - Emails (EML, MSG)

    - Web pages (HTM, HTML)

    - Code


    For more information,please check our docs about [raw-files](https://dev.onna.com/fundamentals/resource-types#raw-files
    "Link to docs site about raw-file ingestion") ingestion.'
  name: 'Resources: Files'
- description: 'The `Ticket` resource type defines resources with which two parties
    communicate to track work to resolve issues

    or deliver incremental value. Customer support requests, service desk tickets,
    or software development projects are

    some examples of what can be mapped to this resource type.


    Read our developer documentation to learn more about the [Ticket resource type](https://dev.onna.com/fundamentals/resource-types#ticket).'
  name: 'Resources: Tickets'
- description: 'A generic endpoint to upload a raw file to an existing resource (ticket,
    file, etc).


    Our upload engine is based on the [TUS protocol](https://tus.io/ "TUS protocol
    website") and treats every upload as a resumable file upload.


    Check our get [started guide](https://dev.onna.com/get-started/hello-world?_highlight=tus#initialize-tus
    "Get started with TUS and the platform API").


    Whatever the programming language you''re using, it''s possible that there''s
    a library that integrates this protocol.


    For more information about TUS, see the [TUS documentation](https://tus.io/protocols/resumable-upload.html
    "TUS protocol documentation").'
  name: Upload
- description: 'The Wallet is a store where external credentials are stored in Onna
    platform. A WalletEntry is an entity that holds a single

    credential. It can be either a plain string or a JSON object and can store additional
    metadata as well.


    This collection includes all the endpoints that enable you to work.'
  name: Wallet
- description: "Exports are a collection of files from either a search or a datasource,\
    \ based on the settings configured.\n\nExports can include additional metadata,\
    \ related files, natives, PDFs, or extracted text in downloadable zip(s) that\
    \ can be used to provide information for an interested party.\n\nThe endpoints\
    \ in this section allow you to list exports, retrieve information about a specific\
    \ export, and download export metadata.\n\nAn export response includes information\
    \ such as its status, name, size, and the number of documents processed. The metadata\
    \ URL provides access to additional information related to the export.\n\n   \
    \ NOTE:\n    When downloading export volumes, the generated metadata.csv/dat file\
    \ will always be in the last volume generated."
  name: Exports
- description: API Utils, such as the `health` endpoint.
  name: Utils
