docs: add CI/CD badge, remove Future Enhancements, Key Learnings, and Notes sections

Author: arturdmt-alt

README.md

@@ -1,51 +1,56 @@
 # Advanced API Testing Framework
 
-Professional API testing framework using Python, Pytest, and JSONPlaceholder API. Demonstrates advanced testing concepts including layered validation, schema validation, and performance testing.
-
 [![API Tests](https://github.com/arturdmt-alt/QA_API_Advanced/actions/workflows/tests.yml/badge.svg)](https://github.com/arturdmt-alt/QA_API_Advanced/actions/workflows/tests.yml)
 
-## Project Overview
+Professional API testing framework using Python, Pytest, and JSONPlaceholder API. Demonstrates advanced testing concepts including layered validation, schema validation, and performance testing.
 
-This framework showcases industry-standard API testing practices with a focus on maintainability, scalability, and comprehensive test coverage. Built as part of a structured QA automation learning path.
+---
 
 ## Technology Stack
 
-- Python 3.14
-- Pytest - Testing framework
-- Requests - HTTP client library
-- JSONSchema - Schema validation
-- Pytest-HTML - Test reporting
+* Python 3.11+
+* Pytest - Testing framework
+* Requests - HTTP client library
+* JSONSchema - Schema validation
+* Pytest-HTML - Test reporting
+
+---
 
 ## Features
 
-- Centralized API client with session management
-- Reusable validation utilities
-- JSON schema validation
-- Response time assertions
-- Layered validation approach (status → structure → content)
-- Comprehensive test data management
-- HTML test reporting
-- Clear separation of concerns (utils, tests, data)
+* Centralized API client with session management
+* Reusable validation utilities
+* JSON schema validation
+* Response time assertions
+* Layered validation approach (status → structure → content)
+* Comprehensive test data management
+* HTML test reporting
+* Clear separation of concerns (utils, tests, data)
+* CI/CD pipeline with GitHub Actions
+
+---
 
 ## Test Coverage
 
-### Users CRUD Operations
-- GET all users with pagination validation
-- GET single user by ID with schema validation
-- POST create new user
-- PUT update existing user
-- DELETE user
-- Negative test: 404 for non-existent user
+**Users CRUD Operations:**
+* GET all users with pagination validation
+* GET single user by ID with schema validation
+* POST create new user
+* PUT update existing user
+* DELETE user
+* Negative test: 404 for non-existent user
 
-### Posts Operations
-- GET all posts
-- GET posts filtered by user ID
-- GET single post with schema validation
-- GET post comments (nested resources)
-- POST create new post
-- Negative test: 404 for invalid post ID
+**Posts Operations:**
+* GET all posts
+* GET posts filtered by user ID
+* GET single post with schema validation
+* GET post comments (nested resources)
+* POST create new post
+* Negative test: 404 for invalid post ID
 
-**Total: 12 automated tests**
+**Total:** 12 automated tests
+
+---
 
 ## Project Structure
 ```
@@ -69,15 +74,16 @@ QA_API_Advanced/
 └── README.md
 ```
 
-## Setup Instructions
+---
 
-### Prerequisites
+## Setup Instructions
 
-- Python 3.11 or higher
-- pip (Python package manager)
-- Git
+**Prerequisites:**
+* Python 3.11 or higher
+* pip (Python package manager)
+* Git
 
-### Installation
+**Installation:**
 
 1. Clone the repository:
 ```bash
@@ -97,28 +103,32 @@ source venv/bin/activate  # macOS/Linux
 pip install -r requirements.txt
 ```
 
+---
+
 ## Running Tests
 
-### Run all tests:
+Run all tests:
 ```bash
 pytest tests/ -v
 ```
 
-### Run specific test file:
+Run specific test file:
 ```bash
 pytest tests/test_users_crud.py -v
 ```
 
-### Generate HTML report:
+Generate HTML report:
 ```bash
 pytest tests/ --html=reports/test_report.html --self-contained-html
 ```
 
-### Run with verbose output:
+Run with verbose output:
 ```bash
 pytest tests/ -v -s
 ```
 
+---
+
 ## Test Results
 
 ![Test Report Summary](screenshots/test_report_summary.png)
@@ -127,6 +137,8 @@ pytest tests/ -v -s
 
 All tests passing with response times under 3 seconds.
 
+---
+
 ## Technical Approach
 
 ### Layered Validation Strategy
@@ -145,75 +157,57 @@ This approach provides clear error messages and catches issues early.
 ### API Client Pattern
 
 Centralized HTTP client provides:
-- Consistent headers across all requests
-- Session reuse for performance
-- Timeout handling to prevent hanging tests
-- Context manager support for proper cleanup
+* Consistent headers across all requests
+* Session reuse for performance
+* Timeout handling to prevent hanging tests
+* Context manager support for proper cleanup
 
 ### Schema Validation
 
 JSON Schema validation ensures:
-- API contract compliance
-- Early detection of breaking changes
-- Documentation of expected response structure
+* API contract compliance
+* Early detection of breaking changes
+* Documentation of expected response structure
+
+---
 
 ## Challenges and Solutions
 
 ### Challenge 1: Response Time Variability
 
-**Problem**: Initial tests failed due to network latency causing response times to exceed 2000ms limit.
+**Problem:** Initial tests failed due to network latency causing response times to exceed 2000ms limit.
 
-**Solution**: Adjusted timeout threshold to 3000ms for public API testing. In production environment with internal APIs, lower thresholds (500-1000ms) would be more appropriate.
+**Solution:** Adjusted timeout threshold to 3000ms for public API testing. In production environment with internal APIs, lower thresholds (500-1000ms) would be more appropriate.
 
 ### Challenge 2: Mock API Limitations
 
-**Problem**: JSONPlaceholder is a fake API that doesn't persist data, limiting certain test scenarios.
+**Problem:** JSONPlaceholder is a fake API that doesn't persist data, limiting certain test scenarios.
 
-**Solution**: Documented limitation in README and focused on testing API contract and response validation rather than data persistence. For real-world projects, would use test database with proper cleanup.
+**Solution:** Documented limitation and focused on testing API contract and response validation rather than data persistence. For real-world projects, would use test database with proper cleanup.
 
 ### Challenge 3: Test Data Management
 
-**Problem**: Hardcoded test data scattered across test files made maintenance difficult.
-
-**Solution**: Centralized all test data in `data/test_data.py` including valid data, invalid data, edge cases, and JSON schemas. Single source of truth for test data.
-
-## Key Learnings
-
-Through this project I gained experience with:
+**Problem:** Hardcoded test data scattered across test files made maintenance difficult.
 
-- Professional API testing patterns and best practices
-- Layered validation approach for robust assertions
-- JSON Schema validation for API contract testing
-- Test framework architecture and separation of concerns
-- Performance testing basics (response time validation)
-- Writing maintainable and scalable test automation
-- Proper error handling and debugging strategies
+**Solution:** Centralized all test data in `data/test_data.py` including valid data, invalid data, edge cases, and JSON schemas. Single source of truth for test data.
 
-## Future Enhancements
-
-- Add parametrized tests for data-driven testing
-- Implement authentication testing with different API
-- Expand to include albums and photos endpoints
-- Add rate limiting tests
-- Implement parallel test execution
-- Add API mocking for offline testing
+---
 
 ## API Used
 
-This project uses [JSONPlaceholder](https://jsonplaceholder.typicode.com/) - a free fake REST API for testing and prototyping.
-
-Endpoints tested:
-- `/users` - User management
-- `/posts` - Blog posts
-- `/comments` - Post comments
+This project uses **JSONPlaceholder** - a free fake REST API for testing and prototyping.
 
-## Author
+**Endpoints tested:**
+* `/users` - User management
+* `/posts` - Blog posts
+* `/comments` - Post comments
 
-Artur Dmytriyev - QA Automation Engineer
+---
 
-- GitHub: https://github.com/arturdmt-alt
-- LinkedIn: https://www.linkedin.com/in/arturdmytriyev
+## Author
 
-## Notes
+**Artur Dmytriyev**  
+QA Automation Engineer
 
-Built as part of a QA automation learning path to demonstrate advanced API testing skills. Focuses on professional testing practices and maintainable test architecture.
+* GitHub: [github.com/arturdmt-alt](https://github.com/arturdmt-alt)
+* LinkedIn: [linkedin.com/in/arturdmytriyev](https://www.linkedin.com/in/arturdmytriyev)