feat: add possibility to ignore properties from schema

[DominicLuidold]

Description

Adds a #[Ignore] attribute that allows a property to be excluded from the generated schema.

Closes #2306

What type of PR is this? (check all applicable)

• Bug Fix
• Feature
• Refactor
• Deprecation
• Breaking Change
• Documentation Update
• CI

Checklist

• I have made corresponding changes to the documentation (docs/)
• I have made corresponding changes to the changelog (CHANGELOG.md)

[DominicLuidold]

@DjordyKoert This is the initial implementation of the feature — it's a very basic, functional version but still requires significant work.

I’d appreciate your input on a couple of points:

• Is the ObjectModelDescriber the right place to handle the attribute?
• Where would be the best location to integrate logic for handling the annotation in environments using PHP <8.0?

Looking forward to your feedback!

[DjordyKoert]

Is the ObjectModelDescriber the right place to handle the attribute?

Probably not, this would prevent the attribute from working on other environments (Hateoas / JMS / Form). I think you can add a new method. I think its easiest to add a new method to https://github.com/nelmio/NelmioApiDocBundle/blob/master/src/ModelDescriber/Annotations/AnnotationsReader.php (something like shouldDescribeProperty()).

Where would be the best location to integrate logic for handling the annotation in environments using PHP <8.0?

IMO annotation logic for PHP <8.0 isn't necessary to reduce complexity & annotations are about to be removed in 5.x

[DominicLuidold]

@DjordyKoert I've updated the implementation and added some tests. Could you please give it a quick look if this approach works better?

If so, I'd look into the failing tests that are mainly related to Symfony 5.4 🤔

[DjordyKoert]

@DjordyKoert I've updated the implementation and added some tests. Could you please give it a quick look if this approach works better?

If so, I'd look into the failing tests that are mainly related to Symfony 5.4 🤔

Looking good 😄

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.22%. Comparing base (8b4803f) to head (dfe2ca1).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2416      +/-   ##
==========================================
+ Coverage   90.18%   90.22%   +0.03%     
==========================================
  Files          94       94              
  Lines        3067     3079      +12     
==========================================
+ Hits         2766     2778      +12     
  Misses        301      301              

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

[DominicLuidold]

@DjordyKoert Thanks for your input, the PR should be ready to review now 😄