Lucidworks Solr Configuration API

openapi: 3.2.0
info:
  title: Fusion Admin Solr Configuration API
  description: These APIs provide general administrative functions for your Fusion instance. Use these APIs to manage Fusion objects, App Studio objects, connections to Solr clusters, license files, job schedules, and more. You can also use them to create a history of service events.
  termsOfService: https://lucidworks.com/legal/developer-license-agreement/
  contact:
    name: Lucidworks
    url: www.lucidworks.com
    email: support@lucidworks.com
  license:
    name: License of API
    url: https://lucidworks.com/legal/developer-license-agreement/
  version: '5.9'
servers:
- url: https://{FUSION HOST}/api
  description: Fusion
  variables:
    FUSION HOST:
      default: FUSION_HOST
      description: Your environment host.
- url: https://{FUSION HOST}/api/apps/{APP_NAME}
  description: Fusion app
  variables:
    FUSION HOST:
      default: FUSION_HOST
      description: Your environment host.
    APP_NAME:
      default: APP_NAME
      description: The name of your Fusion application.
tags:
- name: Solr Configuration
  description: The Solr Configuration REST API lets you access and manage Solr configuration files stored in ZooKeeper.
paths:
  /collections/{collection}/solr-config:
    get:
      tags:
      - Solr Configuration
      summary: List all Solr config files
      description: Get a list of all Solr configuration files from ZooKeeper.
      operationId: listConfigNodes
      parameters:
      - name: collection
        in: path
        description: The collection that contains the configuration files.
        required: true
        schema:
          type: string
      - name: recursive
        in: query
        description: '''True'' to return children of nested ZooKeeper nodes. This can be used in conjunction with the path to show only children of a specific node. If `recursive=true` and `expand=true` are both used in the same request, the request may be a little slow depending on how much data is requested.'
        schema:
          type: boolean
          default: false
      - name: expand
        in: query
        description: 'If true, the binary content of a file is returned base64-encoded. Otherwise, only the metadata about each node is returned. To see the content of the file in plain text, you can add ''Accept: text/plain'' to the request header. Alternately, you can get the raw bytes by adding ''Accept: application/octet-stream'' to the header.'
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SolrZkConfigNode'
  /collections/{collection}/solr-config/{path}:
    get:
      tags:
      - Solr Configuration
      summary: Get a Solr config file
      description: Fetch a single Solr configuration file. Use `/solr-config` with `recursive` set to `true` to get the list of existing files and their paths.
      operationId: getConfigNode
      parameters:
      - name: collection
        in: path
        description: The collection that contains the configuration files.
        required: true
        schema:
          type: string
        example: api-test-app
      - name: path
        in: path
        description: The path to a specific file or nested child nodes. If the file is not nested, the filename can be entered without any path information.
        required: true
        schema:
          pattern: .*
          type: string
        example: solrconfig.xml
      responses:
        '200':
          description: successful operation
          content:
            application/octet-stream:
              schema:
                $ref: '#/components/schemas/SolrZkConfigNode'
    put:
      tags:
      - Solr Configuration
      summary: Replace a Solr configuration file
      description: Overwrite a Solr configuration file with the one provided in the request body. As a best practice, all requests should include the Content-type in the request header.
      operationId: putFile_1
      parameters:
      - name: collection
        in: path
        description: The collection that contains the configuration files.
        required: true
        schema:
          type: string
        example: api-test-app
      - name: path
        in: path
        description: The path to a specific file or nested child nodes. If the file is not nested, the filename can be entered without any path information.
        required: true
        schema:
          pattern: .*
          type: string
        example: solrconfig.xml
      - name: reload
        in: query
        description: '''True'' to reload the collection and make the changes available to Solr immediately.'
        schema:
          type: boolean
          default: false
        example: true
      - name: validate
        in: query
        description: Before updating the Solr configuration, reload the Solr collection and verify that it doesn't fail.
        schema:
          type: boolean
          default: true
        example: false
      - name: If-Match
        in: header
        description: An optional tag to match against the specified blob.
        schema:
          type: string
          default: '-1'
      requestBody:
        description: The content of the file to be saved.
        content:
          '*/*':
            schema:
              type: array
              items:
                pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
                type: string
                format: byte
        required: false
      responses:
        '204':
          description: No Content
          content: {}
      x-codegen-request-body-name: body
    post:
      tags:
      - Solr Configuration
      summary: Create a Solr configuration file
      description: Upload a new Solr configuration file in the request body. As a best practice, all requests should include the Content-type in the request header.
      operationId: postFile
      parameters:
      - name: collection
        in: path
        description: The collection that contains the configuration files.
        required: true
        schema:
          type: string
        example: api-test-app
      - name: path
        in: path
        description: The path to a specific file or nested child nodes. If the file is not nested, the filename can be entered without any path information.
        required: true
        schema:
          pattern: .*
          type: string
        example: solrconfig.xml
      - name: reload
        in: query
        description: '''True'' to reload the collection and make the changes available to Solr immediately.'
        schema:
          type: boolean
          default: false
      - name: validate
        in: query
        description: Validate the configuration file before saving it.
        schema:
          type: boolean
          default: true
      - name: If-Match
        in: header
        description: An optional tag to match against the specified blob.
        schema:
          type: string
          default: '0'
      requestBody:
        description: The content of the file to be saved.
        content:
          '*/*':
            schema:
              type: array
              items:
                pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
                type: string
                format: byte
        required: false
      responses:
        '200':
          description: successful operation
          content: {}
      x-codegen-request-body-name: body
components:
  schemas:
    SolrZkConfigNode:
      type: object
      properties:
        name:
          type: string
          description: The name of the file or node.
        parent:
          type: string
        href:
          type: string
          format: uri
        version:
          type: integer
          description: The file or node version from ZooKeeper.
          format: int32
        isDir:
          type: boolean
          description: If the node has children, this value will be true.
        children:
          type: array
          items:
            $ref: '#/components/schemas/SolrZkConfigNode'
        value:
          type: array
          description: Only returned if `expand=true` is added as a query parameter. This will be returned as the base64 encoding of the contents of the file.
          items:
            pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
            type: string
            format: byte
        type:
          type: string
          enum:
          - STOPWORDS
          - SYNONYMS
  securitySchemes:
    Basic_auth:
      type: http
      scheme: basic
    API_key:
      name: x-api-key
      type: apiKey
      in: header
x-original-swagger-version: '2.0'
x-provenance:
  method: harvested
  publisher: Lucidworks
  source: https://doc.lucidworks.com/api-reference/5.9/fusion-api-swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)