This repository contains a sample API documentation project for a security ticket processing system.
The SecurityTicketRequestProcessor API is designed to handle incoming requests from third-party systems that report software security issues. It enables clients to create, update, retrieve, and manage security tickets within a centralised platform.
This project was created to demonstrate API documentation skills in environments where client work is protected by non-disclosure agreements.
View the full developer portal here: 👉 https://kingstonpb.github.io/securityticket-docs/
The documentation includes:
- REST API endpoints (CRUD operations)
- OAuth 2.0 authentication flow
- Pagination (cursor-based)
- Webhook configuration and event handling
- Error handling and status codes
- Rate limiting and idempotency
- OpenAPI specification (YAML)
This documentation is intended for:
- Developers integrating external systems
- Security tooling providers
- Internal engineering teams
- Structured using REST API best practices
- Written in clear, developer-focused language
- Designed as a static developer portal
- Includes machine-readable OpenAPI specification
index.html # Developer portal UI
openapi.yaml # API specification
This is a portfolio project intended to demonstrate technical writing capability and documentation structure.
Your Name Technical Writer (UK)