Fixer-swagger-2.0.yml

#  ___ _            _ _    _ _    __
# / __(_)_ __  _ __| (_)__(_) |_ /_/
# \__ \ | '  \| '_ \ | / _| |  _/ -_)
# |___/_|_|_|_| .__/_|_\__|_|\__\___|
#             |_| Module: Fixer 5
paths:
  /login:
    get:
      summary: Login (obtain bearer token)
      security:
      - basicAuth: []
      produces:
      - text/plain
      - application/json
      operationId: login
      responses:
        '200':
          description: Successful login
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
      parameters:
      - in: query
        name: _output
        description: Optional output format
        type: string
        required: false
        enum:
        - json
        - oauth2
        - token
      tags:
      - session
  /logout:
    get:
      summary: Logout (revoke bearer token)
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: logout
      responses:
        '200':
          description: Successfull logout
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
      tags:
      - session
  /rest/FixerRates/{row_id}/action:FixerRatesRefresh:
    get:
      summary: Call a custom action for a FixerRates business object record or for
        all records
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: obj-fixerrates-action-fixerratesrefresh
      responses:
        '200':
          schema:
            $ref: '#/definitions/ActionResult'
          description: Success in calling the custom action
        '400':
          schema:
            $ref: '#/definitions/Error400'
          description: Bad request
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
        '500':
          schema:
            $ref: '#/definitions/Error500'
          description: Internal server error
        '404':
          schema:
            $ref: '#/definitions/Error404'
          description: Not found
      parameters:
      - in: path
        name: row_id
        description: Row ID (or empty or _ for all row IDs)
        type: string
        required: true
      tags:
      - FixerRates
  /rest/FixerRates:
    get:
      summary: Search FixerRates business object records or get contextualized metadata
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: obj-fixerrates-search
      responses:
        '200':
          schema:
            $ref: '#/definitions/ArrayOfFixerRates'
          description: Success in searching business object records (or in getting
            contextualized business object metadata, documentation, ...)
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
        '500':
          schema:
            $ref: '#/definitions/Error500'
          description: Internal server error
      parameters:
      - in: query
        name: _metadata
        description: Metadata?
        type: boolean
        required: false
      - in: query
        name: _count
        description: Count?
        type: boolean
        required: false
      - in: query
        name: _doc
        description: Documentation?
        type: boolean
        required: false
      - in: query
        name: fixerBaseCurId
        description: Search filter for Base currency
        type: string
        required: false
      - in: query
        name: fixerBaseCurId__isoCurCode
        description: Search filter for Currency code (3 letters)
        type: string
        required: false
      - in: query
        name: fixerTargetCurId
        description: Search filter for Target currency
        type: string
        required: false
      - in: query
        name: fixerTargetCurId__isoCurCode
        description: Search filter for Currency code (3 letters)
        type: string
        required: false
      - in: query
        name: fixerDate
        description: Search filter for Date du taux de conversion
        type: string
        required: false
      - in: query
        name: fixerConversionRate
        description: Search filter for Conversion rate
        type: number
        required: false
      tags:
      - FixerRates
  /rest/FixerRates/{row_id}:
    post:
      summary: Create a new FixerRatesbusiness object record
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: obj-fixerrates-create
      responses:
        '200':
          schema:
            $ref: '#/definitions/FixerRates'
          description: Success in creating a new business object record
        '400':
          schema:
            $ref: '#/definitions/Error400'
          description: Bad request
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
        '500':
          schema:
            $ref: '#/definitions/Error500'
          description: Internal server error
      parameters:
      - in: path
        name: row_id
        description: Row ID (or empty or _ for all row IDs)
        type: string
        required: true
      - schema:
          $ref: '#/definitions/FixerRates'
        in: body
        name: body
      tags:
      - FixerRates
      consumes:
      - application/json
    get:
      summary: Get a FixerRates business object record
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: obj-fixerrates-get
      responses:
        '200':
          schema:
            $ref: '#/definitions/FixerRates'
          description: Success in getting a single business object record
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
        '500':
          schema:
            $ref: '#/definitions/Error500'
          description: Internal server error
        '404':
          schema:
            $ref: '#/definitions/Error404'
          description: Not found
      parameters:
      - in: path
        name: row_id
        description: Row ID (or empty or _ for all row IDs)
        type: string
        required: true
      - in: query
        name: _inline_documents
        description: Inline documents?
        type: boolean
        required: false
      - in: query
        name: _inline_thumbnails
        description: Inline documents' thumbnails?
        type: boolean
        required: false
      - in: query
        name: _inline_objects
        description: Inline objects?
        type: boolean
        required: false
      tags:
      - FixerRates
    delete:
      summary: Delete a FixerRates business object record
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: obj-fixerrates-delete
      responses:
        '200':
          description: Success in deleting a business object record
        '400':
          schema:
            $ref: '#/definitions/Error400'
          description: Bad request
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
        '500':
          schema:
            $ref: '#/definitions/Error500'
          description: Internal server error
        '404':
          schema:
            $ref: '#/definitions/Error404'
          description: Not found
      parameters:
      - in: path
        name: row_id
        description: Row ID (or empty or _ for all row IDs)
        type: string
        required: true
      tags:
      - FixerRates
    put:
      summary: Update a FixerRatesbusiness object record
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: obj-fixerrates-update
      responses:
        '200':
          schema:
            $ref: '#/definitions/FixerRates'
          description: Success in updating a business object record
        '400':
          schema:
            $ref: '#/definitions/Error400'
          description: Bad request
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
        '500':
          schema:
            $ref: '#/definitions/Error500'
          description: Internal server error
        '404':
          schema:
            $ref: '#/definitions/Error404'
          description: Not found
      parameters:
      - in: path
        name: row_id
        description: Row ID (or empty or _ for all row IDs)
        type: string
        required: true
      - schema:
          $ref: '#/definitions/FixerRates'
        in: body
        name: body
      tags:
      - FixerRates
      consumes:
      - application/json
  /:
    get:
      summary: Get user session information
      security:
      - bearerAuth: []
      produces:
      - application/json
      operationId: info
      responses:
        '200':
          description: Success in getting user session information
        '401':
          schema:
            $ref: '#/definitions/Error401'
          description: Unauthorized
      parameters:
      - in: query
        name: texts
        description: Texts?
        type: boolean
        required: false
      tags:
      - session
securityDefinitions:
  basicAuth:
    type: basic
  bearerAuth:
    in: header
    name: Authorization
    type: apiKey
definitions:
  Error404:
    type: object
    properties:
      error:
        description: Error message
        type: string
      status:
        description: Error status
        type: integer
        enum:
        - 404
  FixerRates:
    type: object
    properties:
      fixerTargetCurId__isoCurCode:
        description: Currency code (3 letters)
        type: string
      fixerConversionRate:
        description: Conversion rate
        type: number
      fixerBaseCurId__isoCurCode:
        description: Currency code (3 letters)
        type: string
      fixerTargetCurId:
        description: Target currency
        type: string
      fixerDate:
        description: Date du taux de conversion
        type: string
        example: yyyy-MM-dd
      row_id:
        description: Unique technical row ID
        type: string
      fixerBaseCurId:
        description: Base currency
        type: string
  ActionResult:
    type: object
    properties:
      result:
        description: Action result
        type: string
  TreeviewData:
    type: object
    properties:
      item:
        description: Object item with lists of linked objects' items
        type: object
  ArrayOfFixerRates:
    type: array
    items:
      $ref: '#/definitions/FixerRates'
  PublicationResult:
    type: object
    properties:
      mime:
        description: MIME type
        type: string
      content:
        description: Content (plain text or base64 encoded)
        type: string
  Error400:
    type: object
    properties:
      error:
        description: Error message
        type: string
      status:
        description: Error status
        type: integer
        enum:
        - 400
  Error401:
    type: object
    properties:
      error:
        description: Error message
        type: string
      status:
        description: Error status
        type: integer
        enum:
        - 401
  Error500:
    type: object
    properties:
      error:
        description: Error message
        type: string
      status:
        description: Error status
        type: integer
        enum:
        - 500
  Error403:
    type: object
    properties:
      error:
        description: Error message
        type: string
      status:
        description: Error status
        type: integer
        enum:
        - 403
swagger: '2.0'
info:
  license:
    name: Simplicite license
    url: http://www.simplicitesoftware.com
  contact:
    name: Simplicite Software
    url: http://www.simplicitesoftware.com
    email: contact@simplicitesoftware.com
  description: API for module Fixer
  title: Fixer
  version: '5'
tags:
- name: FixerRates
  description: Exchange rate