Skip to content

Commit 3533bc9

Browse files
committed
update README
1 parent bf3ef7f commit 3533bc9

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@ Pagination Headers Returned:
6464
- `x-next-page` number of next page (omitted if last page)
6565
- `x-last-page` number of last page
6666

67-
```
67+
6868
```
6969
GET ​ /api​/v1​/engagements​/customer​/{customer}​/{engagement}
7070
```
7171
Returns the engagement associated with the customer and engagement name combination.
72-
```
72+
7373
```
7474
GET ​/api​/v1​/engagements​/customer​/{customer}​/{engagement}​/commits
7575
```
@@ -95,6 +95,22 @@ DELETE ​/api​/v1​/engagements​/hooks
9595
```
9696
Deletes all webhooks in all configured engagement projects.
9797

98+
### Engagement / Project Mapping
99+
100+
This resource exposes APIs that relates engagement uuids to project ids
101+
102+
```
103+
GET /api/v1/engagements/projects
104+
```
105+
106+
Returns a full list of projects and associated engagement uuid. (uuid is null if not set although it should always be set)
107+
108+
```
109+
GET /api/v1/engagements/projects/{uuid}
110+
```
111+
112+
Returns project information including project id for the uuid specified.
113+
98114
### Version Resource
99115

100116
The version resource exposes an API that allows a client to determine which version of the application is deployed.

0 commit comments

Comments
 (0)