OpenAPI Specification
openapi: 3.0.3
info:
title: Apache Hive WebHCat REST Databases API
version: 1.0.0
description: WebHCat REST API for Apache Hive providing DDL operations, HiveQL job submission, and Hive Metastore metadata access over HTTP.
contact:
email: user@hive.apache.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:50111/templeton/v1
description: WebHCat (Templeton) REST API
tags:
- name: Databases
description: Database metadata operations
paths:
/ddl/database:
get:
operationId: listDatabases
summary: Apache Hive List Databases
description: List all databases in the Hive metastore.
tags:
- Databases
responses:
'200':
description: Databases listed
content:
application/json:
schema:
type: object
properties:
databases:
type: array
items:
type: string
/ddl/database/{dbName}:
get:
operationId: getDatabase
summary: Apache Hive Get Database
description: Get metadata for a specific Hive database.
tags:
- Databases
parameters:
- name: dbName
in: path
required: true
schema:
type: string
description: Database name
responses:
'200':
description: Database retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
'404':
description: Database not found
components:
schemas:
Database:
type: object
description: Hive database (schema) in the metastore
properties:
name:
type: string
description: Database name
example: mydb
comment:
type: string
description: Database description
example: My analytics database
location:
type: string
description: HDFS location URI
example: hdfs://namenode/user/hive/warehouse/mydb.db
ownerName:
type: string
description: Owner of the database
example: hive
ownerType:
type: string
description: Owner type (USER or ROLE)
example: USER