Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Denoting the payload format for an API parameter #109

Closed
erunion opened this issue Jul 25, 2017 · 0 comments
Closed

Denoting the payload format for an API parameter #109

erunion opened this issue Jul 25, 2017 · 0 comments
Assignees
Milestone

Comments

@erunion
Copy link
Owner

erunion commented Jul 25, 2017

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.

@erunion erunion added this to the v2.0 milestone Jul 25, 2017
@erunion erunion self-assigned this Jul 25, 2017
@erunion erunion modified the milestones: v2.0, v3.0 Nov 19, 2017
@erunion erunion removed this from the v3.0 milestone Feb 1, 2018
@erunion erunion added this to the v5.0: OAI milestone Feb 10, 2018
@erunion erunion modified the milestones: v5.0: Language Agnostic, v4.0: OAI Mar 24, 2018
@erunion erunion closed this as completed May 29, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant