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

docs(docs): Update auth token to use new catalyst id #1560

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Jan 20, 2025

Description

This changed the auth token to align with consistent use of the new catalyst-id.
It will help reduce the amount of alternative means of achieving the same outcome.
All RBAC registrations can reliably be found using the catalyst ID.

Breaking Changes

The ID is completely different, however the old auth token has never been deployed into production.
Its also similar in content, but different in formatting.

Related PR

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj marked this pull request as draft January 20, 2025 03:50
@stevenj stevenj self-assigned this Jan 20, 2025
@stevenj stevenj added documentation Pull requests that update a dependency file. comment me Request for comments labels Jan 20, 2025
Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 392/392}$ | ${\color{red}Fail: 0/392}$ |

@stevenj stevenj added the requires architecture review Requires at least 1 architect to sign off on PR before merge. label Jan 20, 2025
Copy link
Contributor

Test Report | ${\color{lightgreen}Pass: 392/392}$ | ${\color{red}Fail: 0/392}$ |

Copy link
Contributor

@nathanbogale nathanbogale left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

Choose a reason for hiding this comment

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

Line 20 suggested improvement:

It consists of an Authentication Header attached to every authenticated request, and an encoded signed.

Replace with

The authentication token consists of two parts:

  1. An Authentication Header that must be attached to every authenticated request
  2. An encoded signature that verifies the token's authenticity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comment me Request for comments documentation Pull requests that update a dependency file. requires architecture review Requires at least 1 architect to sign off on PR before merge.
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

3 participants