Oooas Laravel Package

Changed

• #57 - The Schema::properties() method now accepts SchemaContract instances.

Fixed

• #57 - CI pipeline fixed (dev dependencies updated to the latest version).

Added

• #55 - Add ReturnTypeWillChange attributes and add workflows for PHP 8.0 and PHP 8.1.

Changed

• Build pipeline switched from Travis CI to GitHub Actions.

Changed

• Methods that returned $this now have their DocBlock updated to [@return](https://github.com/return) static for better IDE handling in client code that extends these classes.

Added

• Added validate() method to OpenApi object.

Fixed

• Callbacks now correctly output when converting to array/JSON.

Added

• Callbacks are now supported in the Components object.

Added

• Callbacks are now supported in the Operation object.

Added

• Added support for specification extensions (^x-).

Fixed

• Thrown exceptions now have meaningful messages to help when debugging.

Fixed

• Properties that should accept numeric (integer and float) values , but only allowed integers, now allow for both integers and floats.

Added

• Added formUrlEncoded() creation method in MediaType object (for application/x-www-form-urlencoded request bodies).

Changed

• The branching strategy no longer makes use of the develop branch. Instead all feature/hotfix branches should be based off of master.
• The composer test script now makes reference to the individual test:style and test:unit scripts.

Fixed

• The test suite PSR-4 autoloading has now been moved to autoload-dev within the composer.json file.

Added

• The toJson() method now allows you to specify the $options parameter to proxy to the json_encode() function.

Added

• $ref can now be used in place of all objects.
• The Components object now supports all fields (with exception to callbacks).

Changed

• The 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.

Fixed

• Description updated in composer.json.
• Linter commands are now using cache when called in the composer.json scripts.

Added

• 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.

Fixed

• The 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.

Added

• The Response class now has helper methods for common HTTP responses.
• Missing object from the OpenAPI spec have had their corresponding classes added.
• Support added for the OpenAPI 3.0.2 spec.
• Test cases for each object class.

Changed

• Object class constructors (and create() methods) now only accept the optional $objectId parameter which is used in several scenarios.
• Removed Paths class and instead the OpenApi class has a variadic paths() method which takes any number of PathItem instances.
• Class constants now have their name prefixed with the property it is intended to be used with.

Fixed

• The OpenApi class is now immutable like all the other object classes.

Fixed

• Corrected typo in name, from Orientated to Oriented.

Fixed

• Provided a much simpler example in the README.md.

First release 🎉🚀

This marks the first production ready release!

Added

• Object creation methods no longer require the parameters required by the OpenAPI spec. These required properties can alternatively be set after the object creation with the supplementary setter methods.
• Documentation and other open-source related content.

Fixed

• Operation methods fixed.

Added

• Method to update the name property on a schema.

Added

• Added example property to schema.

Fixed

• Setting the nullable property for the schema defaults to true.

Changed

• Array now nested within allOf.
• Schema now supports nullable property.

Added

• First release of beta.