Skip to content

refactor: update API versioning and restructure routes for cleaner organization#21

Merged
ronibhakta1 merged 1 commit into
readium:mainfrom
ronibhakta1:refactor/api-versionalization
Jul 10, 2026
Merged

refactor: update API versioning and restructure routes for cleaner organization#21
ronibhakta1 merged 1 commit into
readium:mainfrom
ronibhakta1:refactor/api-versionalization

Conversation

@ronibhakta1

Copy link
Copy Markdown
Contributor

This pull request removes the /v1 API prefix from all endpoints, making /voices and /synthesize the new canonical routes. It updates the codebase, documentation, configuration, tests, and nginx templates to reflect this breaking change. The api_v1_prefix setting and related files are removed, and all references to /v1/ in endpoints, docs, and tests are updated accordingly.

API Route Changes:

  • Removed the /v1 prefix from all API endpoints; /voices and /synthesize are now accessed at the root level. [1] [2] [3] [4] [5]

Documentation Updates:

  • Updated all documentation files to reference /voices and /synthesize instead of /v1/voices and /v1/synthesize. This includes user docs, API docs, configuration, and development guides. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Configuration and Nginx:

  • Removed the api_v1_prefix setting from configuration and environment files. Updated nginx templates to rate-limit and proxy the new /synthesize endpoint. [1] [2] [3]

Test Suite Updates:

  • Updated all test cases to use the new root-level endpoints, ensuring tests match the current API routes. [1] [2] [3] [4] [5] [6] [7] [8]

Miscellaneous:

  • Added a link to the live demo in the README.md.

@ronibhakta1
ronibhakta1 merged commit 6e465b5 into readium:main Jul 10, 2026
1 check passed
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.

1 participant