Apache Solr Shards API

openapi: 3.1.0
info:
  title: Apache Solr REST Collections Shards API
  version: v2
  summary: HTTP/REST API for Apache Solr v2 covering collections, cores, schema, configuration, update and query handlers.
  description: 'Apache Solr exposes a REST API under /api (v2) on each Solr node. This specification

    covers collection lifecycle, core administration, per-collection schema/config/update

    operations, and the legacy Collections admin handler still supported under

    /solr/admin/collections.


    Authentication is pluggable (Basic, JWT, Certificate). Where security is enabled,

    Basic authentication is the most common configuration.

    '
  contact:
    name: Apache Solr Reference Guide
    url: https://solr.apache.org/guide/
servers:
- url: http://localhost:8983
  description: Default Solr node (replace host/port for your deployment)
security:
- basicAuth: []
tags:
- name: Shards
  description: Shard management for collections
paths:
  /api/c/{collection}/shards:
    parameters:
    - $ref: '#/components/parameters/Collection'
    post:
      tags:
      - Shards
      summary: Split a shard, create a shard, or add a replica
      operationId: createShard
      responses:
        '200':
          description: Shard operation accepted
  /api/c/{collection}/shards/{shardName}:
    parameters:
    - $ref: '#/components/parameters/Collection'
    - name: shardName
      in: path
      required: true
      schema:
        type: string
    delete:
      tags:
      - Shards
      summary: Delete a shard or force leader election
      operationId: deleteShard
      responses:
        '200':
          description: Shard removed
  /api/c/{collection}/shards/{shardName}/{replicaName}:
    parameters:
    - $ref: '#/components/parameters/Collection'
    - name: shardName
      in: path
      required: true
      schema:
        type: string
    - name: replicaName
      in: path
      required: true
      schema:
        type: string
    delete:
      tags:
      - Shards
      summary: Delete a replica
      operationId: deleteReplica
      responses:
        '200':
          description: Replica removed
components:
  parameters:
    Collection:
      name: collection
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication (Solr Basic Auth plugin). JWT and certificate auth plugins are also supported.