[dependabot]

Bumps zircote/swagger-php from 6.16.0 to 6.18.0.

Release notes

Sourced from zircote/swagger-php's releases.

6.18.0

Spec freeze

The spec attribute API is frozen. Existing attributes keep their shape from here on, and new fields and attributes may still be added. Builder is the stable entry point for every mode, and builds one document per instance. (#2299)

Spec and hybrid mode stay beta until v7, since the documents they generate may still change until spec becomes the default.

Spec pipeline

Required properties and defaults from PHP

Spec mode fills an object schema's required list and its properties' default from the PHP declarations. (#2296)

#[OA\Schema]
class Pet
{
    public function __construct(
        public int $id,
        public ?string $tag,
        public Status $status = Status::Available,
        public int $limit = 20,
    ) {}
}

Here id is required, status defaults to the case's value and limit to 20.

A property is required when its PHP type is not nullable and it has no default. Its PHP default becomes the schema default where the document can hold it: scalars, enum cases and arrays of them. null is skipped, and so is a value the schema's type does not allow. An explicit required or default on the attribute is kept as written. Classic annotations are not affected, in classic or in hybrid mode.

Smaller changes

• {method} in an explicit operationId is expanded by a new Augmenter\OperationIdTemplates. Before, Augmenter\OperationIds did that, so a pipeline removing it to stop generated ids also kept the templates as written, and the ids of split operations collided. (#2290)
• An invokable controller with methods: on its class gives the attributes on __invoke's parameters to every split operation, as a method does. Before, they were reported as ambiguous and the class was left out. (#2291)
• A member that fails to assemble is left out with a warning, and the rest of its class is kept. Before, the whole class went, and an inherited method under a path item failed the build. Without a logger the error is still thrown. (#2292)
• A $ref is checked in every document. A pointer to a component that does not exist is reported, and a bare name that matches a component gets a warning with the pointer to use. (#2288)
• A property or parameter typed with a class that has no schema, a value object for example, gets a warning naming the class and the member. (#2295)
• Hybrid mode reports annotations nothing can hold, and a second one where only one is allowed, in classic's words. Before, they were dropped without a warning. (#2287)

All modes

• Docblock type keywords are read in any case, so @var String and @var ?Int keep their type. A docblock type that still cannot be read is reported. (#2289)
• A class implementing DateTimeInterface, such as a DateTimeImmutable subclass, is a string with format date-time. Before, it was an empty schema. (#2293)
• A Schema, Type or Format in properties: without a string key throws, instead of passing through as an unnamed entry. (#2286)

Output changes

Required properties and defaults

This changes spec output. Most object schemas gain a required list, and properties with a PHP default gain a default. Spec output now differs from classic for most documents, and the migration guide no longer promises an identical one. (#2296)

... (truncated)

Commits

• c93b743 docs: declare the attribute API frozen and Builder the stable entry point (...
• 0eb3005 fix(Augmenter): an explicit type drops the PHP type's null (#2298)
• 60350a6 fix(Augmenter): a parameter with a PHP default is not required (#2297)
• 0725edc feat(Augmenter): infer required and default from PHP declarations (#2296)
• 9e1fbec fix(Augmenter): warn when a class type has no schema (#2295)
• a9f4a06 fix(Type): map a DateTimeInterface subclass to date-time (#2293)
• ed5bba6 chore(deps-dev): bump @​redocly/cli (#2294)
• b0e6aad fix(Assembler): leave out a member that fails assembly, not its class (#2292)
• 841ced4 fix(Assembler): fan out __invoke's parameters for a methods: operation on its...
• ad457ce fix(Augmenter): expand operationId templates in an augmenter of their own (#2...
• Additional commits viewable in compare view

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 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)