Add lazy option to component registration methods. This allows to add
components to the spec only if they are actually referenced. (:pr:702)
Add BasePlugin.header_helper and MarshmallowPlugin.header_helper
(:pr:703).
Bug fixes:
Ensure plugin helpers get component copies. Avoids issues if a plugin helper
mutates its inputs. (:pr:704)
5.0.0 (2021-07-29)
Features:
Rename doc_default to default. Since schema metadata is namespaced in
a single metadata parameter, there is no name collision with default
parameter anymore (:issue:687).
Don't build schema component reference in
OpenAPIConverter.resolve_nested_schema. This is done later in
Components (:pr:700).
MarshmallowPlugin: resolve schemas in allOf, oneOf, anyOf and
not (:pr:701). Thanks :user:stefanv for the initial work on this.
Other changes:
Refactor Components methods to make them consistent. Use component_id
rather than name, remove **kwargs when unused. (:pr:696)
5.0.0b1 (2021-07-22)
Features:
Resolve all component references in paths and components. All references must
be passed as strings, not as a {$ref: '...'}} dict (:pr:671).
Other changes:
Don't use deprecated missing marshmallow field attribute but use
load_default instead (:pr:692).
Refactor references resolution. get_ref method is moved from APISpec
to Components (:pr:655). APISpec.clean_parameters and
APISpec.clean_parameters are now private methods (:pr:695).
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 commands and options
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 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)
Bumps apispec from 4.7.1 to 5.1.0.
Changelog
Sourced from apispec's changelog.
Commits
9c6f120
Bump version and update CHANGELOG45b2dfc
Merge pull request #704 from marshmallow-code/plugin_helpers_get_copies41bdfa0
Ensure plugin helpers get component copies5932e61
Merge pull request #703 from marshmallow-code/header_helper521bee2
Add MarshmallowPlugin.header_helpera4065c0
Improve MarshmallowPlugin.parameter_helper tests8af46c4
Add BasePlugin.header_helperd5cd8ab
Merge pull request #702 from marshmallow-code/lazy_components0d659b2
Update docs about components lazy registration129abc2
Lazy component registrationDependabot 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 commands and options
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 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)