Update changelog

This commit is contained in:
Eugene Burmakin 2024-05-25 20:50:25 +02:00
parent 036b21b5a5
commit 390b6c3d17
7 changed files with 40 additions and 4 deletions

View file

@ -1 +1 @@
0.3.2
0.4.0

View file

@ -5,6 +5,36 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## [0.4.0] — 2024-05-25
**BREAKING CHANGES**:
- `/api/v1/points` is still working, but will be **deprecated** in nearest future. Please use `/api/v1/owntracks/points` instead.
- All existing points recorded directly to the database via Owntracks or Overland will be attached to the user with id 1.
### Added
- Each user now have an api key, which is required to make requests to the API. You can find your api key in your profile settings.
- You can re-generate your api key in your profile settings.
- In your user profile settings you can now see the instructions on how to use the API with your api key for both OwnTracks and Overland.
- Added docs on how to use the API with your api key. Refer to `/api-docs` for more information.
- `POST /api/v1/owntracks/points` endpoint.
- Points are now being attached to a user directly, so you can only see your own points and no other users of your applications can see your points.
### Changed
- `/api/v1/overland/batches` endpoint now requires an api key to be passed in the url. You can find your api key in your profile settings.
- All existing points recorded directly to the database will be attached to the user with id 1.
- All stats and maps are now being calculated and rendered based on the user's points only.
- Default `TIME_ZONE` environment variable is now set to 'UTC' in the `docker-compose.yml` file.
### Fixed
- Fixed a bug where marker on the map was rendering timestamp without considering the timezone.
---
## [0.3.2] — 2024-05-23
### Added

File diff suppressed because one or more lines are too long

View file

@ -4,6 +4,6 @@ class HomeController < ApplicationController
def index
redirect_to map_url if current_user
@points = current_user.points.without_raw_data if current_user
@points = current_user.tracked_points.without_raw_data if current_user
end
end

View file

@ -22,6 +22,11 @@
</div>
<% end %>
<div role="alert" class="alert alert-warning">
<svg xmlns="http://www.w3.org/2000/svg" class="stroke-current shrink-0 h-6 w-6" fill="none" viewBox="0 0 24 24"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z" /></svg>
<span>Warning: Starting release 0.4.0 it's HIGHLY RECOMMENDED to switch from <code>/api/v1/points</code> to <code>/api/v1/owntracks/points</code> API endpoint. Please read more at <a href="https://github.com/Freika/dawarich/releases/tag/0.4.0" class='underline hover:no-underline'>0.4.0 release notes</a></span>
</div>
<div
class="w-full"
data-controller="maps"

View file

@ -9,7 +9,7 @@
<div class="stat text-center">
<div class="stat-value text-success">
<%= number_with_delimiter current_user.points.without_raw_data.count(:id) %>
<%= number_with_delimiter current_user.tracked_points.without_raw_data.count(:id) %>
</div>
<div class="stat-title">Geopoints tracked</div>
</div>

View file

@ -44,6 +44,7 @@ services:
DATABASE_NAME: dawarich_development
MIN_MINUTES_SPENT_IN_CITY: 60
APPLICATION_HOST: localhost
TIME_ZONE: UTC
depends_on:
- dawarich_db
- dawarich_redis