https://github.com/colevoss/project-service

https://github.com/colevoss/project-service

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/colevoss/project-service
• Owner: colevoss
• Created: 2017-10-24T23:30:49.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-28T02:58:55.000Z (over 8 years ago)
• Last Synced: 2025-11-06T10:02:00.462Z (7 months ago)
• Language: TypeScript
• Size: 54.7 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Project Service

This is the project microservice for the Adio project. It is reponisbile for creating, reading, and updating projets.

## Types

### Project

**_id**: `string` Unique ID of a project. 

**name**: `string` Name of the project

**groupId**: `string` Unique ID of the group that this project belongs to.

### ProjectInput

**name**: Name of the new project

**groupId**: Unique ID of the group that the project belongs to.

## Endpoints

### Get Projects

##### Endpoint:

**GET** `/projects?ids=[id,id,id]`

##### Returns:

`Array`

Used for fetching multiple projects by ids. You must include the `ids` query param as a comma separated list of project ids.

### Get Project

##### Endpoint:

**GET** `/projects/{id}`

##### Returns:

`Project`

Used For fetching one project by id.

### Create Project

##### Endpoint:

**POST** `/projects`

##### Params:

`ProjectInput`

##### Returns:

`Project`

### Set Group

##### Endpoint

**PUT** `projects/{id}/group`

##### Params:

```javascript

{ groupId: string }

```

##### Returns:

`Project`

Sets the projects group to the provided group id