search

feathersjs-ecosystem / feathers-swagger

Add documentation to your FeatherJS services and feed them to Swagger UI.
MIT License
225 stars 63 forks source link

How to add the querying parameter to filter? #93

Closed alinex closed 5 years ago

alinex commented 6 years ago

See feathersjs Querying which uses additional parameters for each field but how to get it shown (like pagination) in swagger?

GET /messages?read=false&roomId=2

This should be callable through swagger.

alinex commented 6 years ago

Also the possible $select parameter is missing in swagger.

How can I define this parameters for a service method?

Mairu commented 5 years ago

Parameters can be configured at mulitple levels with version 1.0.0. It it describes in the readme and some examples.

askdesigners commented 2 years ago

A link to the relevant place in the docs would be handy. The section about "Path support to update nested structures" is obtuse and not easy to understand.

Mairu commented 2 years ago

Example how to add a parameter: https://github.com/feathersjs-ecosystem/feathers-swagger/blob/master/example/openapi-v3/definitions.js#L66

Can also be used directly in the service docs: https://github.com/feathersjs-ecosystem/feathers-swagger/blob/master/example/openapi-v3/customMethods.js#L108

And of course you can just define the whole parameters array, without modifying it.