sidebars.json

{
  "docs": [
     "implementation_guides/overview",
    {
      "Pact command line tools": ["implementation_guides/cli"]
    },
    {
      "Pact JS": [
        "implementation_guides/javascript/readme",
        "implementation_guides/javascript/docs/consumer",
        "implementation_guides/javascript/docs/matching",
        "implementation_guides/javascript/docs/provider",
        "implementation_guides/javascript/docs/messages",
        "implementation_guides/javascript/docs/graphql",
        "implementation_guides/javascript/docs/xml",
        "implementation_guides/javascript/docs/troubleshooting",
        "implementation_guides/javascript/docs/migrations/9-10",
        "implementation_guides/javascript/changelog",
        "implementation_guides/javascript/contributing"
      ]
    },
    {
      "Pact JVM": [
        "implementation_guides/jvm",
        "implementation_guides/jvm/readme",
        "implementation_guides/jvm/matching",
        {
          "type": "category",
          "label": "Consumer",
          "items": [
            "implementation_guides/jvm/consumer/junit",
            "implementation_guides/jvm/consumer/junit5",
            "implementation_guides/jvm/consumer",
            "implementation_guides/jvm/consumer/specs2",
            "implementation_guides/jvm/consumer/groovy"
          ]
        },
        {
          "type": "category",
          "label": "Provider",
          "items": [
            "implementation_guides/jvm/provider/spring6",
            "implementation_guides/jvm/provider/junit5spring",
            "implementation_guides/jvm/provider/junit",
            "implementation_guides/jvm/provider/maven",
            "implementation_guides/jvm/provider/gradle",
            "implementation_guides/jvm/provider/junit5",
            "implementation_guides/jvm/provider",
            "implementation_guides/jvm/provider/sbt",
            "implementation_guides/jvm/provider/lein",
            "implementation_guides/jvm/provider/spring",
            "implementation_guides/jvm/provider/scalatest",
            "implementation_guides/jvm/provider/specs2"
          ]
        },
        "implementation_guides/jvm/pact-jvm-server",
        "implementation_guides/jvm/changelog",
        "implementation_guides/jvm/docs/system-properties"
      ]
    },
    {
      "Pact Net": [
        "implementation_guides/net",
        "implementation_guides/net/readme",
        "implementation_guides/net/docs/messaging-pacts",
        "implementation_guides/net/docs/upgrading-to-4",
        "implementation_guides/net/docs/upgrading-to-5"
      ]
    },
    {
      "Pact Go": [
        "implementation_guides/go",
        "implementation_guides/go/readme",
        "implementation_guides/go/docs/consumer",
        "implementation_guides/go/docs/provider",
        "implementation_guides/go/docs/messages",
        "implementation_guides/go/docs/examples",
        "implementation_guides/go/docs/troubleshooting",
        "implementation_guides/go/migration",
        "implementation_guides/go/changelog"
      ]
    },
    {
      "Pact Python": [
        "implementation_guides/python",
        "implementation_guides/python/readme",
        "implementation_guides/python/docs/consumer",
        "implementation_guides/python/docs/provider",
        "implementation_guides/python/examples/index",
        "implementation_guides/python/changelog"
      ]
    },
    {
      "Pact Swift": ["implementation_guides/swift"]
    },
    {
      "Pact Scala": ["implementation_guides/scala"]
    },
    {
      "Pact PHP": [
        "implementation_guides/php/readme",
        "implementation_guides/php/upgrade-10.0",
        "implementation_guides/php/docs/consumer",
        "implementation_guides/php/docs/provider",
        "implementation_guides/php/docs/messages",
        "implementation_guides/php/docs/additional-examples",
        "implementation_guides/php/docs/stub-server",
        "implementation_guides/php/docs/framework-integrations",
        "implementation_guides/php/docs/releasing",
        "implementation_guides/php/docs/software-history"
      ]
    },
    {
      "Pact Ruby": [
        "implementation_guides/ruby/README",
        "implementation_guides/ruby/creating_pacts",
        "implementation_guides/ruby/matching",
        "implementation_guides/ruby/publishing_pacts",
        "implementation_guides/ruby/verifying_pacts",
        "implementation_guides/ruby/provider_states",
        "implementation_guides/ruby/configuration",
        "implementation_guides/ruby/gotchas"
      ]
    },
    {
      "Pact Rust": [
        "implementation_guides/rust",
        "implementation_guides/rust/pact_consumer",
        "implementation_guides/rust/pact_matching",
        "implementation_guides/rust/pact_mock_server",
        "implementation_guides/rust/pact_mock_server_cli",
        "implementation_guides/rust/pact_mock_server_ffi",
        "implementation_guides/rust/pact_verifier",
        "implementation_guides/rust/pact_verifier_cli",
        {
          "type": "category",
          "label": "Changelogs",
          "items": [
            "implementation_guides/rust/pact_consumer/changelog",
            "implementation_guides/rust/pact_matching/changelog",
            "implementation_guides/rust/pact_mock_server/changelog",
            "implementation_guides/rust/pact_mock_server_cli/changelog",
            "implementation_guides/rust/pact_mock_server_ffi/changelog",
            "implementation_guides/rust/pact_verifier/changelog",
            "implementation_guides/rust/pact_verifier_cli/changelog"
          ]
        }
      ]
    },
    {
      "Pact C++": [
        "implementation_guides/cpp",
        "implementation_guides/cpp/consumer",
        "implementation_guides/cpp/consumer/changelog"
      ]
    },
    {
      "Pact on Docker": ["docker"]
    },
    {
      "Pact Plugins": [
        "implementation_guides/pact_plugins/readme",
        {
          "CLI Tool": [
            "implementation_guides/pact_plugins/cli/readme",
            "implementation_guides/pact_plugins/cli/changelog"
          ]
        },
        {
          "Plugin Docs": [
            "implementation_guides/pact_plugins/docs/plugin-driver-design",
            "implementation_guides/pact_plugins/docs/content-matcher-design",
            "implementation_guides/pact_plugins/docs/matching-rule-definition-expressions",
            "implementation_guides/pact_plugins/docs/protocol-plugin-design",
            "implementation_guides/pact_plugins/docs/writing-plugin-guide"
          ]
        },
        {
          "Drivers": [
            {
              "rust": [
                "implementation_guides/pact_plugins/drivers/rust/driver/readme",
                "implementation_guides/pact_plugins/drivers/rust/driver/changelog"
              ]
            },
            {
              "jvm": [
                "implementation_guides/pact_plugins/drivers/jvm/readme",
                "implementation_guides/pact_plugins/drivers/jvm/changelog"
              ]
            }
          ]
        },
        {
          "Examples": [
            {
              "csv": ["implementation_guides/pact_plugins/examples/csv/readme"]
            },
            {
              "gRPC": [
                "implementation_guides/pact_plugins/examples/grpc/readme",
                "implementation_guides/pact_plugins/examples/grpc/area_calculator/readme",

                {
                  "go": [
                    "implementation_guides/pact_plugins/examples/grpc/area_calculator/consumer-go/readme",
                    "implementation_guides/pact_plugins/examples/grpc/area_calculator/provider-go/readme"
                  ]
                },
                {
                  "rust": [
                    "implementation_guides/pact_plugins/examples/grpc/area_calculator/consumer-rust/readme"
                  ]
                },
                {
                  "jvm": [
                    "implementation_guides/pact_plugins/examples/grpc/area_calculator/consumer-jvm/readme",
                    "implementation_guides/pact_plugins/examples/grpc/area_calculator/provider-jvm/readme"
                  ]
                }
              ]
            },
            {
              "protobuf": [
                "implementation_guides/pact_plugins/examples/protobuf/readme",
                {
                  "go": [
                    "implementation_guides/pact_plugins/examples/protobuf/protobuf-provider/readme"
                  ]
                },
                {
                  "rust": [
                    "implementation_guides/pact_plugins/examples/protobuf/protobuf-consumer-rust/readme"
                  ]
                },
                {
                  "jvm": [
                    "implementation_guides/pact_plugins/examples/protobuf/protobuf-consumer-jvm/readme"
                  ]
                }
              ]
            }
          ]
        },
        {
          "Plugins": [
            "implementation_guides/pact_plugins/plugins/readme",
            "implementation_guides/pact_plugins/plugins/csv/readme",
            "implementation_guides/pact_plugins/plugins/protobuf/readme"
          ]
        }
      ]
    },
    {
      "Other languages": ["implementation_guides/other_languages"]
    },
    {
      "Feature support": [
        "roadmap/feature_support",
        "roadmap/roadmap",
        "wrapper_implementations"
      ]
    },
    {
      "Stubs": ["getting_started/stubs"]
    },
    "telemetry",
    "implementation_guides/ssl"
  ],
  "getting-started": [
    {
      "type": "category",
      "label": "Getting started",
      "items": [
        "getting_started",
        "getting_started/how_pact_works",
        "5-minute-getting-started-guide",
        { "id": "plugins/quick_start", "type": "doc", "label": "Pact Plugins" }
      ]
    },
    {
      "Should you use Pact?": [
        "getting_started/what_is_pact_good_for",
        "getting_started/comparisons",
        "faq/convinceme"
      ]
    },
    {
      "Pact concepts": [
        "getting_started/conceptual_overview",
        "getting_started/terminology",
        "getting_started/testing-scope",
        {
          "type": "category",
          "label": "Matching",
          "items": [
            "getting_started/matching",
            "getting_started/matching/gotchas"
          ]
        },
        "getting_started/verifying_pacts",
        "getting_started/provider_states",
        "getting_started/sharing_pacts",
        "getting_started/specification",
        "getting_started/further_reading"
      ]
    },
    "implementation_guides/workshops",
    "faq"
  ],
  "guides": {
    "Consumer": [
      "consumer",
      "consumer/contract_tests_not_functional_tests",
      "consumer/using_pact_to_support_ui_testing",
      "consumer/recommended_configuration"
    ],
    "Provider": [
      "provider",
      "provider/using_provider_states_effectively",
      "provider/handling_auth",
      "provider/recommended_configuration",
      "provider/how_to_fix_failing_verification_tests"
    ],
    "CI/CD Setup Guide": [
      "pact_nirvana",
      "pact_nirvana/step_1",
      "pact_nirvana/step_2",
      "pact_nirvana/step_3",
      "pact_nirvana/step_4",
      "pact_nirvana/step_5",
      "pact_nirvana/step_6",
      "pact_nirvana/step_7",
      "pact_nirvana/notes_1"
    ],
    "Recipes": [
      "recipes",
      "recipes/kafka",
      "recipes/graphql",
      "recipes/apigateway",
      "recipes/awssignedrequests",
      "recipes/lambdaasync",
      "recipes/lambdahttp",
      "recipes/cypress",
      "recipes/munit",
      "implementation_guides/feature_toggles"
    ],
    "Ecosystems":
    ["diagrams/ecosystem"]
  },
  "pact_broker": {
    "Pact Broker": [
      "pact_broker",
      "pact_broker/overview",
      "getting_started/versioning_in_the_pact_broker",
      "pact_broker/publishing_and_retrieving_pacts",
      "pact_broker/branches",
      "pact_broker/recording_deployments_and_releases",
      "pact_broker/tags",
      {
        "type": "category",
        "label": "Webhooks",
        "items": [
          "pact_broker/webhooks",
          "pact_broker/webhooks/template_library",
          "pact_broker/webhooks/debugging_webhooks",
          "pact_broker/webhooks/webhook_whitelist",
          "pact_broker/webhooks/dynamic_variable_sub"
        ]
      },
      "pact_broker/can_i_deploy",
      "pact_broker/set_up_checklist",
      "pact_broker/terraform_provider",
      "pact_broker/upgrading",
      "pact_broker/breaking_changes",
      "pact_broker/network_graph",
      {
        "type": "category",
        "label": "Configuration",
        "items": [
          "pact_broker/configuration/features",
          "pact_broker/configuration/settings",
          "pact_broker/advanced_topics/using-tls"
        ]
      },
      {
        "type": "category",
        "label": "Administration",
        "items": [
          "pact_broker/administration",
          "pact_broker/administration/maintenance",
          "pact_broker/administration/deleting_resources"
        ]
      },
      {
        "type": "category",
        "label": "Advanced Topics",
        "items": [
          "pact_broker/pacticipant_version_numbers",
          "pact_broker/advanced_topics/see_changes_pact",
          "pact_broker/advanced_topics/provider_verification_badges",
          "pact_broker/advanced_topics/provider_verification_results",
          "pact_broker/advanced_topics/pacticipant",
          "pact_broker/advanced_topics/pending_pacts",
          "pact_broker/advanced_topics/wip_pacts",
          "pact_broker/advanced_topics/consumer_version_selectors",
          "pact_broker/advanced_topics/matrix_selectors",
          "pact_broker/advanced_topics/api_docs",
          "pact_broker/advanced_topics/ui_docs",
          "pact_broker/advanced_topics/troubleshooting"
        ]
      },
      {
        "type": "category",
        "label": "API Docs",
        "items": ["pact_broker/api/webhooks", "pact_broker/api/pacticipants", "pact_broker/api/pagination"]
      },
      "pact_broker/changelog"
    ],
    "Pact Broker Client CLI": [
      "pact_broker/client_cli",
      "pact_broker/client_cli/readme",
      "pact_broker/client_cli/changelog"
    ],
    "Pact Broker - Docker": [
      "pact_broker/docker_images",
      "pact_broker/docker_images/pactfoundation"
    ],
    "Pact Broker - Kubernetes": [
      "pact_broker/kubernetes",
      "pact_broker/kubernetes/readme"
    ]
  },
  "resources": [
    "history",
    "blogs_videos_and_articles",
    "community_repos",
    "books",
    {
      "Events": [
        "events",
        {
          "Webinars and Workshops": ["events/plugins-framework-workshop", "events/plugins-framework-launch"]
        }
      ]
    },
    {
      "Pact Plugins": [
        { "id": "plugins/quick_start", "type": "doc", "label": "Quick Start" },
        "plugins/directory"
      ]
    },
    {
      "Contributing": [
        "contributing",
        "contributing/code",
        "contributing/ci",
        "contributing/docs",
        "contributing/contributors",
        "contributing/code-of-conduct"
      ]
    },
    {
      "Case Studies & Users": [
        "users/testimonials",
        "users/trustedby",
        {
          "Case Studies": [
            "users/case_studies",
            "users/case_studies/case_study_govuk",
            "users/case_studies/case_study_atlassian",
            "users/case_studies/case_study_boostinsurance",
            "users/case_studies/case_study_m1finance"
          ],
          "Community Corner": [
            "users/community_corner/adam_cox_interview_may2023"
          ]
        }
      ]
    }
  ],
  "university": [
    {
      "type": "category",
      "label": "Pact University",
      "items": [
        "university",
        {
          "type": "category",
          "label": "Introduction to Pact",
          "items": [
            "university/introduction/00_1_Intro",
            "university/introduction/00_2_Outline",
            "university/introduction/00_3_LearningObjectives",
            "university/introduction/00_4_Requirements",
            "university/introduction/00_5_Scenario",
            "university/introduction/Step1",
            "university/introduction/Step2",
            "university/introduction/Step3",
            "university/introduction/Step4",
            "university/introduction/Step5",
            "university/introduction/Step6",
            "university/introduction/Step7",
            "university/introduction/Step8",
            "university/introduction/Step9",
            "university/introduction/Step10",
            "university/introduction/Step11",
            "university/introduction/Step12",
            "university/introduction/Step13"
          ]
        },
        {
          "type": "category",
          "label": "Introduction to Message Pact - Async",
          "items": [
            "university/message-pact-async/00_1_Intro",
            "university/message-pact-async/00_2_Outline",
            "university/message-pact-async/00_3_LearningObjectives",
            "university/message-pact-async/00_4_Requirements",
            "university/message-pact-async/00_5_Scenario",
            "university/message-pact-async/Step1",
            "university/message-pact-async/Step2",
            "university/message-pact-async/Step3",
            "university/message-pact-async/Step4"
          ]
        },
        {
          "type": "category",
          "label": "Pact Plugins",
          "items": [
            {
              "Create a Plugin": [
                "plugins/workshops/create-a-plugin/intro",
                "plugins/workshops/create-a-plugin/step1",
                "plugins/workshops/create-a-plugin/step2",
                "plugins/workshops/create-a-plugin/step3",
                "plugins/workshops/create-a-plugin/step4",
                "plugins/workshops/create-a-plugin/step5",
                "plugins/workshops/create-a-plugin/step6",
                "plugins/workshops/create-a-plugin/step7"
              ]
            }
          ]
        }
      ]
    }
  ],
  "help": [
    {
      "type": "category",
      "label": "Help",
      "items": [
        "help",
        "help/how_to_ask_for_help",
        "help/amas",
        "help/enabling-debug-logging",
        "help/smartbear"
      ]
    }
  ]
}