diff options
| author | Andrew Beresford <aberesford@equalexperts.com> | 2018-04-06 17:58:45 +0300 |
|---|---|---|
| committer | Andrew Beresford <aberesford@equalexperts.com> | 2018-04-08 22:59:03 +0300 |
| commit | 3a4086e22f2a4c837635f14bb6e9ae056299dc6c (patch) | |
| tree | c7a72787ce86ca5b0ad419489cd8be67ebfb7bda /doc/api | |
| parent | 86ca1a77c58b508fc1b037c5fffbfb22fd992b42 (diff) | |
Expose the target commit ID through the tag API
This is useful for annotated tags, where the deferenced target is not the same as the tag object. At the moment there is no way to differentiate the two through the tag API.
This change adds a "target" property and leaves the existing "commit" property alone so that existing behaviour is not altered.
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/tags.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/api/tags.md b/doc/api/tags.md index fa25dc76452..4af096c3c0c 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -42,6 +42,7 @@ Parameters: "description": "Amazing release. Wow" }, "name": "v1.0.0", + "target": "2695effb5807a22ff3d138d593fd856244e155e7", "message": null } ] @@ -73,6 +74,7 @@ Example Response: { "name": "v5.0.0", "message": null, + "target": "60a8ff033665e1207714d6670fcd7b65304ec02f", "commit": { "id": "60a8ff033665e1207714d6670fcd7b65304ec02f", "short_id": "60a8ff03", @@ -132,12 +134,16 @@ Parameters: "description": "Amazing release. Wow" }, "name": "v1.0.0", + "target: "2695effb5807a22ff3d138d593fd856244e155e7", "message": null } ``` The message will be `null` when creating a lightweight tag otherwise it will contain the annotation. +The target will contain the tag objects ID when creating annotated tags, +otherwise it will contain the commit ID when creating lightweight tags. + In case of an error, status code `405` with an explaining error message is returned. |