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

Update build docs #69

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

digisomni
Copy link
Member

This PR is based off of PR #68

One problem that I am probably going to need to solve in Iamus with this PR is to add an API call to retrieve a user by username instead of their account ID as it might often be the case that you know their username but not their accountID. The only way for me to retrieve data on a specific user is to pull the entire userbase list then run through each one looking for a match which might be a performance/programming issue depending on what was looking to pull up this data.

So it might be good to have the database perform this check since it's probably far more performant and also has less back and forth involved.

@Misterblue
Copy link
Collaborator

Misterblue commented Dec 21, 2020

The request /api/v1/account/:accountId accepts either the accountId or the account username for the ":accountId". See 'src/route-tools/middleware.ts::accountFromParams()' which looks up by username and, if not found, looks up by accountId. Also note that the username is URI encoded so special characters and such are processed correctly.
I updated the documentation to include that clarification.

@Misterblue
Copy link
Collaborator

This PR includes the commits from PR#68 which is confusing.

@digisomni
Copy link
Member Author

Heh, yeah, once 68 gets merged then this will clear up. :)

@Misterblue
Copy link
Collaborator

Is this PR still necessary?

@digisomni digisomni changed the title Update profile redirection & build docs Update build docs Mar 15, 2021
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.

2 participants