diff --git a/.dockerignore b/.dockerignore index 801b422..1effd49 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,9 +1,7 @@ .git/ .gitignore *.md -*.postman_collection.json -*.postman_environment.json -example_bulk_request.json +docs/ install-authelia-api.sh docker/configuration.yml.example docker/compose.yml diff --git a/README.md b/README.md index 547c889..3d66120 100644 --- a/README.md +++ b/README.md @@ -89,13 +89,13 @@ curl -H "Authorization: Bearer YOUR_TOKEN" http://localhost:8080/api/health ## API Testing with Postman -Postman collection and environment files are provided for API testing: +Postman collection, environment, and a full usage guide are provided under [`docs/postman/`](docs/postman/): -- `authelia-api.postman_collection.json` - Complete API collection with all endpoints -- `authelia-api.postman_environment.json` - Environment variables (base URL, token) -- `POSTMAN_GUIDE.md` - Setup and usage guide +- [`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-guide.md`](docs/postman-guide.md) - Setup, examples, and troubleshooting -See [POSTMAN_GUIDE.md](POSTMAN_GUIDE.md) for detailed setup and usage instructions. +A bulk user creation example is at [`docs/examples/bulk-request.json`](docs/examples/bulk-request.json). ## Files in This Repository @@ -103,11 +103,12 @@ See [POSTMAN_GUIDE.md](POSTMAN_GUIDE.md) for detailed setup and usage instructio - `docker-compose.yml` - Quick Docker deployment with volumes - `docker/` - Container entrypoint and configuration templates - `src/` - Go source code (cmd/server, internal packages, migrations) -- `openapi.yml` - OpenAPI 3.0.3 specification for all endpoints +- `docs/` - Documentation, OpenAPI spec, Postman files, and usage examples + - `docs/openapi.yml` - OpenAPI 3.0.3 specification for all endpoints + - `docs/postman-guide.md` - Postman setup and usage guide + - `docs/postman/` - Postman collection and environment files + - `docs/examples/` - Example request payloads - `install-authelia-api.sh` - Bare-metal installation script -- `POSTMAN_GUIDE.md` - API testing guide with examples -- `authelia-api.postman_collection.json` - Postman collection (12 endpoints) -- `authelia-api.postman_environment.json` - Postman environment ## Mirror diff --git a/example_bulk_request.json b/docs/examples/bulk-request.json similarity index 100% rename from example_bulk_request.json rename to docs/examples/bulk-request.json diff --git a/openapi.yml b/docs/openapi.yml similarity index 100% rename from openapi.yml rename to docs/openapi.yml diff --git a/POSTMAN_GUIDE.md b/docs/postman-guide.md similarity index 94% rename from POSTMAN_GUIDE.md rename to docs/postman-guide.md index a420d34..dcec401 100644 --- a/POSTMAN_GUIDE.md +++ b/docs/postman-guide.md @@ -6,8 +6,8 @@ Postman files for testing and interacting with the Authelia API (user management | File | Description | |------|-------------| -| `authelia-api.postman_collection.json` | Collection with all 12 API endpoints | -| `authelia-api.postman_environment.json` | Environment variables (`base_url`, `bearer_token`) | +| [`postman/collection.json`](postman/collection.json) | Collection with all 12 API endpoints | +| [`postman/environment.json`](postman/environment.json) | Environment variables (`base_url`, `bearer_token`) | ## Setup @@ -291,5 +291,7 @@ GET /api/health ## Related - [OpenAPI Spec](openapi.yml) — Full API specification -- [Source Code](src/) — Go source +- [Source Code](../src/) — Go source +- [Postman Files](postman/) — Collection and environment +- [Examples](examples/) — Sample request payloads - [Authelia Documentation](https://www.authelia.com/) diff --git a/authelia-api.postman_collection.json b/docs/postman/collection.json similarity index 100% rename from authelia-api.postman_collection.json rename to docs/postman/collection.json diff --git a/authelia-api.postman_environment.json b/docs/postman/environment.json similarity index 100% rename from authelia-api.postman_environment.json rename to docs/postman/environment.json