You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on May 23, 2024. It is now read-only.
Right now, we just have the @api-param annotation that lets you document a resource action parameter. There is currently, unfortunately, no way to denote how that parameter should be used on that action wether it's within the query string, or as part of a body payload.
Since the most common use-case for a parameter is to be used within a payload, I think that we should introduce a new @api-queryparam annotation to denote these parameters that should be utilized within the query string.
Its make up will be 100% the same as @api-param, just in the backend we'll know where its place is at.
The text was updated successfully, but these errors were encountered:
Right now, we just have the
@api-param
annotation that lets you document a resource action parameter. There is currently, unfortunately, no way to denote how that parameter should be used on that action wether it's within the query string, or as part of a body payload.Since the most common use-case for a parameter is to be used within a payload, I think that we should introduce a new
@api-queryparam
annotation to denote these parameters that should be utilized within the query string.Its make up will be 100% the same as
@api-param
, just in the backend we'll know where its place is at.The text was updated successfully, but these errors were encountered: