pact_broker 2.85.0 → 2.88.0

data/spec/fixtures/approvals/docs_webhooks_triggered_webhooks_for_pact_publication_get.approved.json

@@ -0,0 +1,52 @@
+{
+  "category": "Webhooks",
+  "name": "Triggered webhooks for pact publication",
+  "order": 41,
+  "request": {
+    "method": "GET",
+    "path_template": "/pacts/provider/:provider_name/consumer/:consumer_name/version/:consumer_version_number/triggered-webhooks",
+    "path": "/pacts/provider/Bar/consumer/Foo/version/2/triggered-webhooks",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "_embedded": {
+        "triggeredWebhooks": [
+          {
+            "name": "POST example.org",
+            "status": "not_run",
+            "attemptsMade": 1,
+            "attemptsRemaining": 6,
+            "triggerType": "resource_creation",
+            "eventName": "contract_content_changed",
+            "triggeredAt": "2021-09-01T00:07:21+00:00",
+            "_links": {
+              "pb:logs": {
+                "href": "http://example.org/triggered-webhooks/6cd5cc48-db3c-4a4c-a36d-e9bedeb9d91e/logs",
+                "title": "Webhook execution logs",
+                "name": "POST example.org"
+              },
+              "pb:webhook": {
+                "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+                "title": "Webhook",
+                "name": "POST example.org"
+              }
+            }
+          }
+        ]
+      },
+      "_links": {
+        "self": {
+          "title": "Webhooks triggered by the publication of the pact between Foo (2) and Bar",
+          "href": "http://example.org/pacts/provider/Bar/consumer/Foo/version/2/triggered-webhooks"
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_triggered_webhooks_for_pact_publication_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Triggered webhooks for pact publication",
+  "order": 43,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/pacts/provider/:provider_name/consumer/:consumer_name/version/:consumer_version_number/triggered-webhooks",
+    "path": "/pacts/provider/Bar/consumer/Foo/version/2/triggered-webhooks",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "GET, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_triggered_webhooks_for_verification_publication_get.approved.json

@@ -0,0 +1,32 @@
+{
+  "category": "Webhooks",
+  "name": "Triggered webhooks for verification publication",
+  "order": 45,
+  "request": {
+    "method": "GET",
+    "path_template": "/pacts/provider/:provider_name/consumer/:consumer_name/pact-version/:pact_version_sha/verification-results/:verification_number/triggered-webhooks",
+    "path": "/pacts/provider/Bar/consumer/Foo/pact-version/3e193ecb37ad04b43ce974a38352c704b2e0ed6b/verification-results/1/triggered-webhooks",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "_embedded": {
+        "triggeredWebhooks": [
+
+        ]
+      },
+      "_links": {
+        "self": {
+          "title": "Webhooks triggered by the publication of verification result 1",
+          "href": "http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/3e193ecb37ad04b43ce974a38352c704b2e0ed6b/verification-results/1/triggered-webhooks"
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_triggered_webhooks_for_verification_publication_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Triggered webhooks for verification publication",
+  "order": 47,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/pacts/provider/:provider_name/consumer/:consumer_name/pact-version/:pact_version_sha/verification-results/:verification_number/triggered-webhooks",
+    "path": "/pacts/provider/Bar/consumer/Foo/pact-version/3e193ecb37ad04b43ce974a38352c704b2e0ed6b/verification-results/1/triggered-webhooks",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "GET, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhook_get.approved.json

@@ -0,0 +1,74 @@
+{
+  "category": "Webhooks",
+  "name": "Webhook",
+  "order": 1,
+  "request": {
+    "method": "GET",
+    "path_template": "/webhooks/:uuid",
+    "path": "/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "uuid": "d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+      "description": "an example webhook",
+      "consumer": {
+        "name": "Foo"
+      },
+      "provider": {
+        "name": "Bar"
+      },
+      "enabled": true,
+      "request": {
+        "method": "POST",
+        "url": "https://example.org/example",
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "body": {
+          "pactUrl": "${pactbroker.pactUrl}"
+        }
+      },
+      "events": [
+        {
+          "name": "contract_content_changed"
+        }
+      ],
+      "createdAt": "2021-09-01T00:07:21+00:00",
+      "_links": {
+        "self": {
+          "title": "an example webhook",
+          "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac"
+        },
+        "pb:execute": {
+          "title": "Test the execution of the webhook with the latest matching pact or verification by sending a POST request to this URL",
+          "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac/execute"
+        },
+        "pb:consumer": {
+          "title": "Consumer",
+          "name": "Foo",
+          "href": "http://example.org/pacticipants/Foo"
+        },
+        "pb:provider": {
+          "title": "Provider",
+          "name": "Bar",
+          "href": "http://example.org/pacticipants/Bar"
+        },
+        "pb:pact-webhooks": {
+          "title": "All webhooks for consumer Foo and provider Bar",
+          "href": "http://example.org/webhooks/provider/Bar/consumer/Foo"
+        },
+        "pb:webhooks": {
+          "title": "All webhooks",
+          "href": "http://example.org/webhooks"
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhook_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Webhook",
+  "order": 5,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/webhooks/:uuid",
+    "path": "/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "GET, PUT, DELETE, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhook_put.approved.json

@@ -0,0 +1,77 @@
+{
+  "category": "Webhooks",
+  "name": "Webhook",
+  "order": 3,
+  "request": {
+    "method": "PUT",
+    "path_template": "/webhooks/:uuid",
+    "path": "/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+    "headers": {
+      "Content-Type": "application/json",
+      "Accept": "application/hal+json"
+    },
+    "body": {
+      "description": "an example webhook",
+      "events": [
+        {
+          "name": "contract_content_changed"
+        }
+      ],
+      "request": {
+        "method": "POST",
+        "url": "https://example.org/example",
+        "username": "username",
+        "password": "password",
+        "headers": {
+          "Accept": "application/json"
+        },
+        "body": {
+          "pactUrl": "${pactbroker.pactUrl}"
+        }
+      }
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "uuid": "d2181b32-8b03-4daf-8cc0-d9168b2f6fac",
+      "description": "an example webhook",
+      "enabled": true,
+      "request": {
+        "method": "POST",
+        "url": "https://example.org/example",
+        "headers": {
+          "Accept": "application/json"
+        },
+        "body": {
+          "pactUrl": "${pactbroker.pactUrl}"
+        },
+        "username": "username",
+        "password": "**********"
+      },
+      "events": [
+        {
+          "name": "contract_content_changed"
+        }
+      ],
+      "createdAt": "2021-09-01T00:07:21+00:00",
+      "_links": {
+        "self": {
+          "title": "an example webhook",
+          "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac"
+        },
+        "pb:execute": {
+          "title": "Test the execution of the webhook with the latest matching pact or verification by sending a POST request to this URL",
+          "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac/execute"
+        },
+        "pb:webhooks": {
+          "title": "All webhooks",
+          "href": "http://example.org/webhooks"
+        }
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_for_a_provider_get.approved.json

@@ -0,0 +1,41 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks for a provider",
+  "order": 17,
+  "request": {
+    "method": "GET",
+    "path_template": "/webhooks/provider/:provider_name",
+    "path": "/webhooks/provider/Bar",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "_links": {
+        "self": {
+          "title": "Webhooks",
+          "href": "http://example.org/webhooks/provider/Bar"
+        },
+        "pb:create": {
+          "title": "POST to create a webhook",
+          "href": "http://example.org/webhooks/provider/Bar"
+        },
+        "pb:webhooks": [
+
+        ],
+        "curies": [
+          {
+            "name": "pb",
+            "href": "http://example.org/doc/webhooks-{rel}",
+            "templated": true
+          }
+        ]
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_for_a_provider_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks for a provider",
+  "order": 19,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/webhooks/provider/:provider_name",
+    "path": "/webhooks/provider/Bar",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "POST, GET, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_for_consumer_and_provider_get.approved.json

@@ -0,0 +1,45 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks for consumer and provider",
+  "order": 21,
+  "request": {
+    "method": "GET",
+    "path_template": "/webhooks/provider/:provider_name/consumer/:consumer_name",
+    "path": "/webhooks/provider/Bar/consumer/Foo",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "_links": {
+        "self": {
+          "title": "Webhooks",
+          "href": "http://example.org/webhooks/provider/Bar/consumer/Foo"
+        },
+        "pb:create": {
+          "title": "POST to create a webhook",
+          "href": "http://example.org/webhooks/provider/Bar/consumer/Foo"
+        },
+        "pb:webhooks": [
+          {
+            "title": "A webhook for the pact between Foo and Bar",
+            "name": "an example webhook",
+            "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac"
+          }
+        ],
+        "curies": [
+          {
+            "name": "pb",
+            "href": "http://example.org/doc/webhooks-{rel}",
+            "templated": true
+          }
+        ]
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_for_consumer_and_provider_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks for consumer and provider",
+  "order": 23,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/webhooks/provider/:provider_name/consumer/:consumer_name",
+    "path": "/webhooks/provider/Bar/consumer/Foo",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "POST, GET, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_for_consumer_get.approved.json

@@ -0,0 +1,41 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks for consumer",
+  "order": 13,
+  "request": {
+    "method": "GET",
+    "path_template": "/webhooks/consumer/:consumer_name",
+    "path": "/webhooks/consumer/Foo",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "_links": {
+        "self": {
+          "title": "Webhooks",
+          "href": "http://example.org/webhooks/consumer/Foo"
+        },
+        "pb:create": {
+          "title": "POST to create a webhook",
+          "href": "http://example.org/webhooks/consumer/Foo"
+        },
+        "pb:webhooks": [
+
+        ],
+        "curies": [
+          {
+            "name": "pb",
+            "href": "http://example.org/doc/webhooks-{rel}",
+            "templated": true
+          }
+        ]
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_for_consumer_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks for consumer",
+  "order": 15,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/webhooks/consumer/:consumer_name",
+    "path": "/webhooks/consumer/Foo",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "POST, GET, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_get.approved.json

@@ -0,0 +1,45 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks",
+  "order": 7,
+  "request": {
+    "method": "GET",
+    "path_template": "/webhooks",
+    "path": "/webhooks",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8"
+    },
+    "body": {
+      "_links": {
+        "self": {
+          "title": "Webhooks",
+          "href": "http://example.org/webhooks"
+        },
+        "pb:create": {
+          "title": "POST to create a webhook",
+          "href": "http://example.org/webhooks"
+        },
+        "pb:webhooks": [
+          {
+            "title": "A webhook for the pact between Foo and Bar",
+            "name": "an example webhook",
+            "href": "http://example.org/webhooks/d2181b32-8b03-4daf-8cc0-d9168b2f6fac"
+          }
+        ],
+        "curies": [
+          {
+            "name": "pb",
+            "href": "http://example.org/doc/webhooks-{rel}",
+            "templated": true
+          }
+        ]
+      }
+    }
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_options.approved.json

@@ -0,0 +1,20 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks",
+  "order": 11,
+  "request": {
+    "method": "OPTIONS",
+    "path_template": "/webhooks",
+    "path": "/webhooks",
+    "headers": {
+      "Accept": "application/hal+json"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Access-Control-Allow-Methods": "GET, POST, OPTIONS"
+    },
+    "body": ""
+  }
+}

data/spec/fixtures/approvals/docs_webhooks_webhooks_post.approved.json

@@ -0,0 +1,78 @@
+{
+  "category": "Webhooks",
+  "name": "Webhooks",
+  "order": 9,
+  "request": {
+    "method": "POST",
+    "path_template": "/webhooks",
+    "path": "/webhooks",
+    "headers": {
+      "Content-Type": "application/json",
+      "Accept": "application/hal+json"
+    },
+    "body": {
+      "description": "an example webhook",
+      "events": [
+        {
+          "name": "contract_content_changed"
+        }
+      ],
+      "request": {
+        "method": "POST",
+        "url": "https://example.org/example",
+        "username": "username",
+        "password": "password",
+        "headers": {
+          "Accept": "application/json"
+        },
+        "body": {
+          "pactUrl": "${pactbroker.pactUrl}"
+        }
+      }
+    }
+  },
+  "response": {
+    "status": 201,
+    "headers": {
+      "Content-Type": "application/hal+json;charset=utf-8",
+      "Location": "http://example.org/webhooks/dCGCl-Ba3PqEFJ_iE9mJkQ"
+    },
+    "body": {
+      "uuid": "dCGCl-Ba3PqEFJ_iE9mJkQ",
+      "description": "an example webhook",
+      "enabled": true,
+      "request": {
+        "method": "POST",
+        "url": "https://example.org/example",
+        "headers": {
+          "Accept": "application/json"
+        },
+        "body": {
+          "pactUrl": "${pactbroker.pactUrl}"
+        },
+        "username": "username",
+        "password": "**********"
+      },
+      "events": [
+        {
+          "name": "contract_content_changed"
+        }
+      ],
+      "createdAt": "2021-09-01T00:07:21+00:00",
+      "_links": {
+        "self": {
+          "title": "an example webhook",
+          "href": "http://example.org/webhooks/dCGCl-Ba3PqEFJ_iE9mJkQ"
+        },
+        "pb:execute": {
+          "title": "Test the execution of the webhook with the latest matching pact or verification by sending a POST request to this URL",
+          "href": "http://example.org/webhooks/dCGCl-Ba3PqEFJ_iE9mJkQ/execute"
+        },
+        "pb:webhooks": {
+          "title": "All webhooks",
+          "href": "http://example.org/webhooks"
+        }
+      }
+    }
+  }
+}