MarseyWorld
/
MarseyWorld
10
10
Fork 0
Code Issues 2 Pull Requests Packages Releases Wiki Activity

REST Api Documentation #11

Closed
nekobit wants to merge 0 commits from <deleted>:docs into master
pull from: <deleted>:docs
merge into: MarseyWorld:master
Conversation 8 Commits - Files Changed -
nekobit commented 2022-11-25 05:09:54 +00:00

Kind of at a boilerplate point. I'm coping from HeyMoon's mediocre Python library (which is very incomplete, but much easier to parse). I need this stuff for my Perl GTK application, so might as well get it over with now.

Merge whenever the fuck you want and edit it how you please.

I decided not to use OpenAPI's Swagger since it's still fairly new and is a bitch to read. (unfortunately, WADL is a bitch to write, so just copy and paste shit lolol) You can also convert WADL to Swagger, which can produce soyslop HTML outputs full of JS. Added /docs/api endpoint

XML is also more correct for it, Docbook is much more powerful than Swagger, and it feels good to write.

Kind of at a boilerplate point. I'm coping from HeyMoon's mediocre Python library (which is very incomplete, but much easier to parse). I need this stuff for my Perl GTK application, so might as well get it over with now. Merge whenever the fuck you want and edit it how you please. I decided not to use OpenAPI's Swagger since it's still fairly new and is a bitch to read. (unfortunately, WADL is a bitch to write, so just copy and paste shit lolol) ~~You can also convert WADL to Swagger, which can produce soyslop HTML outputs full of JS.~~ Added /docs/api endpoint XML is also more correct for it, Docbook is much more powerful than Swagger, and it feels good to write.
nekobit added 1 commit 2022-11-25 05:09:55 +00:00
nekobit added 1 commit 2022-11-25 20:36:34 +00:00
nekobit added 1 commit 2022-11-25 22:27:17 +00:00
justcool393 requested changes 2022-11-25 22:49:58 +00:00
justcool393 left a comment

ty neko, just some small things

ty neko, just some small things
files/routes/docs.py Outdated
@ -0,0 +22,4 @@
from files.routes.front import comment_idlist
from files.routes.routehelpers import execute_shadowban_viewers_and_voters
from files.routes.wrappers import *
from files.__main__ import app, cache, limiter
justcool393 commented 2022-11-25 22:48:15 +00:00

probably could remove like... all of these imports except for the from files.__main__ import app

probably could remove like... all of these imports except for the `from files.__main__ import app`
files/routes/docs.py Outdated
@ -0,0 +29,4 @@
tree = ET.parse('docs/api.xml')
@app.get("/dev/api")
def get_docs_page():
justcool393 commented 2022-11-25 22:46:55 +00:00

needs @auth_desired wrapper so we don't """log people out"""

needs `@auth_desired` wrapper so we don't """log people out"""
nekobit added 2 commits 2022-11-26 04:31:52 +00:00
nekobit requested review from justcool393 2022-11-26 04:32:38 +00:00
nekobit commented 2022-11-26 04:32:49 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
nekobit commented 2022-11-26 04:32:52 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
nekobit commented 2022-11-26 04:32:53 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
nekobit commented 2022-11-26 04:32:55 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
nekobit commented 2022-11-26 04:32:58 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
nekobit commented 2022-11-26 04:33:00 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
nekobit commented 2022-11-26 04:33:01 +00:00
Poster

@justcool393 review and merge

@justcool393 review and merge
justcool393 self-assigned this 2022-11-26 14:32:37 +00:00
justcool393 approved these changes 2022-11-26 20:07:05 +00:00
justcool393 left a comment

:marseythumbsup:

:marseythumbsup:
justcool393 commented 2022-11-26 20:41:48 +00:00

ty for the PR
uh... i guess... this is gonna be closed now cause... yeah... whatever.

<3

ty for the PR uh... i guess... this is gonna be closed now cause... yeah... whatever. <3
justcool393 closed this pull request 2022-11-26 20:41:48 +00:00
nekobit deleted branch docs 2022-11-30 23:09:25 +00:00

Pull request closed

This pull request cannot be reopened because the branch was deleted.
Sign in to join this conversation.
Reviewers
No reviewers
justcool393
Labels
Clear labels   
bug

Something is not working   
duplicate

This issue or pull request already exists   
feature

New feature   
good first issue

New and want to help?   
help wanted

Need some help   
improvement

Code-focused: maintenance, refactoring   
invalid

Something is wrong   
question

More information is needed   
wontfix

This won't be fixed
No Label
bug
duplicate
feature
good first issue
help wanted
improvement
invalid
question
wontfix
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: MarseyWorld/MarseyWorld#11
There is no content yet.
Delete Branch "<deleted>:docs"

Deleting a branch is permanent. Although the deleted branch may exist for a short time before cleaning up, in most cases it CANNOT be undone. Continue?