mirror of
https://gitlab.com/PronounsPage/PronounsPage.git
synced 2025-09-22 12:03:25 -04:00
blog(en): publish planned API changes
This commit is contained in:
parent
1e786b696f
commit
9840bb43bb
42
locale/en/blog/bump-sh.md
Normal file
42
locale/en/blog/bump-sh.md
Normal file
@ -0,0 +1,42 @@
|
|||||||
|
# Bump.sh Sponsorship with API Documentation
|
||||||
|
<small>2025-09-17 | [@therealbenpai](https://en.pronouns.page/therealbenpai)</small>
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
|
Hello Everyone! I am Benjamin, also known as Oliver. I have been hard at work with the other members of the technical team on updating our API documentation. Today, I am proud to announce a partnership/sponsorship with [Bump.sh](bump.sh) that allows us to utilize their platform to make some very nice-looking API documentation.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Changes
|
||||||
|
|
||||||
|
The following will describe the changes that will be made
|
||||||
|
|
||||||
|
### - What the new documentation will look like
|
||||||
|
|
||||||
|
Currently speaking, the API documentation is still in the works while we revise and document all of our public-facing routes and prepare to publish them on the documentation website. Our goal is to have all of our documentation completely done on there by the end of October, if not sooner. The documentation will feature code samples, response syntaxes, examples, testers and explorers, and much more.
|
||||||
|
|
||||||
|
#### Preview
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### - The future of the API
|
||||||
|
|
||||||
|
We have some ideas in the works for updating the API system as a whole. Our hope is that we will be to make a system that allows an extensive amount of access to the API system of the website. This means that in the future, we plan to potentially have the following (will be updated as they are completed):
|
||||||
|
|
||||||
|
- [ ] **Versions**: Decide what we want to do with routes that have multiple versions
|
||||||
|
- [ ] **Security**: Add/Revise JWT implementation (make API tokens more accessible to potential developers)
|
||||||
|
- [ ] **Documentation**: Complete API Documentation starting with base and English, and then extend over to other locales.
|
||||||
|
- [ ] **Schema**: Alter some of the API responses to use easier documented behaviors to allow for better documentation
|
||||||
|
- [ ] **Linking and Redirections**: Change linking for versioning systems as well as API documentation to match new systems
|
||||||
|
|
||||||
|
Some later additions may include the following:
|
||||||
|
|
||||||
|
- [ ] **OAuth2/OpenID**: Add in a user authentication system to allow users to log in/verify themselves using Pronouns.Page
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### - Footnotes
|
||||||
|
|
||||||
|
In the end, we would like to extend a special thank you to **Christophe Dujarric** and the entire **Bump.sh Team**. Their platform and support is what helped make all of this possible. We are more than grateful for their willingness to sponsor us and help make this goal a reality.
|
BIN
locale/en/img/blog/docs-preview.png
Normal file
BIN
locale/en/img/blog/docs-preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 458 KiB |
BIN
locale/en/img/blog/pronouns-page-bump-sh.png
Normal file
BIN
locale/en/img/blog/pronouns-page-bump-sh.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 80 KiB |
Loading…
x
Reference in New Issue
Block a user