Skip to content

Commit 24ea5fa

Browse files
authored
Update with v2 info
Added an announcement about the launch of API V2 and the maintenance status of V1, including migration instructions.
1 parent 68ae9cb commit 24ea5fa

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,16 @@
2424

2525
<br/>
2626

27+
# Announcement: API V2 has officially launched, and V1 is now in maintenance. Calls now require a server prefix
28+
29+
If you are using the old V1 API, you will need to prefix your calls with /v1/ (eg. api.open5e.com/v1/monsters). This should resolve issues for anyone currently consuming v1 API and having issues with their site.
30+
31+
This has come after many months of dicussion within our discord and on this repo (and the inclusion of a 299 deprecation warning in every response header). Unfortunately, since we do not require registration for API keys, we have no way to contact consumers other than to update and hope folks find their way here when things break.
32+
33+
The v1 API is now in maintenance, and will not recieve content or functionality updates. We recommend migrating to v2, but will keep the v1 running for as long as it doesn't consume too much resources to do so.
34+
35+
All v1 content is still available for hosting your own version, if required
36+
2737
# Table of contents
2838

2939
- [Table of contents](#table-of-contents)

0 commit comments

Comments
 (0)