Skip to content

feat!: make mapping_type optional #486

Merged
jsstevenson merged 1 commit into
mainfrom
fix/462-mapping-type-optional
Jun 24, 2026
Merged

feat!: make mapping_type optional #486
jsstevenson merged 1 commit into
mainfrom
fix/462-mapping-type-optional

Conversation

@jsstevenson

@jsstevenson jsstevenson commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

close #462

I think this was a mistake in how we designed the endpoints -- we want a way to retrieve all mappings, but a path param can't be optional. It also makes more sense to me that mapping_type would be like a filter on the /mappings/ path rather than a subtype.

So the new path looks like GET /objects/<vrs_id>/mappings?mapping_type=liftover_to or GET /objects/<vrs_id>/mappings

Alternatives considered

  • Rather than re-engineering this endpoint, just add a new, general GET /objects/<vrs_id>/mappings endpoint that retrieves all mappings. I went ahead with just changing the existing endpoint for the reasons above.

@jsstevenson jsstevenson requested a review from a team as a code owner June 16, 2026 17:01
Comment thread docs/source/usage/rest_api.rst Outdated
Comment thread docs/source/usage/rest_api.rst Outdated
@jsstevenson jsstevenson requested a review from theferrit32 June 23, 2026 18:44
@jsstevenson jsstevenson force-pushed the fix/462-mapping-type-optional branch from 71a7264 to fc9f44f Compare June 24, 2026 14:17
@jsstevenson jsstevenson merged commit df09736 into main Jun 24, 2026
20 checks passed
@jsstevenson jsstevenson deleted the fix/462-mapping-type-optional branch June 24, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

mapping_type should be an optional param in the GET mappings endpoint

2 participants