API Client Documentation and Version Management (#209)
Commit: fe199e3e54327ea0534b7be9d9bc2d2441f876e5
Date: 2025-07-09 14:14:06 +0200
Author: PascalHavelange
Commit Message
API Client Documentation and Version Management (#209)
* Remove Husky Git hooks
- Removed Husky package and configuration
- Removed lint-staged package and configuration
- Removed pre-commit and pre-push hooks
- Unset Git hooks path
This change makes the development workflow simpler by removing the automatic hooks that were causing issues during commits and pushes.
* Removed the "pre-commit" and "pre-push" scripts from package.json
Removed the "husky" and "lint-staged" packages from devDependencies
Removed the "lint-staged" configuration from package.json
Removed the .husky directory containing the hook scripts
Reset the Git hooks path using git config --unset core.hooksPath
* Updated ghpage documentation
* Update API client documentation and fix version management
- Enhanced API documentation with comprehensive API client development guide
- Added detailed project scripts documentation for generate-api-client.ps1 and publish-api-client.ps1
- Fixed API client versioning to prevent conflicts during npm publish
- Added version increment type parameter for easier semantic versioning control
- Updated script documentation to use proper PowerShell preference parameters
- Improved troubleshooting section with common issues and solutions
- Added best practices for version management and client integration
- Added detailed instructions for authentication, installation, and usage
Documentation now includes:
- Complete versioning strategy explanation (MAJOR.MINOR.PATCH, pre-release, build metadata)
- Step-by-step API client generation process walkthrough
- Publishing process details for GitHub Packages registry
- Client project integration instructions with authentication setup
* Update CHANGELOG with API client and Picture Translation changes
- Added API client documentation improvements to changelog
- Added Picture Translation feature to changelog
- Added API client versioning fixes to changelog
---------
Co-authored-by: Pascal HAVELANGE <havelangep@hotmail.com>
Files Changed
- ❌ Deleted:
.husky/pre-commit - ❌ Deleted:
.husky/pre-push - 📝 Modified:
.prettierignore - 📝 Modified:
CHANGELOG.md - 📝 Modified:
api-client/.openapi-generator/FILES - 📝 Modified:
api-client/README.md - 📝 Modified:
api-client/api.ts - ✅ Added:
api-client/docs/PictureTranslationApi.md - ✅ Added:
api-client/docs/PictureTranslationIndex200Response.md - ✅ Added:
api-client/docs/PictureTranslationIndex200ResponseLinks.md - ✅ Added:
api-client/docs/PictureTranslationIndex200ResponseMeta.md - ✅ Added:
api-client/docs/PictureTranslationIndex200ResponseMetaLinksInner.md - ✅ Added:
api-client/docs/PictureTranslationResource.md - ✅ Added:
api-client/docs/PictureTranslationStore200Response.md - ✅ Added:
api-client/docs/PictureTranslationStoreRequest.md - ✅ Added:
api-client/docs/PictureTranslationUpdateRequest.md - 📝 Modified:
api-client/package.json - ✅ Added:
app/Http/Controllers/PictureTranslationController.php - ✅ Added:
app/Http/Resources/PictureTranslationResource.php - 📝 Modified:
app/Models/Picture.php - ✅ Added:
app/Models/PictureTranslation.php - 📝 Modified:
composer.json - 📝 Modified:
database/factories/PictureFactory.php - ✅ Added:
database/factories/PictureTranslationFactory.php - ✅ Added:
database/migrations/2025_07_09_091335_create_picture_translations_table.php - 📝 Modified:
database/seeders/DatabaseSeeder.php - ✅ Added:
database/seeders/PictureTranslationSeeder.php - 📝 Modified:
docs/.copilot-instructions.md - ❌ Deleted:
docs/.github/workflows/generate-commit-docs.yml - 📝 Modified:
docs/README.md - 📝 Modified:
docs/_config.yml - 📝 Modified:
docs/_layouts/default.html - 📝 Modified:
docs/_openapi/api.json - 📝 Modified:
docs/api-documentation.md - 📝 Modified:
docs/assets/css/custom.scss - 📝 Modified:
docs/contributing.md - 📝 Modified:
docs/development-archive.md - 📝 Modified:
docs/guidelines/generate-api-client-docs.md - 📝 Modified:
docs/guidelines/generate-commit-docs.md - 📝 Modified:
docs/guidelines/index.md - 📝 Modified:
docs/guidelines/testing.md - 📝 Modified:
docs/index.md - 📝 Modified:
docs/swagger-ui.md - 📝 Modified:
package-lock.json - 📝 Modified:
package.json - 📝 Modified:
resources/js/app.js - 📝 Modified:
resources/js/bootstrap.js - 📝 Modified:
routes/api.php - 📝 Modified:
scripts/api-client-config.psd1 - 📝 Modified:
scripts/generate-api-client.ps1 - 📝 Modified:
scripts/publish-api-client.ps1 - ✅ Added:
tests/Feature/Api/PictureTranslation/AnonymousTest.php - ✅ Added:
tests/Feature/Api/PictureTranslation/DestroyTest.php - ✅ Added:
tests/Feature/Api/PictureTranslation/IndexTest.php - ✅ Added:
tests/Feature/Api/PictureTranslation/ShowTest.php - ✅ Added:
tests/Feature/Api/PictureTranslation/StoreTest.php - ✅ Added:
tests/Feature/Api/PictureTranslation/UpdateTest.php - ✅ Added:
tests/Unit/PictureTranslation/FactoryTest.php
Links
This documentation was automatically generated from Git commit data.