NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist
Packagist, #3314 most downloaded on Packagist
An object oriented approach to generating OpenAPI specs, implemented in PHP.
Latest stable
v2.10.0
Last release 4 years ago
no release in 18 months
Release timing varies
gaps range from 3 weeks to 1.5 years
Nearly every release is documented
notes for 27 of 27 stable releases
Nothing withdrawn
no release was ever pulled
8 years old
27 releases · first in 2018
Drag across the ruler to compare, or tap a release to open it.
### Changed - #57 - The Schema::properties() method now accepts SchemaContract instances. ### Fixed - #57 - CI pipeline fixed (dev dependencies update
Schema::properties() method now accepts SchemaContract instances.### Added * #55 - Add ReturnTypeWillChange attributes and add workflows for PHP 8.0 and PHP 8.1.
ReturnTypeWillChange attributes and add workflows for PHP 8.0 and PHP 8.1.Build pipeline switched from Travis CI to GitHub Actions.
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Methods that returned $this now have their DocBlock updated to @return static for better IDE handling in client code that extends these classes.
$this now have their DocBlock updated to @return static for better IDE handling in client code that extends these classes.Added validate() method to OpenApi object.
validate() method to OpenApi object.Callbacks now correctly output when converting to array/JSON.
Callbacks are now supported in the Components object.
Components object.Callbacks are now supported in the Operation object.
Operation object.Added support for specification extensions (^x-).
^x-).Thrown exceptions now have meaningful messages to help when debugging.
Properties that should accept numeric (integer and float) values , but only allowed integers, now allow for both integers and floats.
Added formUrlEncoded() creation method in MediaType object (for application/x-www-form-urlencoded request bodies).
formUrlEncoded() creation method in MediaType object (for application/x-www-form-urlencoded request bodies).The branching strategy no longer makes use of the develop branch. Instead all feature/hotfix branches should be based off of master.
develop branch. Instead all feature/hotfix branches should be based off of master.test script now makes reference to the individual test:style and test:unit scripts.autoload-dev within the composer.json file.The toJson() method now allows you to specify the $options parameter to proxy to the json_encode() function.
toJson() method now allows you to specify the $options parameter to proxy to the json_encode() function.$ref can now be used in place of all objects.
$ref can now be used in place of all objects.Components object now supports all fields (with exception to callbacks).create() static method has now been moved to the BaseObject class with a return type also being BaseObject. If you are extending any object classes and overriding the create() method, then be sure to update your return type. DocBlock type hinting has been provided to indicate a static return type, so your IDE should still be able to provide autocompletion for child class members.composer.json.composer.json scripts.You can now specify on an Operation object that it should not have any security by invoking the noSecurity() method on an instance of it.
Operation object that it should not have any security by invoking the noSecurity() method on an instance of it.The SecurityRequirement object now accepts a single SecurityScheme along with an array of scopes. This is because it was outputting incorrect data, an
SecurityRequirement object now accepts a single SecurityScheme along with an array of scopes. This is because it was outputting incorrect data, and its purpose was misleading. It now acts as a way to specify a single SecurityScheme along with any scopes. Any object that accepts a SecurityRequirement object, always accepts an array of them, so you can still specify several SecurityScheme objects by wrapping them in a SecurityRequirement.The Response class now has helper methods for common HTTP responses.
Response class now has helper methods for common HTTP responses.3.0.2 spec.create() methods) now only accept the optional $objectId parameter which is used in several scenarios.Paths class and instead the OpenApi class has a variadic paths() method which takes any number of PathItem instances.OpenApi class is now immutable like all the other object classes.Corrected typo in name, from _Orientated_ to _Oriented_.
Provided a much simpler example in the README.md.
README.md.This marks the first production ready release!
This marks the first production ready release!
### Fixed - Operation methods fixed.
Method to update the name property on a schema.
name property on a schema.Added example property to schema.
example property to schema.Setting the nullable property for the schema defaults to true.
nullable property for the schema defaults to true.Schema now supports nullable property.
allOf.nullable property.### Added - First release of beta.
One column per quarter.