Untitled

mail@pastecode.io avatar
unknown
yaml
a year ago
4.5 kB
2
Indexable
Never
swagger: "2.0"
info:
  version: "1.0.0"
  title: Архив API
paths:
  /archive/transfer_rates:
    get:
      summary: Получить трансфертные ставки из архива
      description: Возвращает список трансфертных ставок из архива с возможностью фильтрации.
      parameters:
        - name: type
          in: query
          description: Тип ставки для фильтрации (базовые или плавающие)
          required: false
          type: string
        - name: start_date
          in: query
          description: Начальная дата для фильтрации по дате
          required: false
          type: string
          format: date
        - name: end_date
          in: query
          description: Конечная дата для фильтрации по дате
          required: false
          type: string
          format: date
      responses:
        200:
          description: Успешный ответ
          schema:
            type: array
            items:
              $ref: "#/definitions/TransferRate"
  /archive/filter_options:
    get:
      summary: Получить опции фильтрации для архива
      description: Возвращает опции фильтрации для страницы архива.
      responses:
        200:
          description: Успешный ответ
          schema:
            $ref: "#/definitions/FilterOptions"
definitions:
  TransferRate:
    type: object
    properties:
      date:
        type: string
        format: date
      currency:
        type: string
        minLength: 3
        maxLength: 3
      payment_frequency:
        type: string
      index:
        type: string
      data:
        type: number
  FilterOptions:
    type: object
    properties:
      main_filters:
        type: object
        properties:
          currency:
            type: string
            format: RUB
            description: Валюта для фильтрации
          index:
            type: string
            format: SOFR
            description: Индекс для фильтрации
          start_date:
            type: string
            format: date
            description: Начальная дата для фильтрации
          end_date:
            type: string
            format: date
            description: Конечная дата для фильтрации
          monthly:
            type: boolean
            description: Фильтр "Ежемесячно"
          quarterly:
            type: boolean
            description: Фильтр "Ежеквартально"
          semi_annually:
            type: boolean
            description: Фильтр "Раз в полгода"
          annually:
            type: boolean
            description: Фильтр "Раз в год"
          end_of_term:
            type: boolean
            description: Фильтр "В конце срока"
      term_search:
        type: object
        properties:
          currency:
            type: string
            format: RUB
            description: Валюта для фильтрации
          index:
            type: string
            format: SOFR
            description: Индекс для фильтрации
          start_date:
            type: string
            format: date
            description: Начальная дата для фильтрации
          end_date:
            type: string
            format: date
            description: Конечная дата для фильтрации
          term:
            type: integer
            description: Срок для фильтрации
          monthly:
            type: boolean
            description: Фильтр "Ежемесячно"
          quarterly:
            type: boolean
            description: Фильтр "Ежеквартально"
          semi_annually:
            type: boolean
            description: Фильтр "Раз в полгода"
          annually:
            type: boolean
            description: Фильтр "Раз в год"
          end_of_term:
            type: boolean
            description: Фильтр "В конце срока"