Skip to content

feat!: throw exception when an operation is not declared in ApiResource for parameter attributes on properties #2346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Maxcastel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat!: throw exception when an operation is not declared in ApiResource for parameter attributes on properties #2346

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion core/filters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ class Book
#[QueryParameter(key: 'name', filter: new PartialSearchFilter(), operations: [new GetCollection()])]
public string $name = '';

// Applies only to GetCollection (Patch is not in the list of operations)
// Error: Patch is not declared in the resource operations
#[HeaderParameter(key: 'X-Authorization', operations: [new GetCollection(), new Patch()])]
public string $authToken = '';
}
Expand All @@ -354,6 +354,9 @@ The restriction matches on the operation class, not on a single configured opera
declares two `Get` operations with different URI templates, `operations: [new Get()]` applies the
parameter to both of them.

Every operation listed in `operations` must be declared in the resource operations, otherwise an
error is thrown.

### Filtering a Single Property

Most of the time, a parameter maps directly to a property on your resource. For example, a
Expand Down
Loading