Missing docs folder

This commit is contained in:
Justin Dalrymple 2017-06-30 13:13:52 -04:00
parent 03447124f9
commit 5287c8750c
2 changed files with 41 additions and 26 deletions

27
.gitignore vendored
View File

@ -1,27 +1,2 @@
.DS_Store
NOTES
*~
*#
.#*
node_modules
examples/credentials*
lib-cov
*.seed
*.log
*.csv
*.dat
*.out
*.pid
*.gz
pids
logs
results
npm-debug.log
.idea
*.iml
/docs
npm-debug.log

40
docs/projects.md Normal file
View File

@ -0,0 +1,40 @@
# Projects API
## List projects
Get a list of visible projects for authenticated user. When accessed without authentication, only public projects are returned.
```javascript
let projects = GitlabAPI.projects.all();
```
Parameters: [List all projects](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md#list-projects)
### Get single project
Get a specific project. This endpoint can be accessed without authentication if
the project is publicly accessible.
```javascript
// From a project ID
let projectA = GitlabAPI.projects.show(21);
// From a projects url
let projectB = GitlabAPI.projects.show('diaspora/diaspora');
```
Parameters: [Get single project](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md#get-single-project)
### Create project
Creates a new project owned by the authenticated user.
```javascript
// From a project ID
let projectA = GitlabAPI.projects.create({
// params
});
```
Parameters: [Create project](https://github.com/gitlabhq/gitlabhq/blob/master/doc/api/projects.md#create-project)