feedback icon indicating copy to clipboard operation
feedback copied to clipboard

[Docs Update] Some API endpoints need the trailing slash removed when query parameters are used

Open drazisil-codecov opened this issue 1 year ago • 3 comments

Description

Some API endpoints need the trailing slash removed when query parameters are used

Page(s)

At least https://docs.codecov.com/reference/repos_flags_coverage_list, possibly most

Current State

[] Broken Link [X] Unclear Language [] Inconsistent Formatting [] Missing Information [] Missing Updates for New Features [] Deprecated Features

Additional Information

The API docs are generated from a OpenAPI schema generated from the v2 API.

drazisil-codecov avatar Jul 26 '24 14:07 drazisil-codecov

After investigating, this is likely an API issue. Spectacular builds off of what it knows about the API routes.

cc: @katia-sentry

thomasrockhu-codecov avatar Jul 26 '24 19:07 thomasrockhu-codecov

The customer states that this API stopped working with the slash around 2 weeks ago.

drazisil-codecov avatar Jul 30 '24 12:07 drazisil-codecov

@drazisil-codecov woof ok, I'll try to take a look again

thomasrockhu-codecov avatar Jul 30 '24 13:07 thomasrockhu-codecov

@thomasrockhu-codecov any update on the look?

jerrodcodecov avatar Aug 20 '24 18:08 jerrodcodecov

@jerrodcodecov I took a look at it at first glance was super hairy. I haven't gotten a chance to come back to it, but will do this week.

thomasrockhu-codecov avatar Aug 21 '24 09:08 thomasrockhu-codecov

@jerrodcodecov @drazisil-codecov this should be fixed now. I will add another ticket to make the fix less manual in the future

thomasrockhu-codecov avatar Aug 23 '24 19:08 thomasrockhu-codecov