Emporix Public Configuration API

openapi: 3.2.0
info:
  title: Emporix Public Configuration API
  version: v1
  contact:
    email: documentation@emporix.com
  description: 'Operations tagged Public Configuration across 2 of this provider''s published API definitions: emporix-indexing-service-openapi.yml, emporix-indexing-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.emporix.io
security:
- OAuth2:
  - indexing.search_manage
  - indexing.search_view
tags:
- name: Public Configuration
paths:
  /indexing/{tenant}/public/configurations:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    get:
      summary: Get all public configurations
      tags:
      - Public Configuration
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IndexPublicConfiguration'
              examples:
                Public configurations:
                  value:
                  - active: true
                    searchKey: 84dc4886f81f805c42bdd89d64de751a
                    applicationId: 8AP2HABA2I
                    indexName: exampleTenant
                    provider: ALGOLIA
                  - active: false
                    indexName: exampleTenant
                    provider: BATTERY_INCLUDED
        '401':
          description: Unauthorized
      operationId: GET-indexing-list-public-configs
      description: Retrieves all configurations of index providers. The returned response contains only search keys. Write keys are not returned.
      security:
      - OAuth2: []
    servers:
    - url: https://api.emporix.io
  /indexing/{tenant}/public/configurations/{provider}:
    parameters:
    - $ref: '#/components/parameters/trait_tenant'
    - $ref: '#/components/parameters/trait_provider'
    get:
      summary: Get public configuration
      tags:
      - Public Configuration
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IndexPublicConfiguration'
              examples:
                Public Algolia configuration:
                  value:
                    active: true
                    searchKey: 84dc4886f81f805c42bdd89d64de751a
                    applicationId: 8AP2HABA2I
                    indexName: exampleTenant
                    provider: ALGOLIA
                Public Battery Included configuration:
                  value:
                    active: true
                    indexName: exampleTenant
                    provider: BATTERY_INCLUDED
                    searchKey: 84dc4886f81f805c42bdd89d64de751x
        '401':
          $ref: '#/components/responses/Unauthorized_401'
        '404':
          $ref: '#/components/responses/NotFound_404'
      operationId: GET-indexing-retrieve-public-config
      description: 'Retrieves a single public configuration by a provider name. Supported providers:

        * Algolia - https://www.algolia.com

        * Battery Included - https://www.batteryincluded.io'
      security:
      - OAuth2: []
    servers:
    - url: https://api.emporix.io
components:
  responses:
    Unauthorized_401:
      description: Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
      content:
        application/json:
          schema:
            type: object
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
          examples:
            UnauthorizedExample:
              value:
                fault:
                  faultstring: Invalid access token
                  detail:
                    errorcode: oauth.v2.InvalidAccessToken
            AccessTokenExpiredExample:
              value:
                fault:
                  faultstring: Access Token expired
                  detail:
                    errorcode: keymanagement.service.access_token_expired
    NotFound_404:
      description: Resource has not been found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorMessage'
          examples:
            Not found:
              value:
                code: 404
                status: Not Found
                message: The provider UNKNOWN_PROVIDER is not supported.
  parameters:
    trait_provider:
      name: provider
      in: path
      required: true
      schema:
        type: string
        enum:
        - ALGOLIA
        - BATTERY_INCLUDED
      description: 'Provider name. Supported values: `ALGOLIA`, `BATTERY_INCLUDED`'
    trait_tenant:
      name: tenant
      in: path
      required: true
      description: 'The tenant that the caller is acting upon.


        Please note that this value is always lowercase.

        '
      schema:
        pattern: ^[a-z][a-z0-9]+$
        minLength: 3
        maxLength: 16
        type: string
  schemas:
    errorMessage:
      title: error
      description: Schema for API specified errors.
      type: object
      properties:
        code:
          description: Original HTTP error code, should be consistent with the response HTTP code
          type: integer
        status:
          description: Classification of the error type
          type: string
        message:
          description: Descriptive error message for debugging
          type: string
        details:
          type: array
          description: Error details
          items:
            type: string
    IndexPublicConfiguration:
      title: IndexPublicConfiguration
      type: object
      properties:
        searchKey:
          type: string
          description: API Key used for search purposes.
        applicationId:
          type: string
          description: Application id of an indexer provider.
        indexName:
          type: string
          description: Identifier of an index.
        provider:
          type: string
          description: 'Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.'
          enum:
          - ALGOLIA
          - BATTERY_INCLUDED
        active:
          type: boolean
          description: Indicates if the configuration is active or not.
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.emporix.io/oauth/token
          scopes:
            indexing.search_view: Needed to read an index provider configuration
            indexing.search_manage: Needed to manage an index provider configuration
x-refined-from:
- emporix-indexing-service-openapi.yml
- emporix-indexing-service-openapi.yml