6869: Improve OpenAPI spec with descriptions, examples, and error codes

[turegjorup]

Summary

• Add API title, description, and version to the OpenAPI spec via api_platform.yaml
• Add operation-level summary, description, and error responses (401, 403) to the POST /api/detection_results endpoint
• Add field-level descriptions, examples, and enum (referencing DetectionType constants) for type, rootDir, and data
• Add OpenApiFactory decorator for dynamic server URL (from COMPOSE_SERVER_DOMAIN/COMPOSE_DOMAIN) and security scheme description documenting the Apikey header format
• Regenerate api-spec-v1.yaml and api-spec-v1.json

Test plan

• Verify composer update-api-spec regenerates identical spec files
• Verify Swagger UI at /api/docs renders descriptions, examples, and enum values
• Verify CI api-spec check passes
• Verify coding standards and tests pass

🤖 Generated with Claude Code

[github-actions]

API Specification - Breaking changes detected

API Changelog 0.0.0 vs. 1.0.0

API Changes

POST /api/detection_results

• ⚠️ request property 'type' was restricted to a list of enum values (media type: application/ld+json)
• ⚠️ request property 'type' was restricted to a list of enum values (media type: application/json)
• ⚠️ the 'type' request property type/format changed from 'string'/'' to ''/'' (media type: application/ld+json)
• ⚠️ the 'type' request property type/format changed from 'string'/'' to ''/'' (media type: application/json)
• the 'type' request property default value '' was removed (media type: application/json)
• the 'type' request property default value '' was removed (media type: application/ld+json)
• added the new 'dir' enum value to the request property 'type' (media type: application/ld+json)
• added the new 'dir' enum value to the request property 'type' (media type: application/json)
• added the new 'docker' enum value to the request property 'type' (media type: application/json)
• added the new 'docker' enum value to the request property 'type' (media type: application/ld+json)
• added the new 'drupal' enum value to the request property 'type' (media type: application/ld+json)
• added the new 'drupal' enum value to the request property 'type' (media type: application/json)
• added the new 'git' enum value to the request property 'type' (media type: application/ld+json)
• added the new 'git' enum value to the request property 'type' (media type: application/json)
• added the new 'nginx' enum value to the request property 'type' (media type: application/json)
• added the new 'nginx' enum value to the request property 'type' (media type: application/ld+json)
• added the new 'symfony' enum value to the request property 'type' (media type: application/json)
• added the new 'symfony' enum value to the request property 'type' (media type: application/ld+json)
• added the non-success response with the status '401'
• added the non-success response with the status '403'

[codecov-commenter]

Codecov Report

❌ Patch coverage is 10.00000% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 12.60%. Comparing base (bac1888) to head (7fd86a6).

Files with missing lines	Patch %	Lines
src/OpenApi/OpenApiFactory.php	10.00%	9 Missing ⚠️

Additional details and impacted files

@@                       Coverage Diff                       @@
##             feature/6869_agent_config      #64      +/-   ##
===============================================================
- Coverage                        12.61%   12.60%   -0.02%     
- Complexity                         819      827       +8     
===============================================================
  Files                              118      119       +1     
  Lines                             2560     2570      +10     
===============================================================
+ Hits                               323      324       +1     
- Misses                            2237     2246       +9     

Flag	Coverage Δ
unittests	12.60% <10.00%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.