-
-
Notifications
You must be signed in to change notification settings - Fork 178
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add HAL docs for pacticipant-branch
- Loading branch information
Showing
2 changed files
with
27 additions
and
0 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
lib/pact_broker/doc/views/index/pacticipant-branch.markdown
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Pacticipant branch | ||
|
||
Allowed methods: `GET`, `DELETE` | ||
|
||
Path: `/pacticipants/{pacticipant}/branches/{branch}` | ||
|
||
Get or delete a pacticipant branch. | ||
|
||
## Create | ||
|
||
Branches cannot be created via the resource URL. They are created automatically when publishing contracts. | ||
|
||
## Get | ||
|
||
### Example | ||
|
||
curl http://broker/pacticipants/Bar/branches/main -H "Accept: application/hal+json" | ||
|
||
## Delete | ||
|
||
Deletes a pacticipant branch. Does NOT delete the associated pacticipant versions. | ||
|
||
Send a `DELETE` request to the branch resource. | ||
|
||
curl -XDELETE http://broker/pacticipants/Bar/branches/main |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters