Skip to content

Commit

Permalink
Update Projects.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sidlak-c137 authored Nov 23, 2022
1 parent 6d823eb commit d0e2ebe
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions src/back_end/docs/Projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,5 +76,53 @@ Sample response shows output format, followed by sample data.
]
```

## <span style="color:deepskyblue"> getProjectByName
Get detailed project information based on the project name

* **Function Call:** getProjectByName(name)

* **Params:**

| Name | Type | Description | Default |
| ------ | ------- | ----------------------------------------------- | ----------------------- |
| `name` | String | The name of the project that is being requested | NONE (Required Param) |

* **Returned Data Format:** List

* **Success Response:** <br>
Sample response shows output format, followed by sample data. (for name = "Project2")
```
[
{
"Category": String,
"Completed": boolean,
"Description": String,
"End_Date": DateString,
"Git_Link": String:Link,
"Image": Blob,
"Members": Comma-separated array,
"Name": String,
"PM": String,
"Start_Date": DateString
}
{
Category: 'Web_project',
Completed: true,
Description: 'TestDesc',
End_Date: '2022-5-12T00:00-07:00',
Git_link: 'link',
Image: 'Image',
Members: 'Billy,Joe',
Name: 'Project2',
PM: 'Joe',
Start_Date: '2021-8-24T00:00-07:00'
}
...
]
```

* **Error Response:**
Errors will be outputted into console

* **Error Response:**
Errors will be outputted into console

0 comments on commit d0e2ebe

Please sign in to comment.