Skip to content

ci(codeql): exclude ContractApi test fixture from alerts #214

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

Merged
Erlend Ellefsen (erlendellefsen) merged 2 commits into from
Sep 3, 2026
+7 −0
Merged

ci(codeql): exclude ContractApi test fixture from alerts #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d08ecf
ci(codeql): exclude ContractApi test fixture from alerts
dakristia Sep 2, 2026
8e5449c
docs(security): state that auth is the consuming app's responsibility
dakristia Sep 2, 2026
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
4 changes: 4 additions & 0 deletions .github/codeql/codeql-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,7 @@ name: "JsonApiToolkit CodeQL"
paths-ignore:
- "**/bin/**"
- "**/obj/**"
# Localhost-only contract-test fixture with in-memory seeded data.
# Not deployed and not a usage showcase, so auth alerts on it are noise.
# Authentication and authorization belong to the consuming application.
- "samples/ContractApi/**"
3 changes: 3 additions & 0 deletions docs/security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Guidance for using JsonApiToolkit safely: restricting includes, configuring quer
> [!NOTE]
> To **report a vulnerability** in JsonApiToolkit itself, see the [Security Policy](https://github.com/intility/json-api-toolkit/blob/main/SECURITY.md). This page is about using the toolkit securely.

> [!NOTE]
> JsonApiToolkit does not perform authentication or authorization. It builds queries and serializes responses inside your controllers. Protecting endpoints with `[Authorize]`, policies, and per-resource ownership checks is the responsibility of the consuming application.

## `[AllowedIncludes]`

Without `[AllowedIncludes]`, every navigation property on your entities is includable via `?include=`. That can leak sensitive relationships and run expensive queries. The attribute restricts which relationships clients can request.
Expand Down