Skip to content

Commit

Permalink
Document a versioning scheme and the pre 1.0.0 state (fiatconnect#56)
Browse files Browse the repository at this point in the history
  • Loading branch information
silasbw authored Jun 14, 2022
1 parent 05be5cb commit f300181
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 4 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
# specification
FiatConnect API Specification
# FiatConnect

The FiatConnect API Specification.

## Specification

[fiatconnect-api.md](./fiatconnect-api.md) describes the FiaConnect
API specification.

[swagger.yaml](./swagger.yaml) is an OpenAPI 2.0 specification for
FiatConnect.

## Versioning

We use [semantic versioning](https://semver.org/) to version the
API specification.

The API specification is stil under initial developemnt. We're working
towards a 1.0.0 release and try hard to avoid breaking changes, but
anything MAY change at any time. The API specification SHOULD NOT be
considered stable.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "specification",
"version": "0.0.1",
"version": "0.1.0",
"description": "FiatConnect API Specification",
"repository": "https://github.com/fiatconnect/specification.git",
"scripts": {
Expand Down
2 changes: 1 addition & 1 deletion swagger.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
swagger: "2.0"
info:
description: "FiatConnect provides a standardized server-side API specification for CICO providers to provide cash-in/cash-out functionality to clients."
version: "1.0.0"
version: "0.1.0"
title: "FiatConnect Specification"
tags:
- name: "clock"
Expand Down

0 comments on commit f300181

Please sign in to comment.