swisnl / openapi-spec-generator

Creates Open API spec for a Laravel JSON:API
Apache License 2.0
23 stars 11 forks source link

fix: use configured column name instead of key to retrieve example data #20

Closed maartenpaauw closed 1 month ago

maartenpaauw commented 1 month ago

Description

Given the following configured schema filters, this spec generator package tries to retrieve example data from the model using the event key name which is incorrect because a column name is provided.

public function filters(): array
{
    return [Where::make(name: 'event', column: 'event_class')];
}

Motivation and context

Without this fix, it's impossible to generate specs when using column configuration.

How has this been tested?

Tested by running generate command.

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

Checklist:

Go over all the following points, and put an x in all the boxes that apply.

Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.

If you're unsure about any of these, don't hesitate to ask. We're here to help!

maartenpaauw commented 1 month ago

I'm not sure why the code style action is failing? 🤔

It says: GitHub Actions has encountered an internal error when running your job.. Maybe @JaZo or @Rocksheep can restart this action?

JaZo commented 1 month ago

I've restarted it, but it's failing because PHP-CS-Fixer has some new rules. We should best fix that in master.

JaZo commented 1 month ago

I've fixed the code style in master, so if you rebase the check should pass!