Skip to content

Commit

Permalink
api.dataline.io => locahost:8080
Browse files Browse the repository at this point in the history
  • Loading branch information
cgardens committed Aug 6, 2020
1 parent 15368ab commit 64cd597
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions conduit-api/src/main/openapi/conduit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ info:
Here are some conventions that this API follows:
* All endpoints are http POST methods.
* All endpoints accept data via `application/json` request bodies. The API does not accept any data via query params.
* The naming convention for endpoints is: api.dataline.io/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `api.dataline.io/v1/connections/create` or `api.dataline.io/v1/connections/create`.
* The naming convention for endpoints is: localhost:8080/{VERSION}/{METHOD_FAMILY}/{METHOD_NAME} e.g. `localhost:8080/v1/connections/create` or `localhost:8080/v1/connections/create`.
* For all `update` method, the whole object must be passed in, even the fields that did not change.
Change Management:
* The major version of the API endpoint can be determined / specified in the URL `api.dataline.io/v1/connections/create`
* The major version of the API endpoint can be determined / specified in the URL `localhost:8080/v1/connections/create`
* Minor version bumps will be visible to the end user. The user cannot specify minor versions in requests.
* All backwards incompatible changes will happen in major version bumps. We will not make backwards incompatible changes in minor version bumps. Examples of non-breaking changes (includes but not limited to...):
* Adding fields to request or response bodies.
Expand Down

0 comments on commit 64cd597

Please sign in to comment.