Skip to content

Commit fbc0881

Browse files
author
Vladimir Kotal
committed
add repository fields descriptions
1 parent ef3377c commit fbc0881

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

apiary.apib

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -382,14 +382,16 @@ will be used for repository paths.
382382
### return the field value [GET]
383383

384384
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)
385+
- `working` (boolean) - is the repository capable of running underlying SCM
386+
commands
387+
- `type` (string) - type of SCM
388+
- `remote` (boolean) - is the SCM source remote
389+
- `parent` (string) - origin/parent of the SCM
390+
- `branch` (string) - branch identification
391+
- `currentVersion` (string) - current revision ID
392+
- `handleRenamedFiles` (boolean) - whether to handle renamed files for history
393+
cache generation
394+
- `historyEnabled` (boolean) - is history enabled
393395

394396
The repository path is relative to source root.
395397

0 commit comments

Comments
 (0)