Apache CouchDB · Schema

OkResponse

Simple success acknowledgement

ApacheDatabaseDocument StoreJSONNoSQLOpen SourceReplicationREST

Properties

Name Type Description
ok boolean
name string Username (for session responses)
roles array
View JSON Schema on GitHub

JSON Schema

apache-couchdb-ok-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-couchdb/refs/heads/main/json-schema/apache-couchdb-ok-response-schema.json",
  "title": "OkResponse",
  "description": "Simple success acknowledgement",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "example": true
    },
    "name": {
      "type": "string",
      "description": "Username (for session responses)",
      "example": "admin"
    },
    "roles": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "_admin"
      ]
    }
  }
}