openapi.yaml (3681B)
1 # OpenAPI API specification 2 swagger: '2.0' 3 info: 4 description: OpenRat Content Management System 5 version: 1.0.0 6 title: OpenRat Content Management System API 7 license: 8 name: GPL v3 9 host: demo.openrat.de 10 #basePath: / 11 schemes: 12 - https 13 - http 14 paths: 15 /: 16 get: 17 tags: 18 - pet 19 summary: Read data 20 description: Read data from CMS API 21 produces: 22 - application/xml 23 - application/json 24 parameters: 25 - name: action 26 in: query 27 description: The called action 28 required: true 29 type: array 30 items: 31 type: string 32 enum: 33 - user 34 - profile 35 - tree 36 - folder 37 - file 38 - image 39 - text 40 - page 41 - link 42 - alias 43 - group 44 - login 45 default: user 46 - name: subaction 47 in: query 48 description: The method to call 49 required: true 50 type: array 51 items: 52 type: string 53 enum: 54 - content 55 - edit 56 - view 57 - info 58 default: info 59 - name: id 60 in: query 61 description: ID of the object 62 required: false 63 type: array 64 items: 65 type: number 66 - name: output 67 in: query 68 description: Output type 69 required: false 70 type: array 71 items: 72 type: string 73 enum: 74 - json 75 - xml 76 default: json 77 collectionFormat: multi 78 responses: 79 '200': 80 description: success 81 schema: 82 type: string 83 '210': 84 description: method not available 85 schema: 86 type: string 87 post: 88 summary: Write data 89 description: write data to the CMS 90 consumes: 91 - application/json 92 - application/xml 93 produces: 94 - application/xml 95 - application/json 96 parameters: 97 - name: action 98 in: query 99 description: The called action 100 required: true 101 type: array 102 items: 103 type: string 104 enum: 105 - user 106 - profile 107 - tree 108 - folder 109 - file 110 - image 111 - text 112 - page 113 - link 114 - alias 115 - group 116 - login 117 default: user 118 - name: subaction 119 in: query 120 description: The method to call 121 required: true 122 type: array 123 items: 124 type: string 125 enum: 126 - content 127 - edit 128 - view 129 - info 130 default: info 131 - name: id 132 in: query 133 description: ID of the object 134 required: false 135 type: array 136 items: 137 type: number 138 - name: output 139 in: query 140 description: output type 141 required: false 142 type: array 143 items: 144 type: string 145 enum: 146 - json 147 - xml 148 default: json 149 collectionFormat: multi 150 responses: 151 '200': 152 description: success 153 schema: 154 type: string 155 '210': 156 description: method not available 157 schema: 158 type: string 159 160 externalDocs: 161 description: Find out more about OpenRat CMS 162 url: 'http://www.openrat.de' 163