Skip to content

Commit

Permalink
Merge fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Redm4x committed Feb 13, 2024
1 parent 7034500 commit 972965b
Show file tree
Hide file tree
Showing 3 changed files with 11,427 additions and 20,300 deletions.
8 changes: 4 additions & 4 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Auth0Issuer|ex: `'https://auth.cloudmos.io/'`
StripeSecretKey|ex: `sk_test_12aw315wdawd3...293d12d32df8jf`
WebsiteUrl|`http://localhost:3001`

## Changes from **beta** to **v1** (February 2023)
## Changes from **beta** to **v1** (March 2024)

### Api Versioning

Expand All @@ -43,15 +43,15 @@ The public api version will now be included in the url like so: api.cloudmos.io/
Changes that are backward compatible like adding new endpoint will be done in the existing version.
Changes that are **not** backward compatible, such as removing an endpoint, will be done in a new version. When releasing a new version, a list of breaking changes will be made available. We will keep the old version available for a while to give users enough time to migrate their applications to the latest version.

## Swagger Documentation
### Swagger Documentation

A swagger documentation is now available at https://api.cloudmos.io/v1/swagger. You can use it to see the list of available endpoints and try them directly in your browser.

## Changes from the beta version
### Route Changes

The `/api` prefix was removed from every public endpoints and instead the version should be used (ex: `/v1/<endpoint>`)

Here is a list of endpoints that have changed in this release. Old endpoints will temporarily redirect to the new ones so that users have some time for upgrading. In future releases, the [versioning system](#api-versioning) will be used instead of redirects.
Here is a list of endpoints that have changed in this release. Old endpoints will temporarily redirect to the new ones. In future releases, the [versioning system](#api-versioning) will be used instead of redirects.


|Old|New|
Expand Down
Loading

0 comments on commit 972965b

Please sign in to comment.