chore: reorganise docs/ folder for Postman, examples, and OpenAPI spec
- Moved into docs/: docs/postman/collection.json ← authelia-api.postman_collection.json docs/postman/environment.json ← authelia-api.postman_environment.json docs/postman-guide.md ← POSTMAN_GUIDE.md docs/openapi.yml ← openapi.yml docs/examples/bulk-request.json ← example_bulk_request.json - Updated README.md with new paths and docs/ structure - Updated .dockerignore to reflect new layout - Removed stale pre-built binary from working tree
This commit is contained in:
parent
35bc7566ea
commit
8cfd403c14
7 changed files with 16 additions and 15 deletions
|
|
@ -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
|
||||
|
|
|
|||
19
README.md
19
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
|
||||
|
||||
|
|
|
|||
|
|
@ -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/)
|
||||
Loading…
Reference in a new issue