Changeset 2328 in ProjectBuilder
- Timestamp:
- Sep 29, 2017, 5:40:23 PM (7 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
devel/pb-server/api.yml
r2323 r2328 23 23 - application/json 24 24 - application/yaml 25 # Global parameters 25 26 paths: 26 27 /doc: … … 61 62 parameters: 62 63 - name: name 63 #in: body64 in: body 64 65 description: Add project by name 65 66 required: true … … 79 80 schema: 80 81 $ref: '#/definitions/Error' 81 '/prj/{prjname}/conf':82 /conf: 82 83 get: 83 84 summary: List all configuration parameters for a specific project … … 86 87 - conf 87 88 parameters: 88 - name: prjname 89 in: path 90 required: true 91 description: The name of the project that will be queried for configuration 92 type: string 89 - $ref: '#/parameters/prjName' 93 90 responses: 94 91 '200': … … 101 98 schema: 102 99 $ref: '#/definitions/Error' 103 '/ prj/{prjname}/conf/{confname}':100 '/conf/{confname}': 104 101 get: 105 102 operationId: showConf 103 summary: Get a configuration item 106 104 tags: 107 105 - conf 108 106 parameters: 109 - name: prjname110 in: path111 required: true112 description: The name of the project for which we retrieve configuration113 type: string114 107 - name: confname 115 108 in: path 109 type: string 116 110 required: true 117 111 description: The name of the configuration item that will be queried 112 - $ref: '#/parameters/prjName' 118 113 responses: 119 114 '200': … … 125 120 schema: 126 121 $ref: '#/definitions/Error' 127 put: 128 operationId: updateConf 129 tags: 130 - conf 131 parameters: 132 - name: name 133 #in: body 134 description: Add a configuration item by name 135 required: true 136 schema: 137 $ref: '#/definitions/Conf' 138 responses: 139 '200': 140 description: Expected response to a valid request 141 schema: 142 $ref: '#/definitions/Conf' 143 '409': 144 description: Null response 145 schema: 146 $ref: '#/definitions/Error' 147 default: 148 description: Unexpected error 149 schema: 150 $ref: '#/definitions/Error' 151 delete: 152 operationId: removeConf 153 parameters: 154 - name: prjname 155 in: path 156 required: true 157 description: The name of the project for which we retrieve configuration 158 type: string 159 - name: confname 160 in: path 161 required: true 162 description: The name of the configuration item that will be deleted 163 responses: 164 '200': 165 description: Expected response to a valid request 166 '404': 167 description: Configuration item not found 168 default: 169 description: Unexpected error 170 schema: 171 $ref: '#/definitions/Error' 122 parameters: 123 prjName: 124 required: true 125 name: pbproj 126 in: body 127 description: The name of the project that will be queried 128 schema: 129 type: string 130 default: 'pb' 172 131 definitions: 173 132 Prj:
Note:
See TracChangeset
for help on using the changeset viewer.