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

Document endpoint auth methods #451

Merged
merged 25 commits into from
Dec 13, 2024
Merged

Document endpoint auth methods #451

merged 25 commits into from
Dec 13, 2024

Conversation

andrii-balitskyi
Copy link
Contributor

@andrii-balitskyi andrii-balitskyi commented Dec 9, 2024

Closes #447

@andrii-balitskyi andrii-balitskyi requested a review from a team as a code owner December 9, 2024 14:07
@seambot seambot requested a review from a team as a code owner December 9, 2024 14:10
@DebbieAtSeam
Copy link
Contributor

DebbieAtSeam commented Dec 10, 2024

@andrii-balitskyi I'm not sure about the placement and formatting of the note. I think it's important information, but is there a way to present the info. that's not in a hint box? Something like this maybe (but prettier)?
image

@andrii-balitskyi
Copy link
Contributor Author

andrii-balitskyi commented Dec 10, 2024

@DebbieAtSeam sure, but wasn't able to make it look prettier with the current setup. @razor-x any ideas on how to make it look better?

Here's how the section currently looks like:
image

@DebbieAtSeam
Copy link
Contributor

@andrii-balitskyi I do like that ul better than the hint box, with the exception of the capitalization. Could you please explain a bit more about why users need this info.? For example, why do only some methods accept a client session token? Also, if the ul takes up too much space, you could try it as a plain comma-separated list in a p. Thanks!

@razor-x
Copy link
Contributor

razor-x commented Dec 10, 2024

@DebbieAtSeam There are past examples (which I cannot post here) where having this information would have been very helpful to address customer and internal question.

src/lib/layout/api-endpoint.ts Show resolved Hide resolved
Copy link
Contributor

@DebbieAtSeam DebbieAtSeam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andrii-balitskyi Is there an importance or other logical order to the way in which the auth methods get listed in the bulleted lists? If not, is there a way to display them in alpha order? If not, it's nbd. Thanks!

@DebbieAtSeam
Copy link
Contributor

Thanks, @andrii-balitskyi!

@andrii-balitskyi andrii-balitskyi merged commit 9f04f3a into main Dec 13, 2024
13 checks passed
@andrii-balitskyi andrii-balitskyi deleted the auth-methods branch December 13, 2024 15:41
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.

Document auth methods
4 participants