SaveText.Ru

фывафыва
  1. openapi: 3.0.0
  2. info:
  3.   title: Points API
  4.   description: Работа с точками
  5.   version: 0.0.1
  6. servers:
  7.   - url: http://api.example.com/v1
  8.     description: Optional server description, e.g. Main (production) server
  9.   - url: http://staging-api.example.com
  10.     description: Optional server description, e.g. Internal staging server for testing
  11. paths:
  12.   /agent/{agentId}/point/{pointName}:
  13.     put:
  14.       summary: Регистрирует новую точку для агента.
  15.       # description: Optional extended description in CommonMark or HTML.
  16.       parameters:
  17.         - in: path
  18.           name: agentId
  19.           schema:
  20.             type: string
  21.             example: vimpelcom
  22.           required: true
  23.         - in: path
  24.           name: pointName
  25.           schema:
  26.             type: string
  27.             example: point-name
  28.           required: true
  29.       requestBody:
  30.         description: Optional description in *Markdown*
  31.         required: true
  32.         content:
  33.           application/json:
  34.             schema:
  35.               $ref: '#/components/schemas/PointCreate'
  36.        
  37.       responses:
  38.         '200':    # status code
  39.           description: A JSON array of user names
  40.           content:
  41.             application/json:
  42.               schema:
  43.                 type: array
  44.                 items:
  45.                   type: string
  46.   /agent/{agentId}/points/:
  47.     post:
  48.       summary: Регистрирует пачку точек для агента.
  49.       # description: Optional extended description in CommonMark or HTML.
  50.       parameters:
  51.         - in: path
  52.           name: agentId
  53.           schema:
  54.             type: string
  55.             example: vimpelcom
  56.           required: true
  57.       requestBody:
  58.         description: Optional description in *Markdown*
  59.         required: true
  60.         content:
  61.           application/json:
  62.             schema:
  63.               type: array
  64.               items:
  65.                 $ref: '#/components/schemas/PointCreate'
  66.        
  67.       responses:
  68.         '200':    # status code
  69.           description: A JSON array of created points
  70.           content:
  71.             application/json:
  72.               schema:
  73.                 type: array
  74.                 items:
  75.                   $ref: '#/components/schemas/Point'
  76. components:
  77.   schemas:
  78.     Money:
  79.       type: object
  80.       properties:
  81.         currency:
  82.           type: string
  83.           example: 'RUB'
  84.         amount:
  85.           type: number
  86.           example: '200.00'
  87.     Point:
  88.       type: object
  89.       required:
  90.         - name
  91.         - timezone
  92.       properties:
  93.         name:
  94.           type: string
  95.           example: point-name
  96.         timezone:
  97.           type: string
  98.           example: GMT+3
  99.         limit:
  100.           $ref: '#/components/schemas/Money'
  101.         hasLimit:
  102.           type: boolean
  103.     PointCreate:
  104.       type: object
  105.       required:
  106.         - timezone
  107.       properties:
  108.         timezone:
  109.           type: string
  110.         limit:
  111.           $ref: '#/components/schemas/Money'
  112.         hasLimit:
  113.           type: boolean
  114.     User:
  115.       type: object
  116.       properties:
  117.         id:
  118.           type: integer
  119.         name:
  120.           type: string

Share with your friends:

Print