Clarify API base path /api/v1 in documentation #15083

Closed
opened 2025-11-02 11:29:47 -06:00 by GiteaMirror · 1 comment
Owner

Originally created by @prafdin on GitHub (Nov 1, 2025).

Description

HTTP Basic Auth only works with API endpoints (e.g., /api/v1/user), not web paths like /user. The official documentation does not explicitly state that all API endpoints are under /api/v1, which is only visible in the Swagger UI.

Please add a clear note about the API base path and a simple curl example to avoid confusion.

Gitea Version

1.24.7

Can you reproduce the bug on the Gitea demo site?

No

Log Gist

No response

Screenshots

No response

Git Version

No response

Operating System

No response

How are you running Gitea?

Docker

Database

SQLite

Originally created by @prafdin on GitHub (Nov 1, 2025). ### Description HTTP Basic Auth only works with API endpoints (e.g., /api/v1/user), not web paths like /user. The official documentation does not explicitly state that all API endpoints are under /api/v1, which is only visible in the Swagger UI. Please add a clear note about the API base path and a simple curl example to avoid confusion. ### Gitea Version 1.24.7 ### Can you reproduce the bug on the Gitea demo site? No ### Log Gist _No response_ ### Screenshots _No response_ ### Git Version _No response_ ### Operating System _No response_ ### How are you running Gitea? Docker ### Database SQLite
GiteaMirror added the issue/not-a-bug label 2025-11-02 11:29:47 -06:00
Author
Owner

@lunny commented on GitHub (Nov 1, 2025):

This information is already displayed in the top navigation bar, directly below the username.

Image
@lunny commented on GitHub (Nov 1, 2025): This information is already displayed in the top navigation bar, directly below the username. <img width="279" height="169" alt="Image" src="https://github.com/user-attachments/assets/88770428-dd3e-4c73-8cff-dc42d97d317a" />
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/gitea#15083