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 Z api docs #167

Merged
merged 3 commits into from
May 14, 2024
Merged

Update Z api docs #167

merged 3 commits into from
May 14, 2024

Conversation

jxjj
Copy link
Contributor

@jxjj jxjj commented May 13, 2024

  • add docs for updating zlink endpoint
  • switch the javascript example
  • sticky contents and header
  • remove details on how JWT works. This is covered well in linked https://jwt.io page. Users should be using a library for signing their payload anyway.
  • link to an example implementation

For review here: https://cla-z-dev-02.oit.umn.edu/shortener/api_keys

jxjj added 3 commits May 13, 2024 17:26
- add docs for updating zlink endpoint
- switch the javascript example
- sticky contents and header
- remove details on how JWT works. This is covered in linked jwt.io page. Plus, we want users to just use a recommended library to sign payload rather than roll their own.
- refer to the jwt as a "signed payload"
- link to example api implementation
@jxjj jxjj requested a review from cmcfadden May 13, 2024 23:51
@jxjj jxjj self-assigned this May 13, 2024
Copy link
Member

@cmcfadden cmcfadden left a comment

Choose a reason for hiding this comment

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

looks good

@jxjj jxjj merged commit fc03cb4 into develop May 14, 2024
2 checks passed
@jxjj jxjj deleted the feature/update-docs-for-api-z-link-updates branch May 14, 2024 14:38
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