docs(jwt): Fix endpoints table and add missing logout route by DevlTz · Pull Request #16 · DevlTz/HomeMatch

DevlTz · 2026-03-30T20:58:06Z

The JWT endpoints table in docs/jwt.md was malformed and missing the logout endpoint despite it being wired up in the URL conf via TokenBlacklistView.

Changes

docs/jwt.md: Corrected markdown table formatting (single | separators, single header separator row); added missing POST /api/users/logout/ row documenting the blacklist-based logout endpoint.

Método	Endpoint	Acesso	Descrição
`POST`	`/api/users/logout/`	Autenticado	Invalida o `refresh` token (blacklist), encerrando a sessão.

… email auth.

…ensitivity to prevent double account with e.g (Testes.admin && testes.admin)

… JWT auth routes

Copilot

Pull request overview

Adds JWT-based authentication to the HomeMatch Django/DRF API (SimpleJWT), including registration/login/logout endpoints and supporting documentation/diagrams.

Changes:

Configure SimpleJWT (incl. refresh rotation + blacklist) and enable the blacklist app in Django settings.
Add public registration endpoint plus JWT login/refresh/logout routes; rename the authenticated “profile” action to /me.
Add documentation for authentication/security plus database diagrams (mermaid + PNG).

Reviewed changes

Copilot reviewed 8 out of 9 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
docs/jwt.md	New JWT/auth documentation and example requests.
docs/diagrama_database.mermaid	Adds a mermaid ER diagram for the project schema.
docs/diagram.png	Adds an image version of the database diagram.
config/settings.py	Enables SimpleJWT + blacklist app and sets JWT lifetimes/rotation behavior.
apps/users/views.py	Adds `RegisterUserView` and renames `profile` action to `me`; keeps favorites endpoint.
apps/users/urls.py	Adds `/register`, `/login`, `/token/refresh`, `/logout` routes alongside router endpoints.
apps/users/serializers.py	Adds `RegisterSerializer` for user creation.
apps/users/models.py	Introduces a custom `UserManager` for email-based auth.
apps/users/migrations/0003_alter_user_managers.py	Adds a migration altering model managers.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-01T21:06:17Z

config/settings.py

 AUTH_PASSWORD_VALIDATORS = [
    {
-        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
+    "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"


The AUTH_PASSWORD_VALIDATORS entry has inconsistent indentation for the dict key, which makes the settings file harder to read and deviates from the surrounding style. Align the "NAME" line indentation with the other dict entries.

Suggested change

"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"

"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"

Copilot · 2026-04-01T21:06:17Z

apps/users/views.py

+
+class RegisterUserView(generics.CreateAPIView):
+    queryset = User.objects.all()
+    permission_classes = [AllowAny] 


permission_classes = [AllowAny] has trailing whitespace. Please remove it to satisfy linters/formatters and keep diffs clean.

Suggested change

permission_classes = [AllowAny]

permission_classes = [AllowAny]

Copilot · 2026-04-01T21:06:17Z

apps/users/models.py

+            raise ValueError("Superuser need is_staff=True.")
+        if extra_fields.get("is_superuser") is not True:
+            raise ValueError("Superuser need is_superuser=True.")


The error messages in these ValueErrors have grammatical issues ("Superuser need ..."). Adjust wording to be clear and correct (e.g., "Superuser needs is_staff=True.") so these messages are useful when surfaced in CLI/admin flows.

Suggested change

raise ValueError("Superuser need is_staff=True.")

if extra_fields.get("is_superuser") is not True:

raise ValueError("Superuser need is_superuser=True.")

raise ValueError("Superuser needs is_staff=True.")

if extra_fields.get("is_superuser") is not True:

raise ValueError("Superuser needs is_superuser=True.")

Copilot · 2026-04-01T21:06:17Z

apps/users/views.py

    @action(detail=False, methods=['get', 'post', 'delete'], url_path='favorites')
    def favorites(self, request):
        from apps.properties.serializers import PropertiesSerializer # Sei que soa estranho, mas esse import tem que tá aqui praa poder não ter import repetido 
-        from apps.properties.models import Properties 
+        from apps.properties.models import Properties


This endpoint relies on user.favorites (used later in the method), but the User model in this PR does not define a favorites relation (the ManyToMany field is commented out and there is no alternative relation in apps/properties). This will raise an AttributeError at runtime. Either add/restore the favorites ManyToMany (with a migration) or update the endpoint to use the actual persisted favorites model/table.

Copilot · 2026-04-01T21:06:18Z

docs/jwt.md

+| Método | Endpoint | Acesso | Descrição |
+| :--- | :--- | :--- | :--- |
+| `POST` | `/api/users/register/` | Público | Registra um novo usuário na plataforma. |
+| `POST` | `/api/users/login/` | Público | Recebe as credenciais e retorna os tokens `access` e `refresh`. |
+| `POST` | `/api/users/token/refresh/` | Público | Gera um novo `access` token utilizando um `refresh` válido. |


The markdown table for the JWT endpoints is malformed (rows start with ||), which prevents proper rendering in standard Markdown parsers. Use single | separators and a single header separator row.

@copilot apply changes based on this feedback

Fixed in dc2c90a. The table now uses proper single | separators and I also added the missing POST /api/users/logout/ row, which was already defined in the URL conf but omitted from the docs.

Copilot · 2026-04-01T21:06:18Z

docs/jwt.md

+        "password": "sua senha cadastrada"
+     }'
+```
+ * Só ai, você testa com seu token.


This sentence has a spelling/grammar issue ("Só ai"). Please correct to "Só aí" for proper Portuguese.

Suggested change

* Só ai, você testa com seu token.

* Só aí, você testa com seu token.

Copilot · 2026-04-01T21:06:18Z

config/settings.py

+from datetime import timedelta
+SIMPLE_JWT = {


Keep imports grouped at the top of the module. timedelta is imported mid-file, which makes settings harder to scan and can conflict with linting rules.

Copilot · 2026-04-01T21:06:19Z

config/settings.py

+    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=60),
+    'REFRESH_TOKEN_LIFETIME': timedelta(days=1),
+    'ROTATE_REFRESH_TOKENS': True,
+    'BLACKLIST_AFTER_ROTATION': True,


Quote style is inconsistent: this settings file largely uses double quotes, but SIMPLE_JWT uses single quotes for keys. Standardize the quoting style to match the rest of the file to keep formatting consistent.

Suggested change

'ACCESS_TOKEN_LIFETIME': timedelta(minutes=60),

'REFRESH_TOKEN_LIFETIME': timedelta(days=1),

'ROTATE_REFRESH_TOKENS': True,

'BLACKLIST_AFTER_ROTATION': True,

"ACCESS_TOKEN_LIFETIME": timedelta(minutes=60),

"REFRESH_TOKEN_LIFETIME": timedelta(days=1),

"ROTATE_REFRESH_TOKENS": True,

"BLACKLIST_AFTER_ROTATION": True,

Copilot · 2026-04-01T21:06:19Z

apps/users/serializers.py

+            user_type=validated_data['user_type'],
+            password=validated_data['password']
+        )
+        return user


Add a blank line between create and validate_email. Having def validate_email immediately after return user violates PEP 8 and makes the serializer harder to read.

Suggested change

return user

return user

Copilot · 2026-04-01T21:06:19Z

apps/users/migrations/0003_alter_user_managers.py

+    operations = [
+        migrations.AlterModelManagers(
+            name='user',
+            managers=[
+            ],
+        ),
+    ]


This migration alters model managers but provides an empty managers=[], which is unusual and can create confusing migration state (and it doesn't affect the DB schema). Consider removing it, or include the intended manager so the migration accurately represents the model state.

Suggested change

operations = [

migrations.AlterModelManagers(

name='user',

managers=[

],

),

]

operations = []

Agent-Logs-Url: https://github.com/DevlTz/HomeMatch/sessions/ffd2d2d2-2749-48f3-a23a-f55c32465b7f Co-authored-by: DevlTz <110422010+DevlTz@users.noreply.github.com>

… disabled

…into feat/devltz/jwt

DevlTz added 5 commits March 30, 2026 17:20

refactor(users): remove username and implement custom UserManager for…

279000c

… email auth.

feat(users - serializers): add RegisterSerializer with email case-ins…

d0f6dab

…ensitivity to prevent double account with e.g (Testes.admin && testes.admin)

feat(users): implement/changes the old /profile/ to /me/ endpoint and…

d8af7ba

… JWT auth routes

chore(settings): setup SimpleJWT and DRF authentication settings

fe09969

docs: add detailed JWT authentication and security rules

46a3afa

DevlTz requested a review from Copilot April 1, 2026 21:02

DevlTz self-assigned this Apr 1, 2026

Copilot started reviewing on behalf of DevlTz April 1, 2026 21:02 View session

Copilot AI reviewed Apr 1, 2026

View reviewed changes

Update config/settings.py

e175a1c

Copilot started work on behalf of DevlTz April 7, 2026 20:02 View session

docs(jwt): fix markdown table formatting and add missing logout endpoint

dc2c90a

Agent-Logs-Url: https://github.com/DevlTz/HomeMatch/sessions/ffd2d2d2-2749-48f3-a23a-f55c32465b7f Co-authored-by: DevlTz <110422010+DevlTz@users.noreply.github.com>

Copilot AI changed the title ~~Feat/devltz/jwt~~ docs(jwt): Fix endpoints table and add missing logout route Apr 7, 2026

Copilot finished work on behalf of DevlTz April 7, 2026 20:05

DevlTz and others added 3 commits April 7, 2026 17:25

feat(users): setup email auth and /me endpoint, favorites temporarily…

3560ed1

… disabled

Merge branch 'feat/devltz/jwt' of https://github.com/DevlTz/HomeMatch …

0bc12b2

…into feat/devltz/jwt

Merge branch 'main' into feat/devltz/jwt

2c03152

DevlTz merged commit f28d0fe into main Apr 7, 2026
1 check failed

	"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"
	"NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator"

	permission_classes = [AllowAny]
	permission_classes = [AllowAny]

	* Só ai, você testa com seu token.
	* Só aí, você testa com seu token.

Conversation

DevlTz commented Mar 30, 2026 • edited by Copilot AI Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

DevlTz Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

DevlTz commented Mar 30, 2026 •

edited by Copilot AI

Loading