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 OpenAPI Documentation for Bearer Token #2178

Open
4 tasks
MackHalliday opened this issue Dec 12, 2024 · 1 comment
Open
4 tasks

Update OpenAPI Documentation for Bearer Token #2178

MackHalliday opened this issue Dec 12, 2024 · 1 comment

Comments

@MackHalliday
Copy link

MackHalliday commented Dec 12, 2024

User Story - Business Need

We need to update our OpenAPI documentation to accurately represent how our token is formatted.
Under the 'Available Authorization' > 'serviceAuth', the follow text should be updated:

"The format of this token is {key_name}-{iss-uuid}-{secret-key-uuid}. should be updated to "The format of this token is "Bearer <value>".

  • Ticket is understood, and QA has been contacted (if the ticket has a QA label).

User Story(ies)

As a VANotify developer maintaining the Notification-API repo
I want to update the OpenAPI documentation on token formatting
So that the documentation reflects our tokens formatting accurately.

Additional Info and Resources

Image

Acceptance Criteria

  • OpenAPI documentation was updated correctly
  • This work is added to the sprint review slide deck (key win bullet point and demo slide)

QA Considerations

  • Confirm update to documentation was implemented correctly.

Potential Dependencies

@cris-oddball
Copy link

@cris-oddball to update this ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants