Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
W
WIE_202021_CSBillero11
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Bernard Roland (Student Com20)
WIE_202021_CSBillero11
Commits
10b2116b
Commit
10b2116b
authored
3 years ago
by
Bernard Roland (Student Com20)
Browse files
Options
Downloads
Patches
Plain Diff
Added documentation for the project api part
parent
7cd9c886
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/api/projects.md
+197
-0
197 additions, 0 deletions
docs/api/projects.md
with
197 additions
and
0 deletions
docs/api/projects.md
+
197
−
0
View file @
10b2116b
## Projects
### GET `/project` [requires authentication]
Get all the projects currently visible to the authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
projects
:
{
id
:
string
;
name
:
string
;
text
:
string
;
color
:
string
;
status
:
string
;
deadline
?:
string
;
}[];
}
```
### GET `/project/:uuid` [requires authentication]
Get the project with the given id, if it is visible to the currently authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
project
:
{
id
:
string
;
name
:
string
;
text
:
string
;
color
:
string
;
status
:
string
;
deadline
?:
string
;
teams
:
string
[];
};
}
```
### GET `/project/:uuid/tasks` [requires authentication]
Get all tasks that belong to the project with the given id, if it is visible to the currently
authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
tasks
:
{
id
:
string
;
project
:
string
;
name
:
string
;
text
:
string
;
icon
:
string
;
priority
:
string
;
status
:
string
;
dependencies
:
string
[];
requirements
:
{
role
:
string
;
time
:
number
;
}[];
assigned
:
{
user
:
string
;
time
:
number
;
finished
:
boolean
;
}[];
created
:
number
;
edited
:
number
;
color
:
string
;
}[];
}
```
### GET `/project/:uuid/assigned` [requires authentication]
Get all users that are assigned to one of the tasks belonging to the project with the given id, if
it is visible to the currently authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
assigned
:
{
id
:
string
;
username
:
string
;
email
:
string
;
realname
:
string
;
time
:
number
;
}[];
}
```
### GET `/project/:uuid/work?since=X&to=X` [requires authentication]
Get all work items for tasks belonging to the project with the given id, if it is visible to the
currently authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
work
:
{
id
:
string
,
task
:
string
,
user
:
string
,
started
:
number
,
finished
:
number
,
}[];
}
```
### GET `/user/activity?since=X&to=X` [requires authentication]
Get the activity for tasks belonging to the project with the given id, if it is visible to the
currently authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
activity
:
{
day
:
string
;
time
:
number
;
}[];
}
```
### GET `/user/completion?since=X&to=X` [requires authentication]
Get the completion of tasks belonging to the project with the given id, if it is visible to the
currently authenticated user.
#### Response body
```
typescript
interface
Body
{
status
:
string
;
completion
:
{
open
:
number
;
closed
:
number
;
suspended
:
number
;
overdue
:
number
;
};
}
```
### POST `team` [requires authentication]
Create a new project with the given data. On successful creation the id of the new projects id will
be returned.
#### Request body
```
typescript
interface
Body
{
teams
:
Array
<
string
>
;
name
:
string
;
text
:
string
;
color
:
string
;
deadline
?:
string
;
}
```
#### Response body
```
typescript
interface
Body
{
status
:
string
;
id
:
string
;
}
```
### PUT `team/:uuid` [requires authentication]
Update the project with the given id.
#### Request body
```
typescript
interface
Body
{
remove_teams
?:
Array
<
string
>
;
add_teams
?:
Array
<
string
>
;
name
?:
string
;
text
?:
string
;
color
?:
string
;
status
?:
string
;
deadline
?:
string
;
}
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment