diff options
author | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-06 14:59:50 +0300 |
---|---|---|
committer | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-06 14:59:50 +0300 |
commit | 7f287c9136d5d1cdda8df170c6e772ca82aad1e9 (patch) | |
tree | 789766ad1b383310fc74b055e6869f1f1698f7bf /doc | |
parent | f76bfed9fc3e52c7b3b731dbb311b6b394d9af62 (diff) |
API: Ability to retrieve a single tag
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/tags.md | 34 |
1 files changed, 33 insertions, 1 deletions
diff --git a/doc/api/tags.md b/doc/api/tags.md index 17d12e9cc62..c451a42b725 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -38,6 +38,38 @@ Parameters: ] ``` +## Get a single repository tag + +Get a specific repository tag determined by its name. It returns 200 together +with the tag information if the tag exists. It returns 404 if the tag does not +exist. + +Parameters: + +- `id` (required) - The ID of a project +- `tag_name` (required) - The name of the tag + +```json +{ + "name": "v5.0.0", + "message": null, + "commit": { + "id": "60a8ff033665e1207714d6670fcd7b65304ec02f", + "message": "v5.0.0\n", + "parent_ids": [ + "f61c062ff8bcbdb00e0a1b3317a91aed6ceee06b" + ], + "authored_date": "2015-02-01T21:56:31.000+01:00", + "author_name": "Arthur Verschaeve", + "author_email": "contact@arthurverschaeve.be", + "committed_date": "2015-02-01T21:56:31.000+01:00", + "committer_name": "Arthur Verschaeve", + "committer_email": "contact@arthurverschaeve.be" + }, + "release": null +} +``` + ## Create a new tag Creates a new tag in the repository that points to the supplied ref. @@ -148,4 +180,4 @@ Parameters: "tag_name": "1.0.0", "description": "Amazing release. Wow" } -```
\ No newline at end of file +``` |