Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
2408e64
graphql.md: add "MediaObject Normalization" chapter (#2109)
timble-one Sep 15, 2025
fd44e8f
Merge 4.1
soyuka Sep 16, 2025
7990e10
docs: fix small typo (#2205)
florentdrousset Sep 16, 2025
d423095
Update openapi.md (#2042)
rnbw-spctrm Sep 17, 2025
8410d87
Merge 4.1 (#2206)
vinceAmstoutz Sep 17, 2025
0f90473
4.2 branch
soyuka Sep 17, 2025
d840a9c
Update from 'attributes' to 'properties' (#2195)
kentrichards Sep 19, 2025
17d371c
docs(openapi): refacto override OpenAPI section (#2207)
maxhelias Sep 22, 2025
df2f502
docs(core/operations): update explanation about omitting GET item ope…
ttskch Oct 8, 2025
ed00f67
docs(core/extensions): add eloquent support (#2208)
ttskch Oct 8, 2025
263c804
Remove invalid tip about #[GetCollection] alias (#2215)
rvanlaak Oct 8, 2025
e39b731
docs: metadata mutators (#2228)
NathanPesneau Nov 25, 2025
6f09119
docs: add missing "docs_formats" configuration for Symfony (#2226)
creocoder Nov 25, 2025
e98c7fb
Fix invalid YAML in example in core/state-processors.md and state-pro…
xalopp Nov 25, 2025
e34dfd7
docs: update UUID recommendation to v7 for better database performanc…
OlivierBarbier Nov 25, 2025
97b274e
document property filter back (#2220)
soyuka Nov 25, 2025
a0e1317
Update releases information (#2232)
xammmue Dec 4, 2025
323e977
improve dto documentation (#2231)
soyuka Dec 4, 2025
6a249e8
Merge 4.1
soyuka Dec 4, 2025
ff2ccb4
update docs
soyuka Dec 4, 2025
ba8d387
fix #1749
soyuka Dec 5, 2025
9e67aec
document enums as resource
soyuka Dec 5, 2025
67485f7
fix #1856
soyuka Dec 5, 2025
d7c1d74
bootstrap
soyuka Dec 5, 2025
8aaa843
fix #2230
soyuka Dec 5, 2025
5dd857b
fix #2221
soyuka Dec 5, 2025
812d718
fix #2189
soyuka Dec 5, 2025
54ef2ac
doc(provider): show how to enable link security to be able to use Rea…
Cryde Dec 5, 2025
3011261
docs(filters): document enhanced QueryParameter syntax on old filters…
vinceAmstoutz Dec 5, 2025
2e12e24
default fixup
soyuka Dec 5, 2025
9bb4738
lint
soyuka Dec 5, 2025
c671247
restore max depth + prettier
soyuka Dec 5, 2025
a6375a4
max-length 100 prettier
soyuka Dec 5, 2025
d0a2717
max-length prettier
soyuka Dec 5, 2025
c619f82
max-length markdown
soyuka Dec 5, 2025
17aac72
lint
soyuka Dec 5, 2025
68dfcfe
Document Deprecation HTTP Header usage (#2233)
aaa2000 Dec 8, 2025
ffef094
doc(mutator): fix typo (#2234)
Jean-Beru Dec 19, 2025
4775684
fix(core/bootstrap): note formatting (#2235)
vinceAmstoutz Dec 19, 2025
e61eec1
fix api-platform/core/pull/5606
soyuka Jan 26, 2026
bb66780
fix: typo “through” (#2243)
alexislefebvre Jan 27, 2026
f1c33c3
docs: mention symfony/object-mapper:^8.0 (#2238)
alexislefebvre Jan 27, 2026
d724e5a
docs: clarify pagination_client_enabled configuration (#2237)
mdavid-dev Jan 27, 2026
fa2534e
docs: rewrite intro to DTO (#2244)
alexislefebvre Jan 27, 2026
2d2a5dd
cs (#2246)
soyuka Jan 27, 2026
04bdd63
doc: refactor BlogPostProvider examples (#2239)
alexislefebvre Jan 27, 2026
6efe91c
docs: fix links to Hoppscotch and remove duplicated line (#2245)
alexislefebvre Jan 27, 2026
eb4a006
cs
soyuka Jan 27, 2026
0e3611e
feat: update php version on workflow
ginifizz Jan 29, 2026
badbbc1
docs: update vich example to use the Attribute namespace instead (#2250)
cngJo Feb 9, 2026
7cd27ed
feat: add global defaults.normalization_context.gen_id configuration …
Feb 17, 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
11 changes: 2 additions & 9 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,29 @@ indent_style = space
indent_size = 2

[*.md]
max_line_length = 100
trim_trailing_whitespace = false
indent_size = 4

[*.neon]
indent_style = tab
indent_size = 4

[*.xml]
indent_style = space
indent_size = 4

[*.{yaml,yml}]
indent_style = space
indent_size = 2
trim_trailing_whitespace = false

[.circleci/config.yml]
indent_style = space
indent_size = 2

[.github/workflows/*.yml]
indent_style = space
indent_size = 2

[.gitmodules]
indent_style = tab

[.proselintrc]
indent_style = space
indent_size = 2

[.travis.yml]
indent_style = space
indent_size = 2
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/1_Support_question.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ about: See https://api-platform.com/support/ for questions about using API Platf

# Support question

We use GitHub issues only to discuss bugs and new features.
For this kind of questions about using API Platform, please use
any of the support alternatives shown in [API Platform support](https://api-platform.com/support/).
We use GitHub issues only to discuss bugs and new features. For this kind of questions about using
API Platform, please use any of the support alternatives shown in
[API Platform support](https://api-platform.com/support/).

Thanks!
2 changes: 1 addition & 1 deletion .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
- name: Install php
uses: shivammathur/setup-php@v2
with:
php-version: "8.2"
php-version: "8.4"
tools: phive

- name: Auth gcloud
Expand Down
60 changes: 40 additions & 20 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,29 +9,12 @@ permissions:
contents: read

jobs:
build:
name: Lint
proselint:
name: Prose Lint
runs-on: ubuntu-latest

permissions:
contents: read
packages: read
statuses: write

steps:
- name: Checkout
- name: Checkout code
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Lint
uses: super-linter/super-linter/slim@v7
env:
VALIDATE_EDITORCONFIG: false
VALIDATE_JSCPD: false
VALIDATE_MARKDOWN_PRETTIER: false
DEFAULT_BRANCH: "origin/4.1"
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- uses: actions/cache@v4
with:
Expand All @@ -45,3 +28,40 @@ jobs:

- name: Run Proselint
run: find . -name '*.md' -exec proselint {} \;
lint:
name: Lint
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- uses: DavidAnson/markdownlint-cli2-action@v21
with:
globs: '**/*.md'

prettier-format:
name: Prettier
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'

- name: Prettier Dry Run
run: |
npx prettier --check "**/*.md" || {
echo "::error title=Formatting Failed::Some files are not formatted correctly."
echo "-------------------------------------------------------"
echo "❌ CHECK FAILED"
echo "To fix these issues, run the following command locally:"
echo ""
echo " npx prettier --write \"**/*.md\" --prose-wrap always"
echo ""
echo "-------------------------------------------------------"
exit 1
}
13 changes: 13 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
MD013:
line_length: 1000
code_blocks: false
tables: false
no-inline-html:
allowed_elements: [a, p, img, br, code-selector, video, source, iframe, h1]
MD046:
style: fenced
MD004:
style: dash
MD007:
indent: 4
5 changes: 0 additions & 5 deletions .markdownlint.yml

This file was deleted.

4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"printWidth": 100,
"proseWrap": "always"
}
40 changes: 24 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

First of all, thank you for contributing, you're awesome!

To have your code integrated in the API Platform documentation project, there are some rules to follow, but don't panic, it's easy!
To have your code integrated in the API Platform documentation project, there are some rules to
follow, but don't panic, it's easy!

## Reporting Bugs in the documentation

Expand All @@ -12,29 +13,36 @@ Before submitting your issue:
- A clear title to resume the issue
- A description of the workflow needed to reproduce the bug

> [!NOTE]
> Don't hesitate giving as much information as you can.
> [!NOTE] Don't hesitate giving as much information as you can.

## Code of Conduct

By contributing to this project, you agree to abide by our [Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to foster a welcoming and inclusive environment.
By contributing to this project, you agree to abide by our
[Code of Conduct](https://github.com/api-platform/docs#coc-ov-file). We expect all contributors to
foster a welcoming and inclusive environment.

## How to Contribute

1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs` repository page.
1. Fork this repository by clicking the "Fork" button at the top right of the `api-platform/docs`
repository page.

2. Clone the forked repository to your local machine:
```console
git clone https://github.com/your-username/repository-name.git
```

```console
git clone https://github.com/your-username/repository-name.git
```

3. Create a new branch for your contribution:
```console
git switch -c docs-your-branch-name
```

```console
git switch -c docs-your-branch-name
```

4. Commit and push your changes
5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the nature of the change.
See [the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).
5. Submit a Pull Request. You must decide on what branch your changes will be based depending of the
nature of the change. See
[the dedicated documentation entry](https://api-platform.com/docs/extra/releases/).

> [!TIP]
> You can also contribute to improving the documentation directly by clicking on the
> **"You can also help us improve the documentation of this page."** link, located at the end of each documentation page.
> [!TIP] You can also contribute to improving the documentation directly by clicking on the **"You
> can also help us improve the documentation of this page."** link, located at the end of each
> documentation page.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

[![Lint](https://github.com/api-platform/docs/actions/workflows/ci.yml/badge.svg)](https://github.com/api-platform/docs/actions/workflows/ci.yml)

Welcome to the official documentation for [API Platform](https://api-platform.com), a powerful framework for building APIs and web applications.
Welcome to the official documentation for [API Platform](https://api-platform.com), a powerful
framework for building APIs and web applications.

This repository contains all the API Platform documentation resources.

## Contributing

Please check our [CONTRIBUTING file](/CONTRIBUTING.md) to contribute.

Loading
Loading