Skip to content

Tags: nelmio/NelmioApiDocBundle

Tags

v5.0.0-beta3

Toggle v5.0.0-beta3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
chore: [5.x] remove deprecations (#2388)

## Description

Removes all deprecations from `4.x`

## What type of PR is this? (check all applicable)
- [ ] Bug Fix
- [ ] Feature
- [ ] Refactor
- [ ] Deprecation
- [x] Breaking Change
- [ ] Documentation Update
- [ ] CI

## Checklist
- [ ] I have made corresponding changes to the documentation (`docs/`)
- [x] I have made corresponding changes to the changelog
(`CHANGELOG.md`)

v4.33.4

Toggle v4.33.4's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
refactor: deprecate `options` possibly being null (#2387)

## Description

Deprecates `options` nullable type for `Model` classes. This reduces
complexity and streamlines it with the `$serializationContext`.

## What type of PR is this? (check all applicable)
- [ ] Bug Fix
- [ ] Feature
- [x] Refactor
- [x] Deprecation
- [ ] Breaking Change
- [ ] Documentation Update
- [ ] CI

## Checklist
- [ ] I have made corresponding changes to the documentation (`docs/`)
- [x] I have made corresponding changes to the changelog
(`CHANGELOG.md`)

v5.0.0-beta2

Toggle v5.0.0-beta2's commit message
fix: incorrect directory used for updated swagger-ui (#2379)

## Description

Fixes incorrect directory used for updated swagger-ui files introduced
in #2378

## What type of PR is this? (check all applicable)
- [x] 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`)

(cherry picked from commit 9d74fa9)

v4.33.3

Toggle v4.33.3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
chore(deps): bump redoc from 2.0.0 to 2.2.0 in /utils (#2383)

Bumps [redoc](https://github.com/Redocly/redoc) from 2.0.0 to 2.2.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/Redocly/redoc/releases">redoc's
releases</a>.</em></p>
<blockquote>
<h2>2.2.0</h2>
<h1><a
href="https://github.com/Redocly/redoc/compare/v2.1.5...v2.2.0">2.2.0</a>
(2024-10-16)</h1>
<h3>Bug Fixes</h3>
<ul>
<li>show siblings schema with oneOf (<a
href="https://redirect.github.com/Redocly/redoc/issues/2576">#2576</a>)
(<a
href="https://github.com/Redocly/redoc/commit/60d131b0a9dab4710e900323c9ba81160cecf7d8">60d131b</a>)</li>
</ul>
<h3>Features</h3>
<ul>
<li>add support x-badges (<a
href="https://redirect.github.com/Redocly/redoc/issues/2605">#2605</a>)
(<a
href="https://github.com/Redocly/redoc/commit/64f18779e5fe7e03f25862463cbc5062e85c867c">64f1877</a>)</li>
</ul>
<h2>2.1.5</h2>
<h3>Bug Fixes</h3>
<ul>
<li>update react to 18 and react-tabs to 6 (<a
href="https://redirect.github.com/Redocly/redoc/issues/2547">#2547</a>)
(<a
href="https://github.com/Redocly/redoc/commit/c664dd0d56571ce799b8eadd081d86a6b2cdefae">c664dd0</a>)</li>
</ul>
<h2>2.1.4</h2>
<h3>Bug Fixes</h3>
<ul>
<li>add deprecated css to clickable property name (<a
href="https://redirect.github.com/Redocly/redoc/issues/2526">#2526</a>)
(<a
href="https://github.com/Redocly/redoc/commit/b0d03d02069c1508447ddebc2f8a3fffa9b03ce5">b0d03d0</a>)</li>
<li>use h2/h3 for headings instead of h1/h2 for better seo (<a
href="https://redirect.github.com/Redocly/redoc/issues/2514">#2514</a>)
(<a
href="https://github.com/Redocly/redoc/commit/2b72dc0e90f759a8ee2e47691c844e7f05928a24">2b72dc0</a>)</li>
<li>security vulnerability (<a
href="https://redirect.github.com/Redocly/redoc/pull/2445">#2445</a>)
(<a
href="https://github.com/Redocly/redoc/commit/1f11f597c4f10ddd601db247f5034052b6ca689f">1f11f5</a>)</li>
</ul>
<h2>2.1.3</h2>
<h3>Bug Fixes</h3>
<ul>
<li>default value as object in request body (<a
href="https://redirect.github.com/Redocly/redoc/issues/2437">#2437</a>)
(<a
href="https://github.com/Redocly/redoc/commit/b36a6e27bb3e03d39ee74c3e71f18a504539d91b">b36a6e2</a>)</li>
<li>display string pattern in array items (<a
href="https://redirect.github.com/Redocly/redoc/issues/2438">#2438</a>)
(<a
href="https://github.com/Redocly/redoc/commit/8ddeb6dfda686ec8a6948eb2d96efb99bf422429">8ddeb6d</a>)</li>
<li>hideRequestPayloadSample (<a
href="https://redirect.github.com/Redocly/redoc/issues/2436">#2436</a>)
(<a
href="https://github.com/Redocly/redoc/commit/bf960612a47bfe10ff205b9d78f3040515a5467d">bf96061</a>)</li>
<li>more cases for react18 and cli integration (<a
href="https://redirect.github.com/Redocly/redoc/issues/2416">#2416</a>)
(<a
href="https://github.com/Redocly/redoc/commit/26674e70c66b686d0f0baa569b186292c41e5726">26674e7</a>)</li>
</ul>
<h2>2.1.2</h2>
<h2><a
href="https://github.com/Redocly/redoc/compare/v2.1.1...v2.1.2">2.1.2</a>
(2023-09-11)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>react18 cli integration (<a
href="https://redirect.github.com/Redocly/redoc/issues/2404">#2404</a>)
(<a
href="https://github.com/Redocly/redoc/commit/76edc159399150778b384be87ee958a93e5c491c">76edc15</a>)</li>
<li>style RefreshToken URL as <code>&lt;code&gt;</code> in the
authorization section (<a
href="https://github.com/Redocly/redoc/commit/1d6100111a0f3b609dadbd706354ce6125947df2">1d61001</a>)</li>
</ul>
<h2>2.1.1</h2>
<h2><a
href="https://github.com/Redocly/redoc/compare/v2.1.0...v2.1.1">2.1.1</a>
(2023-08-17)</h2>
<h3>Bug Fixes</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/Redocly/redoc/blob/main/CHANGELOG.md">redoc's
changelog</a>.</em></p>
<blockquote>
<h1><a
href="https://github.com/Redocly/redoc/compare/v2.1.5...v2.2.0">2.2.0</a>
(2024-10-16)</h1>
<h3>Bug Fixes</h3>
<ul>
<li>show siblings schema with oneOf (<a
href="https://redirect.github.com/Redocly/redoc/issues/2576">#2576</a>)
(<a
href="https://github.com/Redocly/redoc/commit/60d131b0a9dab4710e900323c9ba81160cecf7d8">60d131b</a>)</li>
</ul>
<h3>Features</h3>
<ul>
<li>add support x-badges (<a
href="https://redirect.github.com/Redocly/redoc/issues/2605">#2605</a>)
(<a
href="https://github.com/Redocly/redoc/commit/64f18779e5fe7e03f25862463cbc5062e85c867c">64f1877</a>)</li>
</ul>
<h2><a
href="https://github.com/Redocly/redoc/compare/v2.1.4...v2.1.5">2.1.5</a>
(2024-06-10)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>update react to 18 and react-tabs to 6 (<a
href="https://redirect.github.com/Redocly/redoc/issues/2547">#2547</a>)
(<a
href="https://github.com/Redocly/redoc/commit/c664dd0d56571ce799b8eadd081d86a6b2cdefae">c664dd0</a>)</li>
</ul>
<h2><a
href="https://github.com/Redocly/redoc/compare/v2.1.3...v2.1.4">2.1.4</a>
(2024-04-25)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>add deprecated css to clickable property name (<a
href="https://redirect.github.com/Redocly/redoc/issues/2526">#2526</a>)
(<a
href="https://github.com/Redocly/redoc/commit/b0d03d02069c1508447ddebc2f8a3fffa9b03ce5">b0d03d0</a>)</li>
<li>use h2/h3 for headings instead of h1/h2 for better seo (<a
href="https://redirect.github.com/Redocly/redoc/issues/2514">#2514</a>)
(<a
href="https://github.com/Redocly/redoc/commit/2b72dc0e90f759a8ee2e47691c844e7f05928a24">2b72dc0</a>)</li>
<li>security vulnerability (<a
href="https://redirect.github.com/Redocly/redoc/pull/2445">#2445</a>)
(<a
href="https://github.com/Redocly/redoc/commit/1f11f597c4f10ddd601db247f5034052b6ca689f">1f11f5</a>)</li>
</ul>
<h2><a
href="https://github.com/Redocly/redoc/compare/v2.1.2...v2.1.3">2.1.3</a>
(2023-10-24)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>default value as object in request body (<a
href="https://redirect.github.com/Redocly/redoc/issues/2437">#2437</a>)
(<a
href="https://github.com/Redocly/redoc/commit/b36a6e27bb3e03d39ee74c3e71f18a504539d91b">b36a6e2</a>)</li>
<li>display string pattern in array items (<a
href="https://redirect.github.com/Redocly/redoc/issues/2438">#2438</a>)
(<a
href="https://github.com/Redocly/redoc/commit/8ddeb6dfda686ec8a6948eb2d96efb99bf422429">8ddeb6d</a>)</li>
<li>hideRequestPayloadSample (<a
href="https://redirect.github.com/Redocly/redoc/issues/2436">#2436</a>)
(<a
href="https://github.com/Redocly/redoc/commit/bf960612a47bfe10ff205b9d78f3040515a5467d">bf96061</a>)</li>
<li>more cases for react18 and cli integration (<a
href="https://redirect.github.com/Redocly/redoc/issues/2416">#2416</a>)
(<a
href="https://github.com/Redocly/redoc/commit/26674e70c66b686d0f0baa569b186292c41e5726">26674e7</a>)</li>
</ul>
<h2><a
href="https://github.com/Redocly/redoc/compare/v2.1.1...v2.1.2">2.1.2</a>
(2023-09-11)</h2>
<h3>Bug Fixes</h3>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/Redocly/redoc/commit/1593d01936054e5633e4ca8c014f34d28d320813"><code>1593d01</code></a>
fix: docker build (<a
href="https://redirect.github.com/Redocly/redoc/issues/2607">#2607</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/4736c54eddeb06af8966d714bf94cdbd9701e6b2"><code>4736c54</code></a>
chore: v2.2.0 (<a
href="https://redirect.github.com/Redocly/redoc/issues/2606">#2606</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/64f18779e5fe7e03f25862463cbc5062e85c867c"><code>64f1877</code></a>
feat: add support x-badges (<a
href="https://redirect.github.com/Redocly/redoc/issues/2605">#2605</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/1cceed4b471a4530b648c00941e7201f656b5b72"><code>1cceed4</code></a>
chore(deps): bump dompurify from 3.0.6 to 3.1.3 (<a
href="https://redirect.github.com/Redocly/redoc/issues/2602">#2602</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/c0c68206de804d85b8bde32f1a2676f72abd0a8d"><code>c0c6820</code></a>
chore(deps): bump body-parser and express (<a
href="https://redirect.github.com/Redocly/redoc/issues/2603">#2603</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/d193dd2627b88309eca3cec4973ba5bea2906740"><code>d193dd2</code></a>
chore: Remove the sync job, we don't use it any more (<a
href="https://redirect.github.com/Redocly/redoc/issues/2591">#2591</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/c04b4c8fecbb07826cadf0ee599b82c11e2568a9"><code>c04b4c8</code></a>
docs: Remove the old zero-dependency claim for Redoc docs (<a
href="https://redirect.github.com/Redocly/redoc/issues/2590">#2590</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/c0203be04555883b4247c38c068fa1d55dd10483"><code>c0203be</code></a>
chore: upgrade node version for docker (<a
href="https://redirect.github.com/Redocly/redoc/issues/2589">#2589</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/c813eeac04da3434102a996f67ea7447ade3420f"><code>c813eea</code></a>
docs: fix http-server example from in-page feedback (<a
href="https://redirect.github.com/Redocly/redoc/issues/2580">#2580</a>)</li>
<li><a
href="https://github.com/Redocly/redoc/commit/60d131b0a9dab4710e900323c9ba81160cecf7d8"><code>60d131b</code></a>
fix: show siblings schema with oneOf (<a
href="https://redirect.github.com/Redocly/redoc/issues/2576">#2576</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/Redocly/redoc/compare/v2.0.0...v2.2.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=redoc&package-manager=npm_and_yarn&previous-version=2.0.0&new-version=2.2.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com>

v4.33.2

Toggle v4.33.2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
fix: incorrect directory used for updated swagger-ui (#2379)

## Description

Fixes incorrect directory used for updated swagger-ui files introduced
in #2378

## What type of PR is this? (check all applicable)
- [x] 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`)

v4.33.1

Toggle v4.33.1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
fix: override code based defaults with explicit ones (#2377)

## Description

This change allows that defaults that are set in attributes can override
the ones that are read from the code.

This fixes #2330

Closes #2330

## What type of PR is this? (check all applicable)
- [x] 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`)

v4.33.0

Toggle v4.33.0's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
feat: add support for name based serialisation of JMS enums (#2355)

| Q | A |

|---------------|---------------------------------------------------------------------------------------------------------------------------|
| Bug fix? | no |
| New feature? | yes <!-- please update src/**/CHANGELOG.md files --> |
| Deprecations? | no <!-- please update UPGRADE-*.md and
src/**/CHANGELOG.md files --> |
| Issues | - <!-- prefix each issue number with "Fix #", no need to
create an issue if none exists, explain below instead --> |

<!--
Replace this notice by a description of your feature/bugfix.
This will help reviewers and should be a good start for the
documentation.

Additionally:
 - Always add tests and ensure they pass.
- For new features, provide some code snippets to help understand usage.
-->

This PR add a method to detect when the developer has annotated their
property with a JMS type that specifies that the backed enum needs to be
serialized with its name instead of value. I needed to use the
serialization context as the model options are not included in the model
hash, while I do need to generate a new unique description. I've chosen
to append `Name` to the resulting Model name.

Depends on #2372

v5.0.0-beta1

Toggle v5.0.0-beta1's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
feat: [5.x] attribute consistency (#2368)

Cleanup various references to annotations to their attribute variant

#2215

v4.32.3

Toggle v4.32.3's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
feat: 4.x annotation to attribute migration 5.x (#2369)

| Q | A |

|---------------|---------------------------------------------------------------------------------------------------------------------------|
| Bug fix? | no |
| New feature? | no <!-- please update src/**/CHANGELOG.md files --> |
| Deprecations? | yes                                                  |

Migration for annotations to attributes
#2368 (comment)

v4.32.2

Toggle v4.32.2's commit message

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
fix: add missing trigger_deprecation calls to deprecated classes, met…

…hods (#2265)

| Q             | A   |
|---------------|-----|
| Bug fix?      | no  |
| New feature?  | no  |
| Deprecations? | yes |
| Issues        | /   |

Adds missing deprecation triggers to classes and methods that have been
deprecated with a `@deprecated` annotation.

---------

Co-authored-by: djordy <[email protected]>