Skip to content
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.

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

Add version to api url patterns #2617

Merged
merged 2 commits into from
Jan 31, 2024

Conversation

sarahsporck
Copy link
Contributor

Short description

This PR adds a version path element to the new endpoints, so that the app & webapp can finally use them.

Proposed changes

  • Add version 'v3' to the pathname of all new urls.

Side effects

  • Does any external service use the urls already?

Resolved issues

Fixes: #2290


Pull Request Review Guidelines

@sarahsporck sarahsporck requested a review from a team as a code owner January 23, 2024 10:21
Copy link

codeclimate bot commented Jan 23, 2024

Code Climate has analyzed commit eb426ac and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 80.5% (0.0% change).

View more on Code Climate.

Copy link
Member

@MizukiTemma MizukiTemma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good and working as expected so far as I testet 😺

Should we probably update the API docs with the additional "/v3"?

@sarahsporck
Copy link
Contributor Author

Should we probably update the API docs with the additional "/v3"?

Jep. You're totally right! I've updated the docs.

Copy link
Member

@timobrembeck timobrembeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! 👍

Once we have more than one active API version, we might need to reflect this in our package structure as well (similar to how we did it for lunes-cms), but since we aren't planning v4 yet, I guess it's not necessary to do the extra work now.

@sarahsporck sarahsporck merged commit 89a32a7 into develop Jan 31, 2024
5 checks passed
@sarahsporck sarahsporck deleted the bugfix/new-api-url-patterns-not-versioned branch January 31, 2024 16:54
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.

New API URL patterns not versioned
3 participants