Skip to content

fix(swagger): correct /shapes filter[route] parameter description #1066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Redeem-Grimm-Satoshi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(swagger): correct /shapes filter[route] parameter description #1066

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion apps/api_web/lib/api_web/controllers/shape_controller.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,21 @@ defmodule ApiWeb.ShapeController do
""")

common_index_parameters(__MODULE__, :shape)
filter_param(:id, name: :route, required: true)

parameter(
"filter[route]",
:query,
:string,
"""
Filter by route ID. Multiple route IDs #{comma_separated_list()}.

Note that the shape resource does not include a `route` relationship on API versions \
`2020-05-01` and later, so shapes in the response cannot be attributed to a route from \
the response body on those versions. Request a single route at a time if that \
attribution is needed.
""",
required: true
)

consumes("application/vnd.api+json")
produces("application/vnd.api+json")
Expand Down