Skip to content
Snippets Groups Projects
Commit 949b1df9 authored by Nihad Abbasov's avatar Nihad Abbasov
Browse files

API: update docs

parent 1b95c8bf
No related branches found
No related tags found
1 merge request!1142API changes
Hide whitespace changes
Inline Side-by-side
doc/api/issues.md
+ 5
− 5
View file @ 949b1df9
@@ -73,7 +73,7 @@ GET /projects/:id/issues
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
 
## Single issue
 
@@ -85,7 +85,7 @@ GET /projects/:id/issues/:issue_id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `issue_id` (required) - The ID of a project issue
 
```json
@@ -135,7 +135,7 @@ POST /projects/:id/issues
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `title` (required) - The title of an issue
+ `description` (optional) - The description of an issue
+ `assignee_id` (optional) - The ID of a user to assign issue
@@ -154,7 +154,7 @@ PUT /projects/:id/issues/:issue_id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `issue_id` (required) - The ID of a project's issue
+ `title` (optional) - The title of an issue
+ `description` (optional) - The description of an issue
@@ -175,7 +175,7 @@ DELETE /projects/:id/issues/:issue_id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `issue_id` (required) - The ID of a project's issue
 
Status code `200` will be returned on success.
doc/api/projects.md
+ 11
− 11
View file @ 949b1df9
## List projects
 
Get a list of authenticated users' projects.
Get a list of authenticated user's projects.
 
```
GET /projects
@@ -63,7 +63,7 @@ GET /projects/:id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
 
```json
{
@@ -91,7 +91,7 @@ Parameters:
 
## Project repository branches
 
Get a list of project repository branches.
Get a list of project repository branches sorted by name alphabetically.
 
```
GET /projects/:id/repository/branches
@@ -99,7 +99,7 @@ GET /projects/:id/repository/branches
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
 
```json
[
@@ -131,7 +131,7 @@ Parameters:
 
## Project repository tags
 
Get a list of project repository tags.
Get a list of project repository tags sorted by name in reverse alphabetical order.
 
```
GET /projects/:id/repository/tags
@@ -139,7 +139,7 @@ GET /projects/:id/repository/tags
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
 
```json
[
@@ -183,7 +183,7 @@ GET /projects/:id/snippets/:snippet_id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of a project's snippet
 
```json
@@ -214,7 +214,7 @@ GET /projects/:id/snippets/:snippet_id/raw
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of a project's snippet
 
## New snippet
@@ -227,7 +227,7 @@ POST /projects/:id/snippets
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `title` (required) - The title of a snippet
+ `file_name` (required) - The name of a snippet file
+ `lifetime` (optional) - The expiration date of a snippet
@@ -245,7 +245,7 @@ PUT /projects/:id/snippets/:snippet_id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of a project's snippet
+ `title` (optional) - The title of a snippet
+ `file_name` (optional) - The name of a snippet file
@@ -264,7 +264,7 @@ DELETE /projects/:id/snippets/:snippet_id
 
Parameters:
 
+ `id` (required) - The code name of a project
+ `id` (required) - The ID or code name of a project
+ `snippet_id` (required) - The ID of a project's snippet
 
Status code `200` will be returned on success.
lib/api/issues.rb
+ 5
− 5
View file @ 949b1df9
@@ -17,7 +17,7 @@ module Gitlab
# Get a list of project issues
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id/issues
get ":id/issues" do
@@ -27,7 +27,7 @@ module Gitlab
# Get a single project issue
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# issue_id (required) - The ID of a project issue
# Example Request:
# GET /projects/:id/issues/:issue_id
@@ -39,7 +39,7 @@ module Gitlab
# Create a new project issue
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# title (required) - The title of an issue
# description (optional) - The description of an issue
# assignee_id (optional) - The ID of a user to assign issue
@@ -67,7 +67,7 @@ module Gitlab
# Update an existing issue
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# issue_id (required) - The ID of a project issue
# title (optional) - The title of an issue
# description (optional) - The description of an issue
@@ -98,7 +98,7 @@ module Gitlab
# Delete a project issue
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# issue_id (required) - The ID of a project issue
# Example Request:
# DELETE /projects/:id/issues/:issue_id
lib/api/projects.rb
+ 8
− 8
View file @ 949b1df9
@@ -16,7 +16,7 @@ module Gitlab
# Get a single project
#
# Parameters:
# id (required) - The code of a project
# id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id
get ":id" do
@@ -26,7 +26,7 @@ module Gitlab
# Get a project repository branches
#
# Parameters:
# id (required) - The code of a project
# id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id/repository/branches
get ":id/repository/branches" do
@@ -36,7 +36,7 @@ module Gitlab
# Get a project repository tags
#
# Parameters:
# id (required) - The code of a project
# id (required) - The ID or code name of a project
# Example Request:
# GET /projects/:id/repository/tags
get ":id/repository/tags" do
@@ -46,7 +46,7 @@ module Gitlab
# Get a project snippet
#
# Parameters:
# id (required) - The code of a project
# id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id
@@ -58,7 +58,7 @@ module Gitlab
# Create a new project snippet
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# title (required) - The title of a snippet
# file_name (required) - The name of a snippet file
# lifetime (optional) - The expiration date of a snippet
@@ -84,7 +84,7 @@ module Gitlab
# Update an existing project snippet
#
# Parameters:
# id (required) - The code name of a project
# id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# title (optional) - The title of a snippet
# file_name (optional) - The name of a snippet file
@@ -111,7 +111,7 @@ module Gitlab
# Delete a project snippet
#
# Parameters:
# id (required) - The code of a project
# id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# DELETE /projects/:id/snippets/:snippet_id
@@ -123,7 +123,7 @@ module Gitlab
# Get a raw project snippet
#
# Parameters:
# id (required) - The code of a project
# id (required) - The ID or code name of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id/raw
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment