Skip to content

Commit 432c9ab

Browse files
authored
Merge pull request #24 from Hyperkid123/docs
chore: add API docs
2 parents cadb941 + f9b737e commit 432c9ab

File tree

3 files changed

+747
-1
lines changed

3 files changed

+747
-1
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,15 @@ Most endpoints require a valid `x-rh-identity` header. See [docs/DEVELOPMENT_IDE
4242

4343
All project documentation is organized in the `docs/` folder:
4444

45+
- **[docs/API.md](docs/API.md)** - Complete API documentation with endpoints, examples, and schemas
4546
- **[docs/TESTING.md](docs/TESTING.md)** - Comprehensive testing guide with patterns and best practices
4647
- **[docs/CONFIGURATION.md](docs/CONFIGURATION.md)** - Widget mapping and base template configuration guide
4748
- **[docs/DEVELOPMENT_IDENTITY_HEADER.md](docs/DEVELOPMENT_IDENTITY_HEADER.md)** - Identity header generation for local development
4849
- **[docs/AI_AGENT_CONTEXT.md](docs/AI_AGENT_CONTEXT.md)** - Guidelines for AI-assisted development
4950

5051
## More Information
5152

53+
- See **[docs/API.md](docs/API.md)** for complete API documentation with endpoints, examples, and schemas.
5254
- See the Makefile for available commands.
5355
- See the `cmd/dev/user-identity.go` script for identity header generation logic.
5456
- See **[docs/TESTING.md](docs/TESTING.md)** for comprehensive testing documentation.

0 commit comments

Comments
 (0)