Skip to content

Commit ef3377c

Browse files
author
Vladimir Kotal
committed
document RepositoryInfo fields
1 parent e045acb commit ef3377c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

apiary.apib

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -377,10 +377,20 @@ will be used for repository paths.
377377

378378
["sc-2","sc-1"]
379379

380-
## Repository type [/repositories/property/{field}{?repository}]
380+
## Repository field value [/repositories/property/{field}{?repository}]
381381

382382
### return the field value [GET]
383383

384+
The repository path is relative to source root. Examples of field names:
385+
- `working` (boolean)
386+
- `type` (string)
387+
- `remote` (boolean)
388+
- `parent` (string)
389+
- `branch` (string)
390+
- `currentVersion` (string)
391+
- handleRenamedFiles (boolean)
392+
- `historyEnabled` (boolean)
393+
384394
The repository path is relative to source root.
385395

386396
+ Response 200 (application/json)
@@ -541,7 +551,7 @@ The repository path is relative to source root.
541551

542552
+ Response 200 (application/json)
543553
+ Body
544-
554+
545555
[{"iso":3},{"the":3},{"to":3},{"conform":3},{"-":2},
546556
{"sc_window_set":1},{"_lso_outbound":1},{"missing":1}]
547557

@@ -562,4 +572,4 @@ This kicks off suggester data rebuild in the background, i.e. the rebuild will v
562572
+ Parameters
563573
+ project - project name
564574

565-
+ Response 204
575+
+ Response 204

0 commit comments

Comments
 (0)