docs: update webhook docs

pact-foundation · Oct 6, 2021 · cb68a4a · cb68a4a
1 parent 27259f9
commit cb68a4a
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 4 deletions.
diff --git a/docs/api/WEBHOOKS.md b/docs/api/WEBHOOKS.md
@@ -88,6 +88,7 @@ Body:
 
 ```
 {
+  "description": "an example webhook",
   "events": [
     {
       "name": "contract_content_changed"
@@ -214,6 +215,7 @@ Body:
 
 ```
 {
+  "description": "an example webhook",
   "events": [
     {
       "name": "contract_content_changed"
@@ -244,7 +246,7 @@ Body:
 ```
 {
   "uuid": "dCGCl-Ba3PqEFJ_iE9mJkQ",
-  "description": "POST example.org",
+  "description": "an example webhook",
   "enabled": true,
   "request": {
     "method": "POST",
@@ -266,7 +268,7 @@ Body:
   "createdAt": "2021-09-01T00:07:21+00:00",
   "_links": {
     "self": {
-      "title": "POST example.org",
+      "title": "an example webhook",
       "href": "http://example.org/webhooks/dCGCl-Ba3PqEFJ_iE9mJkQ"
     },
     "pb:execute": {
@@ -614,6 +616,7 @@ Body:
 
 ```
 {
+  "description": "an example webhook",
   "events": [
     {
       "name": "contract_content_changed"

diff --git a/spec/fixtures/approvals/docs_webhooks_executing_an_unsaved_webhook_post.approved.json b/spec/fixtures/approvals/docs_webhooks_executing_an_unsaved_webhook_post.approved.json
@@ -11,6 +11,7 @@
       "Accept": "application/hal+json"
     },
     "body": {
+      "description": "an example webhook",
       "events": [
         {
           "name": "contract_content_changed"

diff --git a/spec/fixtures/approvals/docs_webhooks_webhook_put.approved.json b/spec/fixtures/approvals/docs_webhooks_webhook_put.approved.json
@@ -11,6 +11,7 @@
       "Accept": "application/hal+json"
     },
     "body": {
+      "description": "an example webhook",
       "events": [
         {
           "name": "contract_content_changed"

diff --git a/spec/fixtures/approvals/docs_webhooks_webhooks_post.approved.json b/spec/fixtures/approvals/docs_webhooks_webhooks_post.approved.json
@@ -11,6 +11,7 @@
       "Accept": "application/hal+json"
     },
     "body": {
+      "description": "an example webhook",
       "events": [
         {
           "name": "contract_content_changed"
@@ -38,7 +39,7 @@
     },
     "body": {
       "uuid": "dCGCl-Ba3PqEFJ_iE9mJkQ",
-      "description": "POST example.org",
+      "description": "an example webhook",
       "enabled": true,
       "request": {
         "method": "POST",
@@ -60,7 +61,7 @@
       "createdAt": "2021-09-01T00:07:21+00:00",
       "_links": {
         "self": {
-          "title": "POST example.org",
+          "title": "an example webhook",
           "href": "http://example.org/webhooks/dCGCl-Ba3PqEFJ_iE9mJkQ"
         },
         "pb:execute": {

diff --git a/spec/integration/webhooks_documentation_spec.rb b/spec/integration/webhooks_documentation_spec.rb
@@ -56,6 +56,7 @@
 
   let(:webhook_hash) do
     {
+      "description" => "an example webhook",
       "events" => [{
         "name" => "contract_content_changed"
       }],