Pacticipants
Pacticipant​
Path: /pacticipants/:pacticipant_name
Allowed methods: GET, PUT, PATCH, DELETE
GET​
Request​
Headers: {"Accept":"application/hal+json"}
Response​
Status: 200
Headers: {"Content-Type":"application/hal+json;charset=utf-8"}
Body:
{
"name": "foo",
"displayName": "Foo",
"repositoryUrl": "https://github.com/example-organization/foo",
"createdAt": "2021-09-01T00:07:21+00:00",
"_embedded": {
"latestVersion": {
"number": "3e1f00a04",
"_links": {
"self": {
"title": "Version",
"name": "3e1f00a04",
"href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
}
}
},
"labels": [
]
},
"_links": {
"self": {
"href": "https://pact-broker/pacticipants/foo"
},
"pb:versions": {
"href": "https://pact-broker/pacticipants/foo/versions"
},
"pb:version": {
"title": "Get, create or delete a pacticipant version",
"href": "https://pact-broker/pacticipants/foo/versions/{version}",
"templated": true
},
"pb:version-tag": {
"title": "Get, create or delete a tag for a version of foo",
"href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
"templated": true
},
"pb:branch-version": {
"title": "Get or add/create a version for a branch of foo",
"href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
"templated": true
},
"pb:label": {
"title": "Get, create or delete a label for foo",
"href": "https://pact-broker/pacticipants/foo/labels/{label}",
"templated": true
},
"pb:can-i-deploy-badge": {
"title": "Can I Deploy foo badge",
"href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
"templated": true
},
"pb:can-i-deploy-branch-to-environment-badge": {
"title": "Can I Deploy foo from branch to environment badge",
"href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
"templated": true
},
"curies": [
{
"name": "pb",
"href": "https://pact-broker/doc/{rel}?context=pacticipant",
"templated": true
}
]
}
}
PUT​
PUT replaces the entire resource with the specified body, so missing properties will effectively be nulled. Embedded properties (eg. versions) will not be affected.
Request​
Headers: {"Content-Type":"application/json","Accept":"application/hal+json"}
Body:
{
"displayName": "Foo",
"repositoryUrl": "https://github.com/example/foo",
"repositoryName": "foo",
"repositoryNamespace": "example",
"mainBranch": "main"
}
Response​
Status: 200
Headers: {"Content-Type":"application/hal+json;charset=utf-8"}
Body:
{
"name": "foo",
"displayName": "Foo",
"repositoryUrl": "https://github.com/example/foo",
"repositoryName": "foo",
"repositoryNamespace": "example",
"mainBranch": "main",
"createdAt": "2021-09-01T00:07:21+00:00",
"_embedded": {
"latestVersion": {
"number": "3e1f00a04",
"_links": {
"self": {
"title": "Version",
"name": "3e1f00a04",
"href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
}
}
},
"labels": [
]
},
"_links": {
"self": {
"href": "https://pact-broker/pacticipants/foo"
},
"pb:versions": {
"href": "https://pact-broker/pacticipants/foo/versions"
},
"pb:version": {
"title": "Get, create or delete a pacticipant version",
"href": "https://pact-broker/pacticipants/foo/versions/{version}",
"templated": true
},
"pb:version-tag": {
"title": "Get, create or delete a tag for a version of foo",
"href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
"templated": true
},
"pb:branch-version": {
"title": "Get or add/create a version for a branch of foo",
"href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
"templated": true
},
"pb:label": {
"title": "Get, create or delete a label for foo",
"href": "https://pact-broker/pacticipants/foo/labels/{label}",
"templated": true
},
"pb:can-i-deploy-badge": {
"title": "Can I Deploy foo badge",
"href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
"templated": true
},
"pb:can-i-deploy-branch-to-environment-badge": {
"title": "Can I Deploy foo from branch to environment badge",
"href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
"templated": true
},
"curies": [
{
"name": "pb",
"href": "https://pact-broker/doc/{rel}?context=pacticipant",
"templated": true
}
]
}
}
PATCH​
PATCH with the Content-Type application/merge-patch+json merges the pacticipant's existing properties with those from the request body. Embedded properties (eg. versions) will not be affected.
Request​
Headers: {"Content-Type":"application/merge-patch+json","Accept":"application/hal+json"}
Body:
{
"displayName": "Foo",
"repositoryUrl": "https://github.com/example/foo",
"repositoryName": "foo",
"repositoryNamespace": "example",
"mainBranch": "main"
}
Response​
Status: 200
Headers: {"Content-Type":"application/hal+json;charset=utf-8"}
Body:
{
"name": "foo",
"displayName": "Foo",
"repositoryUrl": "https://github.com/example/foo",
"repositoryName": "foo",
"repositoryNamespace": "example",
"mainBranch": "main",
"createdAt": "2021-09-01T00:07:21+00:00",
"_embedded": {
"latestVersion": {
"number": "3e1f00a04",
"_links": {
"self": {
"title": "Version",
"name": "3e1f00a04",
"href": "https://pact-broker/pacticipants/foo/versions/3e1f00a04"
}
}
},
"labels": [
]
},
"_links": {
"self": {
"href": "https://pact-broker/pacticipants/foo"
},
"pb:versions": {
"href": "https://pact-broker/pacticipants/foo/versions"
},
"pb:version": {
"title": "Get, create or delete a pacticipant version",
"href": "https://pact-broker/pacticipants/foo/versions/{version}",
"templated": true
},
"pb:version-tag": {
"title": "Get, create or delete a tag for a version of foo",
"href": "https://pact-broker/pacticipants/foo/versions/{version}/tags/{tag}",
"templated": true
},
"pb:branch-version": {
"title": "Get or add/create a version for a branch of foo",
"href": "https://pact-broker/pacticipants/foo/branches/{branch}/versions/{version}",
"templated": true
},
"pb:label": {
"title": "Get, create or delete a label for foo",
"href": "https://pact-broker/pacticipants/foo/labels/{label}",
"templated": true
},
"pb:can-i-deploy-badge": {
"title": "Can I Deploy foo badge",
"href": "https://pact-broker/pacticipants/foo/latest-version/{tag}/can-i-deploy/to/{environmentTag}/badge",
"templated": true
},
"pb:can-i-deploy-branch-to-environment-badge": {
"title": "Can I Deploy foo from branch to environment badge",
"href": "https://pact-broker/pacticipants/foo/branches/{branch}/latest-version/can-i-deploy/to-environment/{environment}/badge",
"templated": true
},
"curies": [
{
"name": "pb",
"href": "https://pact-broker/doc/{rel}?context=pacticipant",
"templated": true
}
]
}
}