Untitled

Working self yml
mail@pastecode.io avatar
unknown
plain_text
a year ago
2.8 kB
2
Indexable
Never
openapi: 3.0.3
info:
  title: Call Recording Reporting Service API
  description: This is a reference bookstore API specification for Kotak
  contact:
    email: anshuman.jain@kotak.com
  version: 1.0.0
  license:
    name: Kotak Mahindra License
    url: https://www.kotak.com/licenses/license.html

servers:
  - url: http://audit.collection.dev.kotak.com
    description: Call Recording Reporting Service API
    variables:
      basePath:
        default: /call-audit

tags:
  - name: Call Quality Aggregation
    description: Get aggregated call quality data overall, including the total number of calls, audited calls, and fatal calls.
  - name: Call Reporting Information
    description: Perform CRUD, audit and filterMetadata informations for call recordings.

paths:
  /call-recording/search:
    post:
      operationId: searchCallRecording
      summary: Search call recordings
      description: This endpoint allows you to search for call recordings based on a variety of filters, such as `vertical`, `product` etc. The results of the search will be returned in a paginated format, with each page containing a list of call recording objects.
      tags:
        - Call Reporting Information
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiGetRequest'
      responses:
        200:
          $ref: "#/components/responses/OpenApiMultiGetResponse"
#        401:
#          $ref: "#/components/responses/UnauthorizedResponse"
#        403:
#          $ref: "#/components/responses/BadRequestResponse"
#        404:
#          $ref: "#/components/responses/NotFoundResponse"
#        500:
#          $ref: "#/components/responses/ServerErrorResponse"

components:

  responses:
    OpenApiMultiGetResponse:
      description: Response containing call recording data based on the specified filters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MultiGetResponse'

  schemas:

    MultiGetRequest:
      type: object
      properties:
        page:
          type: integer
          description: The page number of the results to return. The first page is 0-indexed.
          example: 0
          default: 0
        size:
          type: integer
          description: The number of results to return per page. Must be between 5 and 10.
          minimum: 5
          maximum: 15
          example: 10
          default: 10

    MultiGetResponse:
      type: object
      description: List of CallRecordingDataDto based on applied filters.
      properties:
        callRecordings:
#          type: integer
          type: array
          items:
            $ref: 'rest/callRecordingAuditInformation.yml#/components/schemas/CallRecordingDataDto'