Apache CouchDB Server API

openapi: 3.0.3
info:
  title: Apache CouchDB HTTP Authentication Server API
  description: Apache CouchDB exposes a complete RESTful HTTP/JSON API for all database operations including server management, database CRUD, document CRUD, bulk operations, Mango queries, MapReduce views, replication, changes feeds, authentication, and cluster administration. All requests and responses use JSON.
  version: 3.5.1
  contact:
    name: Apache CouchDB Community
    url: https://couchdb.apache.org/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-generated-from: documentation
servers:
- url: http://localhost:5984
  description: Local CouchDB instance (default port)
- url: https://{host}:6984
  description: Remote CouchDB instance (HTTPS)
  variables:
    host:
      default: couchdb.example.com
      description: CouchDB server hostname
security:
- basicAuth: []
- cookieAuth: []
tags:
- name: Server
  description: Server-level information and utilities
paths:
  /:
    get:
      operationId: getServerInfo
      summary: Apache CouchDB Get Server Information
      description: Returns meta information about the CouchDB server instance including version, features, and vendor info.
      tags:
      - Server
      responses:
        '200':
          description: Server information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerInfo'
              examples:
                GetServerInfo200Example:
                  summary: Default getServerInfo 200 response
                  x-microcks-default: true
                  value:
                    couchdb: Welcome
                    version: 3.5.1
                    git_sha: abc1234
                    uuid: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
                    vendor:
                      name: The Apache Software Foundation
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /_all_dbs:
    get:
      operationId: getAllDbs
      summary: Apache CouchDB Get All Databases
      description: Returns a list of all databases in the CouchDB instance.
      tags:
      - Server
      parameters:
      - name: descending
        in: query
        description: Return databases in descending order.
        schema:
          type: boolean
          default: false
        example: false
      - name: limit
        in: query
        description: Maximum number of results to return.
        schema:
          type: integer
        example: 25
      - name: skip
        in: query
        description: Number of results to skip before returning.
        schema:
          type: integer
          default: 0
        example: 0
      responses:
        '200':
          description: List of database names
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
              examples:
                GetAllDbs200Example:
                  summary: Default getAllDbs 200 response
                  x-microcks-default: true
                  value:
                  - _replicator
                  - _users
                  - mydb
                  - products
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ServerInfo:
      title: ServerInfo
      type: object
      description: CouchDB server meta information
      properties:
        couchdb:
          type: string
          description: Always "Welcome"
          example: Welcome
        version:
          type: string
          description: CouchDB version number
          example: 3.5.1
        git_sha:
          type: string
          description: Git commit SHA of the build
          example: abc1234
        uuid:
          type: string
          description: Server-wide unique identifier
          example: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
        vendor:
          type: object
          properties:
            name:
              type: string
              example: The Apache Software Foundation
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using CouchDB admin credentials
    cookieAuth:
      type: apiKey
      in: cookie
      name: AuthSession
      description: Cookie-based session authentication obtained via POST /_session