cclohmar/authelia-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: move postman guide into postman folder as README.md

Browse source 
- docs/postman-guide.md → docs/postman/README.md (auto-loads on folder view)
- Updated main README.md links
This commit is contained in:
Claus Lohmar 2026-07-15 18:10:02 +00:00
parent 8cfd403c14
commit 873ea789f1
2 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -91,9 +91,9 @@ curl -H "Authorization: Bearer YOUR_TOKEN" http://localhost:8080/api/health
Postman collection, environment, and a full usage guide are provided under [`docs/postman/`](docs/postman/): Postman collection, environment, and a full usage guide are provided under [`docs/postman/`](docs/postman/):
- [`docs/postman/collection.json`](docs/postman/collection.json) - Complete API collection with all 12 endpoints - [`docs/postman/collection.json`](docs/postman/collection.json) — Complete API collection with all 12 endpoints
- [`docs/postman/environment.json`](docs/postman/environment.json) - Environment variables (base URL, token) - [`docs/postman/environment.json`](docs/postman/environment.json) — Environment variables (base URL, token)
- [`docs/postman-guide.md`](docs/postman-guide.md) - Setup, examples, and troubleshooting - [`docs/postman/README.md`](docs/postman/README.md) — Setup, examples, and troubleshooting
A bulk user creation example is at [`docs/examples/bulk-request.json`](docs/examples/bulk-request.json). A bulk user creation example is at [`docs/examples/bulk-request.json`](docs/examples/bulk-request.json).
@ -105,7 +105,7 @@ A bulk user creation example is at [`docs/examples/bulk-request.json`](docs/exam
- `src/` - Go source code (cmd/server, internal packages, migrations) - `src/` - Go source code (cmd/server, internal packages, migrations)
- `docs/` - Documentation, OpenAPI spec, Postman files, and usage examples - `docs/` - Documentation, OpenAPI spec, Postman files, and usage examples
- `docs/openapi.yml` - OpenAPI 3.0.3 specification for all endpoints - `docs/openapi.yml` - OpenAPI 3.0.3 specification for all endpoints
- `docs/postman-guide.md` - Postman setup and usage guide - `docs/postman/README.md` - Postman setup and usage guide
- `docs/postman/` - Postman collection and environment files - `docs/postman/` - Postman collection and environment files
- `docs/examples/` - Example request payloads - `docs/examples/` - Example request payloads
- `install-authelia-api.sh` - Bare-metal installation script - `install-authelia-api.sh` - Bare-metal installation script

0
docs/postman-guide.md → docs/postman/README.md
View file