Php Openapi Laravel Package

What's Changed

Compatibility:

• Added Support for Symfony 7 and PHP 8.2, 8.3 by @tacman (https://github.com/cebe/php-openapi/pull/212)
• Allow jsonrainbow/json-schema version 5 and 6 by @tacman (https://github.com/cebe/php-openapi/pull/227)
• PHPStan 1.x support by @rogervila (https://github.com/cebe/php-openapi/pull/180)

Features and Fixes:

• Hold raw spec data when reading specifications, added a getter getRawSpecData() by @SOHELAHMED7 (https://github.com/cebe/php-openapi/pull/228)
• Resolve: Unable to reference other local json file by @SOHELAHMED7 (https://github.com/cebe/php-openapi/pull/218)
• Improve usage of Security and SecurityRequirement by @SOHELAHMED7 (https://github.com/cebe/php-openapi/pull/225)
• Fix: Referenced Parameters compiling to Object instead of Array by @SOHELAHMED7 (https://github.com/cebe/php-openapi/pull/234)
• Added test to confirm referenced parameters are compiling to arrays by @Aribros (https://github.com/cebe/php-openapi/pull/195)
• Fix resolving of relative paths in references by @Aribros (https://github.com/cebe/php-openapi/pull/166, #164, #191)

Doucmentation:

• Resolve: Document how to read schema properties by @SOHELAHMED7 (https://github.com/cebe/php-openapi/pull/222)

New Contributors

• @Sarke made their first contribution in https://github.com/cebe/php-openapi/pull/196
• @googoogajoob made their first contribution in https://github.com/cebe/php-openapi/pull/188
• @SOHELAHMED7 made their first contribution in https://github.com/cebe/php-openapi/pull/222
• @rogervila made their first contribution in https://github.com/cebe/php-openapi/pull/180
• @tacman made their first contribution in https://github.com/cebe/php-openapi/pull/227

Full Changelog: https://github.com/cebe/php-openapi/compare/1.7.0...1.8.0

Improvements:

• Support for PHP 8.1, thanks @om4csaba, @shadowhand, @simPod
• #160 Flags for json_encode() in Writer::writeToJson(), thanks @ValikoDorodnov

Bugfixes:

• #100 Fixed a bug with merging PathItems where extension properties (x-*) were not present in the merge result (thanks @marcelthole)
• #131 Adjust default value for Schema::$nullable when no type is specified. nullable will be false by default when a type is specified but null when no type is specified.
• #77 Fixes default value for exclusiveMinimum and exclusiveMaximum only return false when minimum or maximum is specified, defaults to null otherwise.
• #125 Fix OpenAPI v3.0 Schema Violation: Array value found, but an object is required (thanks @om4james)
• #119 Stricter type checking when resolving references, avoid trying to call methods on array
• #144 Catch recursion when resolving inside included file

Dependencies:

• #151, #134 Add Symfony 6 support (thanks @om4csaba)

Other changes:

• Reworked CI (thanks @simPod)
• Added Docker environment for local development

Bugfixes:

• #87, #102 Fix PathItem::resolveReferences() for array fields, a PHP Notice had been thrown (thanks @iZucken and @rv1971)
• #107 Inline references does not resolve relative references (thanks @marcelthole)
• #95 Adjust relative URLs for externalValue fields in Example Objects when inlining references.

Documentation:

• Fixed typos in README and CLI help (thanks @ssfinney)

Bugs

• #94 Fixed resolving relative paths with multiple ../ (thanks @il-m-yamagishi)

Documentation

• #98 Added PHPStan Template annotations (thanks @marcelthole)
• #96 Added missing exeption annotation to readFromJsonFile() (thanks @yorickgirard)

Improvements:

• Overall performance improvements and other optimization for loading references
• #63 Added option to only resolve external references (inlining)

Bugfixes:

• #74 Fix PHPDoc for exclusiveMinimum and exclusiveMaximum to boolean (thanks @canvural)
• #92 Resolving references to external files did not work correctly on windows (thanks @Insolita)

Other changes:

• #80 Changed minimum Symfony YAML version from 3.0 to 3.4 (thanks @marcelthole)
• #83 Tests are green on PHP 8 (thanks @canvural)

• #61 Allow Symfony YAML 4.4 to be installed

• #68 Fix: Crash with unresolved reference while instantiating Encoding (@karsa-mistmere)

• #56 Added compatibility with symfony/yaml:^5.0
• #49 Static Analysis using phpstan (@lookyman)
• #53 Added extra validation messages for parameters (@lezhnev74)
• #43 Improved command-line-tool output of bin/php-openapi validate (@mfrischbutter)
• #42 Added --silent parameter to command-line-tool (@mfrischbutter)
• #46, #52 Fix writing empty arrays to YAML file (@coatesap)

• #57 Fix transitive reference resolving in the current document context

• #44 Fix recursion issue with reading references which are included multiple times

• #47 Fixed crash when referencing a non-spec object or array

• #41 Fixed an issue with loading references that point to a reference in another file.

• #35 Symfony YAML is not limited to version 4 anymore, you can now install php-openapi in your symfony 3 project.

• #32 References failed to resolve in directory structures when referencing other files from file in subdirectories. These references where resolved in the context of the main OpenAPI file instead of the sub-directories.

  Before this change it was necessary to manually call resolveReferences() after loading a file. Now a single call will resolve all references regardless how many levels deep.

• #33 Ensure semantics of empty array and null are correctly presented for security objects.
• #37 Fixes the problem that undefined properties did throw errors when they are accessed, now their default values are returned.
• Improved error messages when reading or writing files fails.

• #17 Added support for $ref in Path Item Objects, following the clarification of semantics.
• #14 Improved loading nested references. References in referenced files can now be loaded even if the base type of the referenced file is unknown.
• Updated docs to consistently use the term API Description instead of API Specification.
• #28 Allow creating the object structure by passing prepared Specification Objects instead or arrays (thanks, @SilverFire)

This release brings the following changes:

• #30 Added separate classes to implement JSON Reference and JSON pointer
• #30 Improve error handling and document navigation by providing each object with context information. Context information contains the base document and the JSON pointer to the objects position in the document. This can be used to navigate to parent and sibling elements easily. Such navigation was not possible before. It also allows for more convenient error reporting as the errors are annotated with their position in the document.
• #29 Fixed handling of recursive structures in Schema definitions.
• correct PHPDoc for properties [@property-read](https://github.com/property-read) was used even though properties are writeable now.

This release brings the following changes:

• #24 Added array type to the list of constants in Type class (thanks, @scaytrase)
• #22 Fixed normalisation of URIs on windows (thanks, @scaytrase)
• #27 Improved overall Windows support and added tests for Windows

OpenAPI v3 got a JSON Schema for validating OpenAPI 3 documents (https://github.com/OAI/OpenAPI-Specification/pull/1270 and https://github.com/OAI/OpenAPI-Specification/pull/1897).

This release adds a CLI tool for validating OpenAPI 3 documents against the JSON schema.

Other improvements:

• #19 improves handling of default values
• #18 enables modifying and writing the schema

• Bug 03c5e82 fix resolving references to a file without jsonPointer
• Enh 2f1f736 allow settings context on references without resolving these (lazy resolving of references)

• 4018163 fix support for references in Responses object

• Added PathItem::getOperations() for easier access to operations

First release. Ready for testing. This implements full coverage of the OpenAPI 3 Spec. The following functionality is available:

• reading openapi YAML and JSON files
• inspecting the API specification data through PHP object
• basic validation against OpenAPI 3 spec
• resolving of references (in the same file, as well as external files)

Please try it on your OpenAPI spec files and report any issues you see!