https://github.com/znsio/specmatic-order-contracts

Contracts for sample projects that use Specmatic to do contract driven development
https://github.com/znsio/specmatic-order-contracts

cdd specmatic

Last synced: about 1 month ago
JSON representation

Contracts for sample projects that use Specmatic to do contract driven development

• Host: GitHub
• URL: https://github.com/znsio/specmatic-order-contracts
• Owner: znsio
• License: mit
• Created: 2021-06-19T12:46:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T06:27:17.000Z (4 months ago)
• Last Synced: 2024-09-18T08:54:12.125Z (4 months ago)
• Topics: cdd, specmatic
• Language: Python
• Homepage:
• Size: 318 KB
• Stars: 6
• Watchers: 9
• Forks: 5
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: License.md

Awesome Lists containing this project

README

        
# Central Contract Repository for the Order API

## What is Central Contract Repository?

Please see **[Documentation](https://specmatic.io/documentation/central_contract_repository.html)**

---

This repository serves as the Central Contract Repository for the following API Specifications / Contracts 

* OpenAPI

* GraphQL

* gRPC

* Async API

These contracts govern interactions between sample applications which you can find here

* [Sample Projects](https://specmatic.io/documentation/sample_projects.html)

## Backward Compatibility Testing

Backward compatibility between API specifications is now automatically checked using our GitHub Actions workflow. This ensures that changes in your branch are compatible with the main branch before merging.

### How it works:

1. When you push changes to a branch or create a pull request targeting the main branch, the CI workflow is triggered.

2. The workflow identifies changed API specification files (YAML, JSON, and GraphQL).

3. For changed OpenAPI specifications, it runs a backward compatibility check using the Specmatic.

4. For changed GraphQL schemas, it performs a similar check using the Specmatic GraphQL.

## Linting

Below are the instructions to run the linter on your local machine

* Install [spectral](https://github.com/stoplightio/spectral#-installation-and-usage)

* Run below command inside the repo

```

spectral lint **/*.yaml 

```

* Above command leverages .spectral.yaml