forked from fiatconnect/specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document a versioning scheme and the pre 1.0.0 state (fiatconnect#56)
- Loading branch information
Showing
3 changed files
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters