Adding collection schema to methods that use openApiPaginator

[MasaKni]

Resolves #562

I modified the code so that actions that have the openApiPaginator will get the collection response, and i also added the schema to the action because it was not being set at all.

moved:
I also added the possibility to sort/order by an array which requires an array object in the swagger

[cnizzardini]

Hey there thanks for submitting a pull request. Do you mind adding a description? I''ll review this when I have time over the holidays. Thanks @MasaKni!

[MasaKni]

@cnizzardini another thing.
in OperationResponse.php file assignFromAttributes function why do you add an empty content if all the response checks are not met? doesn't this mean that the request does not have a body and we don't want to add content so why adding it?

[cnizzardini]

Why is this needed? How come paginatorSort will not work?

[MasaKni]

paginatorSort only works for one field sorting, if we want to sort by let's say name and date we can't do that with it we would use the order.

[cnizzardini]

I've pulled your branch in using the demo: https://github.com/cnizzardini/cakephp-swagger-bake-demo

How come I get output that looks like this on /actors/{id}/films:

The only change I made here (https://github.com/cnizzardini/cakephp-swagger-bake-demo/blob/master/src/Controller/ActorsController.php#L155) was adding in #[OpenApiPaginator]

[cnizzardini]

@MasaKni bump ^

[MasaKni]

yes well we can agree on another structure for order, but i saw that adding it in this format will be helpful,
we can add ordering as object and each we add we specify the field and dir
if you try it then it will add objects of the
{ "field": "name", "dir": "asc" }

and we would wanna keep the sort because we wanna allow sorting by one field not a combination

[cnizzardini]

If we can't resolve this in the current PR can we remove this for now and come back to it? I don't want to release something that doesn't work with SwaggerUI @MasaKni

[cnizzardini]

@MasaKni is this resolved?

[cnizzardini]

@MasaKni I am going to close this PR if you don't respond this.

[cnizzardini]

@cnizzardini another thing. in OperationResponse.php file assignFromAttributes function why do you add an empty content if all the response checks are not met? doesn't this mean that the request does not have a body and we don't want to add content so why adding it?

Honestly, I am not sure. I am not as active in this library as I once was. Is it causing an issue or just seems off?

[MasaKni]

@cnizzardini another thing. in OperationResponse.php file assignFromAttributes function why do you add an empty content if all the response checks are not met? doesn't this mean that the request does not have a body and we don't want to add content so why adding it?

Honestly, I am not sure. I am not as active in this library as I once was. Is it causing an issue or just seems off?

yes it is adding the default content string to responses that i define as with no body

[cnizzardini]

@cnizzardini another thing. in OperationResponse.php file assignFromAttributes function why do you add an empty content if all the response checks are not met? doesn't this mean that the request does not have a body and we don't want to add content so why adding it?

Honestly, I am not sure. I am not as active in this library as I once was. Is it causing an issue or just seems off?

yes it is adding the default content string to responses that i define as with no body

Can you post an issue for this with steps to reproduce and I can take a look at it?

[cnizzardini]

I'm a bit confused by this PR. I am looking at a private codebase I maintain (running cakephp 5.1 and swaggerbake 3.0.5 on php 8.3) and #[OpenApiPaginator] already works as expected on non index() controller actions.

Given the following setup:

    #[OpenApiPaginator]
    #[OpenApiSecurity(name: 'bearerAuth')]
    public function bar()

I get this output:

  /api/foo/bar:
    get:
      operationId: foo:bar:get
      tags:
        - Foo
      parameters:
        - $ref: '#/x-swagger-bake/components/parameters/paginatorPage'
        - $ref: '#/x-swagger-bake/components/parameters/paginatorLimit'
        - $ref: '#/x-swagger-bake/components/parameters/paginatorSort'
        - $ref: '#/x-swagger-bake/components/parameters/paginatorDirection'

[cnizzardini]

@MasaKni Given what I noted above, I am going to need steps from you to reproduce a state with the problem you are attempting to solve for so I can test this and better understand what is being solved before I merge this PR in.

My apologies, I see now what you a specifically solving for is the database schema portion not showing as the OpenAPI example schema, not the query parameters.

[MasaKni]

@MasaKni Given what I noted above, I am going to need steps from you to reproduce a state with the problem you are attempting to solve for so I can test this and better understand what is being solved before I merge this PR in.

My apologies, I see now what you a specifically solving for is the database schema portion not showing as the OpenAPI example schema, not the query parameters.

yes indeed, the parameters are added correctly but the schema is set for the default response which is
"string"

[cnizzardini]

It is courtesy to note when you have resolved comments.