freezer/mareshq-backoffice-v3-api
Archived
1
0
Fork 0
Code Activity

docs(README.md): bump API info

Browse source
This commit is contained in:
Vojtěch Mareš 2024-09-22 10:41:53 +02:00
parent f8d189a799
commit f7572c5007
Signed by: vojtech.mares
GPG key ID: C6827B976F17240D
1 changed files with 3 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -6,7 +6,7 @@ Backoffice API for my training activities etc. maybe workshops in the future.
The API is going to be REST with OpenAPI specification and Swagger (or similar) UI for development. In the future this may change and for example gRPC (Connect RPC :eyes:).
The API scheme resides in the [`api/`](/api) directory. With major version like [**v0**](/api/v0), **v1**,... being subdirectories.
The API schema resides in the [`api/`](/api) directory.
### API and code
@ -22,6 +22,5 @@ I want to split major versions (:warning: breaking changes) with folders in code
This is done mainly to gain experience with such approach.
The first of API scheme iteration is marked as **v0**, since I expect not to get everything right the first time and I want to try this approach while designing the API. Altho it's just a number and there is no reason between **v0**, **v1**, **v2**,...
Current major API version is [v0](/api/v0).
The first of API scheme iteration is marked as **v0**, since I expect not to get everything right the first time and I want to try this approach while designing the API.
Altho it's just a number and there is no reason between **v0**, **v1**, **v2**,...