Advertisement
Guest User

Untitled

a guest
Aug 31st, 2015
80
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 30.95 KB | None | 0 0
  1. swagger: '2.0'
  2. info:
  3.   version: 0.1.0
  4.   title: RESTful API for Roundup
  5.   description: |
  6.    This is a sample Roundup REST server.
  7. host: rounduprest.cloudapp.net
  8. basePath: /rest
  9. schemes:
  10.  - http
  11. securityDefinitions:
  12.   BasicAuth:
  13.     type: basic
  14.     description: HTTP Basic Authentication.
  15. paths:
  16.   '/data/{class}':
  17.     get:
  18.       tags:
  19.        - Abstract
  20.         - Collection
  21.       summary: |
  22.        Get the list of objects from a Class.
  23.       operationId: get_collection
  24.       produces:
  25.        - application/json
  26.       parameters:
  27.         - in: path
  28.           name: class
  29.           description: Name of the `Class`.
  30.           required: true
  31.           type: string
  32.       responses:
  33.         '200':
  34.           description: Successful response
  35.           schema:
  36.             type: object
  37.             properties:
  38.               data:
  39.                 type: array
  40.                 items:
  41.                   $ref: '#/definitions/item'
  42.         '403':
  43.           description: Insufficient Permission
  44.           schema:
  45.             type: object
  46.             properties:
  47.               error:
  48.                 $ref: '#/definitions/error'
  49.         '404':
  50.           description: Resource is not available
  51.           schema:
  52.             type: object
  53.             properties:
  54.               error:
  55.                 $ref: '#/definitions/error'
  56.     post:
  57.       tags:
  58.        - Abstract
  59.         - Collection
  60.       summary: |
  61.        Add a new item to a Class
  62.       description: |
  63.        This method add a new item to the `Class`. The form data contains all of
  64.         the attributes of the item. Only `required` attributes are required. The other attributes are
  65.         optional
  66.       operationId: post_collection
  67.       consumes:
  68.        - application/x-www-form-urlencoded
  69.         - multipart/form-data
  70.       produces:
  71.        - application/json
  72.       parameters:
  73.         - in: path
  74.           name: class
  75.           description: Name of the `Class`.
  76.           required: true
  77.           type: string
  78.         - in: query
  79.           name: required_attribute
  80.           description: Key attribute of the object
  81.           required: true
  82.           type: string
  83.         - in: query
  84.           name: optional_attribute_1
  85.           description: 'Another optional attribute of the object'
  86.           required: false
  87.           type: string
  88.         - in: query
  89.           name: optional_attribute_2
  90.           description: 'Another optional attribute of the object'
  91.           required: false
  92.           type: string
  93.         - in: query
  94.           name: optional_attribute_3
  95.           description: 'Another optional attribute of the object'
  96.           required: false
  97.           type: string
  98.       responses:
  99.         '201':
  100.           description: Successful response
  101.           schema:
  102.             title: data
  103.             type: object
  104.             properties:
  105.               item:
  106.                 $ref: '#/definitions/item'
  107.         '400':
  108.           description: Malformed request
  109.           schema:
  110.             type: object
  111.             properties:
  112.               error:
  113.                 $ref: '#/definitions/error'
  114.         '403':
  115.           description: Insufficient Permission
  116.           schema:
  117.             type: object
  118.             properties:
  119.               error:
  120.                 $ref: '#/definitions/error'
  121.         '404':
  122.           description: Resource is not available
  123.           schema:
  124.             type: object
  125.             properties:
  126.               error:
  127.                 $ref: '#/definitions/error'
  128.         '409':
  129.           description: "The unique attribute's value is already exist."
  130.           schema:
  131.             type: object
  132.             properties:
  133.               error:
  134.                 $ref: '#/definitions/error'
  135.       security:
  136.         - BasicAuth: []
  137.     delete:
  138.       tags:
  139.        - Abstract
  140.         - Collection
  141.       summary: |
  142.        Delete all objects of a Class
  143.       description: |
  144.        This method will delete all objects of a `Class`. However, note that Roundup does not allow delete operation by default.
  145.       operationId: delete_collection
  146.       produces:
  147.        - application/json
  148.       parameters:
  149.         - in: path
  150.           name: class
  151.           description: Name of the `Class`.
  152.           required: true
  153.           type: string
  154.       responses:
  155.         '200':
  156.           description: Successful response
  157.           schema:
  158.             title: data
  159.             type: object
  160.             properties:
  161.               status:
  162.                 type: string
  163.               count:
  164.                 type: integer
  165.                 format: int32
  166.         '403':
  167.           description: Insufficient Permission
  168.           schema:
  169.             type: object
  170.             properties:
  171.               error:
  172.                 $ref: '#/definitions/error'
  173.       security:
  174.         - BasicAuth: []
  175.     options:
  176.       tags:
  177.        - Abstract
  178.         - Collection
  179.       summary: |
  180.        Request for available communication options
  181.       description: |
  182.        Request for information about the communication options available on the `Class`. This method allows the client to determine the options and/or requirements associated with a resource, without implying a resource action or initiating a resource retrieval.
  183.       operationId: options_collection
  184.       produces:
  185.        - application/json
  186.       parameters:
  187.         - in: path
  188.           name: class
  189.           description: Name of the `Class`.
  190.           required: true
  191.           type: string
  192.       responses:
  193.         '204':
  194.           description: Successful response
  195.         '404':
  196.           description: Resource is not available
  197.           schema:
  198.             type: object
  199.             properties:
  200.               error:
  201.                 $ref: '#/definitions/error'
  202.   '/data/{class}/{id}':
  203.     get:
  204.       tags:
  205.        - Abstract
  206.         - Element
  207.       summary: |
  208.        Get an Object from a Class.
  209.       operationId: get_element
  210.       parameters:
  211.         - in: path
  212.           name: class
  213.           description: Name of the `Class`
  214.           required: true
  215.           type: string
  216.         - in: path
  217.           name: id
  218.           description: Id of the `Object`
  219.           required: true
  220.           type: string
  221.       responses:
  222.         '200':
  223.           description: Successful response
  224.           schema:
  225.             type: object
  226.             properties:
  227.               data:
  228.                 $ref: '#/definitions/object'
  229.         '403':
  230.           description: Insufficient Permission
  231.           schema:
  232.             type: object
  233.             properties:
  234.               error:
  235.                 $ref: '#/definitions/error'
  236.         '404':
  237.           description: Resource is not available
  238.           schema:
  239.             type: object
  240.             properties:
  241.               error:
  242.                 $ref: '#/definitions/error'
  243.     put:
  244.       tags:
  245.        - Abstract
  246.         - Element
  247.       summary: |
  248.        Replace data of the Object
  249.       description:
  250.        This method replace the data of the `Object` by the form data. If an optional field is omitted, the corresponding attribute will not be updated. This method will return only attributes that has been updated
  251.       operationId: put_element
  252.       consumes:
  253.        - application/x-www-form-urlencoded
  254.         - multipart/form-data
  255.       produces:
  256.        - application/json
  257.       parameters:
  258.         - in: path
  259.           name: class
  260.           description: Name of the `Class`.
  261.           required: true
  262.           type: string
  263.         - in: path
  264.           name: id
  265.           description: Id of the `Object`
  266.           required: true
  267.           type: string
  268.         - in: query
  269.           name: key_attribute
  270.           description: Key attribute of the object
  271.           required: true
  272.           type: string
  273.         - in: query
  274.           name: required_attribute
  275.           description: Required attribute of the object
  276.           required: true
  277.           type: string
  278.         - in: query
  279.           name: optional_attribute_1
  280.           description: 'Another attribute of the object, not required'
  281.           required: false
  282.           type: string
  283.         - in: query
  284.           name: optional_attribute_2
  285.           description: 'Another attribute of the object, not required'
  286.           required: false
  287.           type: string
  288.         - in: query
  289.           name: optional_attribute_3
  290.           description: 'Another attribute of the object, not required'
  291.           required: false
  292.           type: string
  293.       responses:
  294.         '200':
  295.           description: Successful response
  296.           schema:
  297.             type: object
  298.             properties:
  299.               data:
  300.                 $ref: '#/definitions/object'
  301.         '400':
  302.           description: Malformed request
  303.           schema:
  304.             type: object
  305.             properties:
  306.               error:
  307.                 $ref: '#/definitions/error'
  308.         '403':
  309.           description: Insufficient Permission
  310.           schema:
  311.             type: object
  312.             properties:
  313.               error:
  314.                 $ref: '#/definitions/error'
  315.         '404':
  316.           description: Resource is not available
  317.           schema:
  318.             type: object
  319.             properties:
  320.               error:
  321.                 $ref: '#/definitions/error'
  322.         '409':
  323.           description: "The unique attribute's value is already exist."
  324.           schema:
  325.             type: object
  326.             properties:
  327.               error:
  328.                 $ref: '#/definitions/error'
  329.       security:
  330.         - BasicAuth: []
  331.     delete:
  332.       tags:
  333.        - Abstract
  334.         - Element
  335.       summary: |
  336.        Delete an Object from a Class
  337.       description: |
  338.        This method will delete an `Object` from a `Class`. However, note that Roundup does not allow delete operation by default.
  339.       operationId: delete_element
  340.       produces:
  341.        - application/json
  342.       parameters:
  343.         - in: path
  344.           name: class
  345.           description: Name of the `Class`.
  346.           required: true
  347.           type: string
  348.         - in: path
  349.           name: id
  350.           description: Id of the `Object`
  351.           required: true
  352.           type: string
  353.       responses:
  354.         '200':
  355.           description: Successful response
  356.           schema:
  357.             title: data
  358.             type: object
  359.             properties:
  360.               status:
  361.                 type: string
  362.         '403':
  363.           description: Insufficient Permission
  364.           schema:
  365.             type: object
  366.             properties:
  367.               error:
  368.                 $ref: '#/definitions/error'
  369.       security:
  370.         - BasicAuth: []
  371.     patch:
  372.       tags:
  373.        - Abstract
  374.         - Element
  375.       summary: |
  376.        Patch an Object of a Class
  377.       description:
  378.        This method will patch an `Object` of the `Class` by performing `ADD`, `REMOVE`, `REPLACE` or `ACTION`.
  379.         `ADD` will append new data from the form data to the corresponding attribute.
  380.         `REMOVE` will clear the corresponding attribute, regardless of the value from the form data.
  381.         `REPLACE` will replace the corresponding attribute with the new value from the form data.
  382.         `ACTION` will perform an action (`Retire` for example) to the Object, and pass any form fields starting with `action_args` to the Action arguments.
  383.       operationId: patch_element
  384.       consumes:
  385.        - application/x-www-form-urlencoded
  386.         - multipart/form-data
  387.       produces:
  388.        - application/json
  389.       parameters:
  390.         - in: path
  391.           name: class
  392.           description: Name of the `Class`.
  393.           required: true
  394.           type: string
  395.         - in: path
  396.           name: id
  397.           description: Id of the `Object`
  398.           required: true
  399.           type: string
  400.         - in: query
  401.           name: op
  402.           description: |
  403.            PATCH operators - `ADD` `REMOVE` `REPLACE` or `ACTION`. Default is `REPLACE`
  404.           required: false
  405.           type: string
  406.         - in: query
  407.           name: action_name
  408.           required: true
  409.           type: string
  410.         - in: query
  411.           name: key_attribute
  412.           description: Key attribute of the object
  413.           required: true
  414.           type: string
  415.         - in: query
  416.           name: optional_attribute_1
  417.           description: 'Another attribute of the object, not required'
  418.           required: false
  419.           type: string
  420.         - in: query
  421.           name: optional_attribute_2
  422.           description: 'Another attribute of the object, not required'
  423.           required: false
  424.           type: string
  425.         - in: query
  426.           name: optional_attribute_3
  427.           description: 'Another attribute of the object, not required'
  428.           required: false
  429.           type: string
  430.       responses:
  431.         '200':
  432.           description: Successful response
  433.           schema:
  434.             type: object
  435.             properties:
  436.               data:
  437.                 $ref: '#/definitions/object'
  438.         '400':
  439.           description: Malformed request
  440.           schema:
  441.             type: object
  442.             properties:
  443.               error:
  444.                 $ref: '#/definitions/error'
  445.         '403':
  446.           description: Insufficient Permission
  447.           schema:
  448.             type: object
  449.             properties:
  450.               error:
  451.                 $ref: '#/definitions/error'
  452.         '404':
  453.           description: Resource is not available
  454.           schema:
  455.             type: object
  456.             properties:
  457.               error:
  458.                 $ref: '#/definitions/error'
  459.         '409':
  460.           description: "The unique attribute's value is already exist."
  461.           schema:
  462.             type: object
  463.             properties:
  464.               error:
  465.                 $ref: '#/definitions/error'
  466.       security:
  467.         - BasicAuth: []
  468.     options:
  469.       tags:
  470.        - Abstract
  471.         - Element
  472.       summary: |
  473.        Request for available communication options
  474.       description: |
  475.        Request for information about the communication options available on the `Object` of the `Class`. This method allows the client to determine the options and/or requirements associated with a resource, without implying a resource action or initiating a resource retrieval.
  476.       produces:
  477.        - application/json
  478.       parameters:
  479.         - in: path
  480.           name: class
  481.           description: Name of the `Class`.
  482.           required: true
  483.           type: string
  484.         - in: path
  485.           name: id
  486.           description: Id of the `Object`
  487.           required: true
  488.           type: string
  489.       responses:
  490.         '204':
  491.           description: Successful response
  492.         '404':
  493.           description: Resource is not available
  494.           schema:
  495.             type: object
  496.             properties:
  497.               error:
  498.                 $ref: '#/definitions/error'
  499.   '/data/{class}/{id}/{attr}':
  500.     get:
  501.       tags:
  502.        - Abstract
  503.         - Attribute
  504.       summary: |
  505.        Get an object's attribute.
  506.       operationId: get_attribute
  507.       parameters:
  508.         - in: path
  509.           name: class
  510.           description: Name of the `Class`
  511.           required: true
  512.           type: string
  513.         - in: path
  514.           name: id
  515.           description: Id of the `Object`
  516.           required: true
  517.           type: string
  518.         - in: path
  519.           name: attr
  520.           description: Attribute of the `Object`
  521.           required: true
  522.           type: string
  523.       responses:
  524.         '200':
  525.           description: Successful response
  526.           schema:
  527.             type: object
  528.             properties:
  529.               data:
  530.                 $ref: '#/definitions/attr'
  531.         '403':
  532.           description: Insufficient Permission
  533.           schema:
  534.             type: object
  535.             properties:
  536.               error:
  537.                 $ref: '#/definitions/error'
  538.         '404':
  539.           description: Resource is not available
  540.           schema:
  541.             type: object
  542.             properties:
  543.               error:
  544.                 $ref: '#/definitions/error'
  545.     put:
  546.       tags:
  547.        - Abstract
  548.         - Attribute
  549.       summary: |
  550.        Replace an Attribute of the Object
  551.       description:
  552.        This method replace the data of an `Attribute` by the form field `data`. This method will return only attributes that has been updated.
  553.       operationId: put_attribute
  554.       consumes:
  555.        - application/x-www-form-urlencoded
  556.         - multipart/form-data
  557.       produces:
  558.        - application/json
  559.       parameters:
  560.         - in: path
  561.           name: class
  562.           description: Name of the `Class`.
  563.           required: true
  564.           type: string
  565.         - in: path
  566.           name: id
  567.           description: Id of the `Object`
  568.           required: true
  569.           type: string
  570.         - in: path
  571.           name: attr
  572.           description: Attribute of the `Object`
  573.           required: true
  574.           type: string
  575.         - in: query
  576.           name: data
  577.           description: New data for the attribute
  578.           required: true
  579.           type: string
  580.       responses:
  581.         '200':
  582.           description: Successful response
  583.           schema:
  584.             type: object
  585.             properties:
  586.               data:
  587.                 $ref: '#/definitions/object'
  588.         '400':
  589.           description: Malformed request
  590.           schema:
  591.             type: object
  592.             properties:
  593.               error:
  594.                 $ref: '#/definitions/error'
  595.         '403':
  596.           description: Insufficient Permission
  597.           schema:
  598.             type: object
  599.             properties:
  600.               error:
  601.                 $ref: '#/definitions/error'
  602.         '404':
  603.           description: Resource is not available
  604.           schema:
  605.             type: object
  606.             properties:
  607.               error:
  608.                 $ref: '#/definitions/error'
  609.         '409':
  610.           description: "The unique attribute's value is already exist."
  611.           schema:
  612.             type: object
  613.             properties:
  614.               error:
  615.                 $ref: '#/definitions/error'
  616.       security:
  617.         - BasicAuth: []
  618.     delete:
  619.       tags:
  620.        - Abstract
  621.         - Attribute
  622.       summary: |
  623.        Clear the Attribute's value of an Object
  624.       description: |
  625.        This method will set an attribute of an `Object` to empty list, dict or None based on its type.
  626.       operationId: delete_attribute
  627.       produces:
  628.        - application/json
  629.       parameters:
  630.         - in: path
  631.           name: class
  632.           description: Name of the `Class`.
  633.           required: true
  634.           type: string
  635.         - in: path
  636.           name: id
  637.           description: Id of the `Object`
  638.           required: true
  639.           type: string
  640.         - in: path
  641.           name: attr
  642.           description: Attribute of the `Object`
  643.           required: true
  644.           type: string
  645.       responses:
  646.         '200':
  647.           description: Successful response
  648.           schema:
  649.             title: data
  650.             type: object
  651.             properties:
  652.               status:
  653.                 type: string
  654.         '403':
  655.           description: Insufficient Permission
  656.           schema:
  657.             type: object
  658.             properties:
  659.               error:
  660.                 $ref: '#/definitions/error'
  661.       security:
  662.         - BasicAuth: []
  663.     patch:
  664.       tags:
  665.        - Abstract
  666.         - Attribute
  667.       summary: |
  668.        Patch the Attribute of the Object
  669.       description:
  670.        This method will patch an `Attribute` of the `Object` by performing `ADD`, `REMOVE` or `REPLACE`.
  671.       operationId: patch_attribute
  672.       consumes:
  673.        - application/x-www-form-urlencoded
  674.         - multipart/form-data
  675.       produces:
  676.        - application/json
  677.       parameters:
  678.         - in: path
  679.           name: class
  680.           description: Name of the `Class`.
  681.           required: true
  682.           type: string
  683.         - in: path
  684.           name: id
  685.           description: Id of the `Object`
  686.           required: true
  687.           type: string
  688.         - in: path
  689.           name: attr
  690.           description: Attribute of the `Object`
  691.           required: true
  692.           type: string
  693.         - in: query
  694.           name: op
  695.           description: |
  696.            PATCH operators - `ADD` `REMOVE` `REPLACE`. Default is `REPLACE`
  697.           required: false
  698.           type: string
  699.         - in: query
  700.           name: data
  701.           description: New data for the attribute
  702.           required: true
  703.           type: string
  704.       responses:
  705.         '200':
  706.           description: Successful response
  707.           schema:
  708.             type: object
  709.             properties:
  710.               data:
  711.                 $ref: '#/definitions/object'
  712.         '400':
  713.           description: Malformed request
  714.           schema:
  715.             type: object
  716.             properties:
  717.               error:
  718.                 $ref: '#/definitions/error'
  719.         '403':
  720.           description: Insufficient Permission
  721.           schema:
  722.             type: object
  723.             properties:
  724.               error:
  725.                 $ref: '#/definitions/error'
  726.         '404':
  727.           description: Resource is not available
  728.           schema:
  729.             type: object
  730.             properties:
  731.               error:
  732.                 $ref: '#/definitions/error'
  733.         '409':
  734.           description: "The unique attribute's value is already exist."
  735.           schema:
  736.             type: object
  737.             properties:
  738.               error:
  739.                 $ref: '#/definitions/error'
  740.       security:
  741.         - BasicAuth: []
  742.     options:
  743.       tags:
  744.        - Abstract
  745.         - Attribute
  746.       summary: |
  747.        Request for available communication options
  748.       description: |
  749.        Request for information about the communication options available on the `Attribute` of the `Object`. This method allows the client to determine the options and/or requirements associated with a resource, without implying a resource action or initiating a resource retrieval.
  750.       produces:
  751.        - application/json
  752.       parameters:
  753.         - in: path
  754.           name: class
  755.           description: Name of the `Class`.
  756.           required: true
  757.           type: string
  758.         - in: path
  759.           name: id
  760.           description: Id of the `Object`
  761.           required: true
  762.           type: string
  763.         - in: path
  764.           name: attr
  765.           description: Attribute of the `Object`
  766.           required: true
  767.           type: string
  768.       responses:
  769.         '204':
  770.           description: Successful response
  771.         '404':
  772.           description: Resource is not available
  773.           schema:
  774.             type: object
  775.             properties:
  776.               error:
  777.                 $ref: '#/definitions/error'
  778.   '/data/issue':
  779.     get:
  780.       tags:
  781.        - Issue
  782.         - Collection
  783.       summary: |
  784.        Get the list of Issue.
  785.       produces:
  786.        - application/json
  787.       responses:
  788.         '200':
  789.           description: Successful response
  790.           schema:
  791.             type: object
  792.             properties:
  793.               data:
  794.                 type: array
  795.                 items:
  796.                   $ref: '#/definitions/item'
  797.         '403':
  798.           description: Insufficient Permission
  799.           schema:
  800.             type: object
  801.             properties:
  802.               error:
  803.                 $ref: '#/definitions/error'
  804.         '404':
  805.           description: Resource is not available
  806.           schema:
  807.             type: object
  808.             properties:
  809.               error:
  810.                 $ref: '#/definitions/error'
  811.     post:
  812.       tags:
  813.        - Issue
  814.         - Collection
  815.       summary: |
  816.        Add a new Issue to the Tracker
  817.       consumes:
  818.        - application/x-www-form-urlencoded
  819.         - multipart/form-data
  820.       produces:
  821.        - application/json
  822.       parameters:
  823.         - in: query
  824.           name: assignee
  825.           description: User ID of Assignee
  826.           required: false
  827.           type: string
  828.         - in: query
  829.           name: components
  830.           description: Component IDs of the issue, separated by colon ","
  831.           required: false
  832.           type: string
  833.         - in: query
  834.           name: dependencies
  835.           description: Dependency IDs of the issue, separated by colon ","
  836.           required: false
  837.           type: string
  838.         - in: query
  839.           name: files
  840.           description: File IDs attached to the issue,  separated by colon ","
  841.           required: false
  842.           type: string
  843.         - in: query
  844.           name: hgrepos
  845.           description: HgRepo IDs attached to the issue,  separated by colon ","
  846.           required: false
  847.           type: string
  848.         - in: query
  849.           name: keywords
  850.           description: Keyword IDs of the issue,  separated by colon ","
  851.           required: false
  852.           type: string
  853.         - in: query
  854.           name: messages
  855.           description: Message IDs of the issue,  separated by colon ","
  856.           required: false
  857.           type: string
  858.         - in: query
  859.           name: nosy
  860.           description: Nosy list of the issue, User IDs separated by colon ","
  861.           required: false
  862.           type: string
  863.         - in: query
  864.           name: priority
  865.           description: Priority ID of the issue
  866.           required: false
  867.           type: string
  868.         - in: query
  869.           name: resolution
  870.           description: Resolution ID of the issue
  871.           required: false
  872.           type: string
  873.         - in: query
  874.           name: severity
  875.           description: Severity ID of the issue
  876.           required: false
  877.           type: string
  878.         - in: query
  879.           name: stage
  880.           description: Stage ID of the issue
  881.           required: false
  882.           type: string
  883.         - in: query
  884.           name: status
  885.           description: Status ID of the issue
  886.           required: false
  887.           type: string
  888.         - in: query
  889.           name: superseder
  890.           description: Superseder of the issue, data type is Issue ID
  891.           required: false
  892.           type: string
  893.         - in: query
  894.           name: title
  895.           description: Title of the issue
  896.           required: false
  897.           type: string
  898.         - in: query
  899.           name: type
  900.           description: Issue Type ID of the issue
  901.           required: false
  902.           type: string
  903.         - in: query
  904.           name: versions
  905.           description: Version IDs of the issue
  906.           required: false
  907.           type: string
  908.       responses:
  909.         '201':
  910.           description: Successful response
  911.           schema:
  912.             title: data
  913.             type: object
  914.             properties:
  915.               item:
  916.                 $ref: '#/definitions/item'
  917.         '400':
  918.           description: Malformed request
  919.           schema:
  920.             type: object
  921.             properties:
  922.               error:
  923.                 $ref: '#/definitions/error'
  924.         '403':
  925.           description: Insufficient Permission
  926.           schema:
  927.             type: object
  928.             properties:
  929.               error:
  930.                 $ref: '#/definitions/error'
  931.         '404':
  932.           description: Resource is not available
  933.           schema:
  934.             type: object
  935.             properties:
  936.               error:
  937.                 $ref: '#/definitions/error'
  938.         '409':
  939.           description: "The unique attribute's value is already exist."
  940.           schema:
  941.             type: object
  942.             properties:
  943.               error:
  944.                 $ref: '#/definitions/error'
  945.       security:
  946.         - BasicAuth: []
  947.     delete:
  948.       tags:
  949.        - Issue
  950.         - Collection
  951.       summary: |
  952.        Delete all Issues from the Tracker
  953.       produces:
  954.        - application/json
  955.       responses:
  956.         '200':
  957.           description: Successful response
  958.           schema:
  959.             title: data
  960.             type: object
  961.             properties:
  962.               status:
  963.                 type: string
  964.               count:
  965.                 type: integer
  966.                 format: int32
  967.         '403':
  968.           description: Insufficient Permission
  969.           schema:
  970.             type: object
  971.             properties:
  972.               error:
  973.                 $ref: '#/definitions/error'
  974.       security:
  975.         - BasicAuth: []
  976.     options:
  977.       tags:
  978.        - Issue
  979.         - Collection
  980.       summary: |
  981.        Request for available communication options
  982.       produces:
  983.        - application/json
  984.       responses:
  985.         '204':
  986.           description: Successful response
  987.         '404':
  988.           description: Resource is not available
  989.           schema:
  990.             type: object
  991.             properties:
  992.               error:
  993.                 $ref: '#/definitions/error'
  994. definitions:
  995.   item:
  996.     properties:
  997.       id:
  998.         type: string
  999.       link:
  1000.         type: string
  1001.   object:
  1002.     properties:
  1003.       id:
  1004.         type: string
  1005.       type:
  1006.         type: string
  1007.       link:
  1008.         type: string
  1009.       attributes:
  1010.         type: object
  1011.   attr:
  1012.     properties:
  1013.       id:
  1014.         type: string
  1015.       type:
  1016.         type: string
  1017.       link:
  1018.         type: string
  1019.       data:
  1020.         type: string
  1021.   issue:
  1022.     properties:
  1023.       id:
  1024.         type: string
  1025.       type:
  1026.         type: string
  1027.       link:
  1028.         type: string
  1029.       attributes:
  1030.         type: object
  1031.         properties:
  1032.           activity:
  1033.             type: string
  1034.             format: date-time
  1035.           actor:
  1036.             type: string
  1037.           assignee:
  1038.             type: string
  1039.           components:
  1040.             type: array
  1041.           components:
  1042.             type: array
  1043.             items:
  1044.               type: string
  1045.           creation:
  1046.             type: string
  1047.             format: date-time
  1048.           creator:
  1049.             type: string
  1050.           dependencies:
  1051.             type: array
  1052.             items:
  1053.               type: string
  1054.           files:
  1055.             type: array
  1056.             items:
  1057.               type: string
  1058.           hgrepos:
  1059.             type: array
  1060.             items:
  1061.               type: string
  1062.           keywords:
  1063.             type: array
  1064.             items:
  1065.               type: string
  1066.           message_count:
  1067.             type: number
  1068.             format: float
  1069.           messages:
  1070.             type: array
  1071.             items:
  1072.               type: string
  1073.           nosy:
  1074.             type: array
  1075.             items:
  1076.               type: string
  1077.           nosy_count:
  1078.             type: number
  1079.             format: float
  1080.           priority:
  1081.             type: string
  1082.           resolution:
  1083.             type: string
  1084.           severity:
  1085.             type: string
  1086.           stage:
  1087.             type: string
  1088.           status:
  1089.             type: string
  1090.           superseder:
  1091.             type: string
  1092.           title:
  1093.             type: string
  1094.           type:
  1095.             type: string
  1096.           versions:
  1097.             type: array
  1098.             items:
  1099.               type: string
  1100.   error:
  1101.     properties:
  1102.       status:
  1103.         type: integer
  1104.         format: int32
  1105.       msg:
  1106.         type: string
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement