Download as
Browse Code »

Commit 441e6dcf0d4d09a713ae6bc7bb47eddc76ad9f48

Authored by Marin Jankovski
1 parent e1c1e882
Exists in spb-stable and in 3 other branches 6-8-stable, 7-0-stable, 7-0-stable-spb

Update api project documentation to include project name as attribute.

Showing 1 changed file with 15 additions and 15 deletions   Show diff stats
doc/api/projects.md
  Diff comments   View file @441e6dc
@@ -162,7 +162,7 @@ GET /projects/:id/events @@ -162,7 +162,7 @@ GET /projects/:id/events
162 162
163 Parameters: 163 Parameters:
164 164
165 -+ `id` (required) - The ID or NAME of a project 165 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
166 166
167 ```json 167 ```json
168 168
@@ -290,7 +290,7 @@ GET /projects/:id/members @@ -290,7 +290,7 @@ GET /projects/:id/members
290 290
291 Parameters: 291 Parameters:
292 292
293 -+ `id` (required) - The ID or NAME of a project 293 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
294 + `query` (optional) - Query string to search for members 294 + `query` (optional) - Query string to search for members
295 295
296 296
@@ -304,7 +304,7 @@ GET /projects/:id/members/:user_id @@ -304,7 +304,7 @@ GET /projects/:id/members/:user_id
304 304
305 Parameters: 305 Parameters:
306 306
307 -+ `id` (required) - The ID or NAME of a project 307 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
308 + `user_id` (required) - The ID of a user 308 + `user_id` (required) - The ID of a user
309 309
310 ```json 310 ```json
@@ -332,7 +332,7 @@ POST /projects/:id/members @@ -332,7 +332,7 @@ POST /projects/:id/members
332 332
333 Parameters: 333 Parameters:
334 334
335 -+ `id` (required) - The ID or NAME of a project 335 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
336 + `user_id` (required) - The ID of a user to add 336 + `user_id` (required) - The ID of a user to add
337 + `access_level` (required) - Project access level 337 + `access_level` (required) - Project access level
338 338
@@ -347,7 +347,7 @@ PUT /projects/:id/members/:user_id @@ -347,7 +347,7 @@ PUT /projects/:id/members/:user_id
347 347
348 Parameters: 348 Parameters:
349 349
350 -+ `id` (required) - The ID or NAME of a project 350 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
351 + `user_id` (required) - The ID of a team member 351 + `user_id` (required) - The ID of a team member
352 + `access_level` (required) - Project access level 352 + `access_level` (required) - Project access level
353 353
@@ -362,7 +362,7 @@ DELETE /projects/:id/members/:user_id @@ -362,7 +362,7 @@ DELETE /projects/:id/members/:user_id
362 362
363 Parameters: 363 Parameters:
364 364
365 -+ `id` (required) - The ID or NAME of a project 365 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
366 + `user_id` (required) - The ID of a team member 366 + `user_id` (required) - The ID of a team member
367 367
368 This method is idempotent and can be called multiple times with the same parameters. 368 This method is idempotent and can be called multiple times with the same parameters.
@@ -383,7 +383,7 @@ GET /projects/:id/hooks @@ -383,7 +383,7 @@ GET /projects/:id/hooks
383 383
384 Parameters: 384 Parameters:
385 385
386 -+ `id` (required) - The ID or NAME of a project 386 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
387 387
388 388
389 ### Get project hook 389 ### Get project hook
@@ -396,7 +396,7 @@ GET /projects/:id/hooks/:hook_id @@ -396,7 +396,7 @@ GET /projects/:id/hooks/:hook_id
396 396
397 Parameters: 397 Parameters:
398 398
399 -+ `id` (required) - The ID or NAME of a project 399 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
400 + `hook_id` (required) - The ID of a project hook 400 + `hook_id` (required) - The ID of a project hook
401 401
402 ```json 402 ```json
@@ -422,7 +422,7 @@ POST /projects/:id/hooks @@ -422,7 +422,7 @@ POST /projects/:id/hooks
422 422
423 Parameters: 423 Parameters:
424 424
425 -+ `id` (required) - The ID or NAME of a project 425 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
426 + `url` (required) - The hook URL 426 + `url` (required) - The hook URL
427 + `push_events` - Trigger hook on push events 427 + `push_events` - Trigger hook on push events
428 + `issues_events` - Trigger hook on issues events 428 + `issues_events` - Trigger hook on issues events
@@ -439,7 +439,7 @@ PUT /projects/:id/hooks/:hook_id @@ -439,7 +439,7 @@ PUT /projects/:id/hooks/:hook_id
439 439
440 Parameters: 440 Parameters:
441 441
442 -+ `id` (required) - The ID or NAME of a project 442 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
443 + `hook_id` (required) - The ID of a project hook 443 + `hook_id` (required) - The ID of a project hook
444 + `url` (required) - The hook URL 444 + `url` (required) - The hook URL
445 + `push_events` - Trigger hook on push events 445 + `push_events` - Trigger hook on push events
@@ -458,7 +458,7 @@ DELETE /projects/:id/hooks/:hook_id @@ -458,7 +458,7 @@ DELETE /projects/:id/hooks/:hook_id
458 458
459 Parameters: 459 Parameters:
460 460
461 -+ `id` (required) - The ID or NAME of a project 461 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
462 + `hook_id` (required) - The ID of hook to delete 462 + `hook_id` (required) - The ID of hook to delete
463 463
464 Note the JSON response differs if the hook is available or not. If the project hook 464 Note the JSON response differs if the hook is available or not. If the project hook
@@ -477,7 +477,7 @@ GET /projects/:id/repository/branches @@ -477,7 +477,7 @@ GET /projects/:id/repository/branches
477 477
478 Parameters: 478 Parameters:
479 479
480 -+ `id` (required) - The ID of the project 480 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
481 481
482 ```json 482 ```json
483 [ 483 [
@@ -539,7 +539,7 @@ GET /projects/:id/repository/branches/:branch @@ -539,7 +539,7 @@ GET /projects/:id/repository/branches/:branch
539 539
540 Parameters: 540 Parameters:
541 541
542 -+ `id` (required) - The ID of the project. 542 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
543 + `branch` (required) - The name of the branch. 543 + `branch` (required) - The name of the branch.
544 544
545 545
@@ -553,7 +553,7 @@ PUT /projects/:id/repository/branches/:branch/protect @@ -553,7 +553,7 @@ PUT /projects/:id/repository/branches/:branch/protect
553 553
554 Parameters: 554 Parameters:
555 555
556 -+ `id` (required) - The ID of the project. 556 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
557 + `branch` (required) - The name of the branch. 557 + `branch` (required) - The name of the branch.
558 558
559 559
@@ -567,7 +567,7 @@ PUT /projects/:id/repository/branches/:branch/unprotect @@ -567,7 +567,7 @@ PUT /projects/:id/repository/branches/:branch/unprotect
567 567
568 Parameters: 568 Parameters:
569 569
570 -+ `id` (required) - The ID of the project. 570 ++ `id` (required) - The ID or NAMESPACE/PROJECT_NAME of a project
571 + `branch` (required) - The name of the branch. 571 + `branch` (required) - The name of the branch.
572 572
573 573