Skip to content

Add $schema to pact files #476

@mefellows

Description

@mefellows

Adding the $schema keyword to JSON files provides additional support for the comprehension of pact files. For example, most IDEs will provide auto-completion and documentation. Adding a schema will help tool builders who wish to parse, manipulate or otherwise handle pact files in an unobtrusive way.

For each pact specification, we publish JSON Schemas to describe their shape (they could do with some additional human-readable descriptions).

Example:

Screenshot 2024-11-28 at 9 32 46 AM Screenshot 2024-11-28 at 9 33 16 AM

We may also wish to add $id, but I don't believe this is strictly necessary to get the benefit we're after.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementIndicates new feature requests

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions