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

feat: documenting sessions #31

Merged
merged 3 commits into from
Jan 11, 2023
Merged

feat: documenting sessions #31

merged 3 commits into from
Jan 11, 2023

Conversation

jleon15
Copy link
Contributor

@jleon15 jleon15 commented Jan 11, 2023

Description

  • Remove expiring app docs
  • Add session docs

Testing required outside of automated testing?

  • Not Applicable

Screenshots (if appropriate):

  • Not Applicable

Rollback / Rollforward Procedure

  • Roll Forward
  • Roll Back

Reviewer Checklist

  • Description of Change
  • Description of outside testing if applicable.
  • Description of Roll Forward / Backward Procedure
  • Documentation updated for Change

@jleon15 jleon15 requested a review from a team as a code owner January 11, 2023 02:29
@vercel
Copy link

vercel bot commented Jan 11, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
developers-basistheory-com ✅ Ready (Inspect) Visit Preview Jan 11, 2023 at 4:23PM (UTC)

@jleon15 jleon15 changed the title removing expiring apps docs and adding sessions feat: removing expiring application docs and adding sessions docs Jan 11, 2023
@jleon15 jleon15 changed the title feat: removing expiring application docs and adding sessions docs feat: documenting sessions Jan 11, 2023
sidebars.js Outdated
@@ -261,6 +261,7 @@ const sidebars = {
"api/tokens/token-associations",
],
},
"api/sessions",
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be nested under applications nav item.

Copy link
Contributor

Choose a reason for hiding this comment

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

But why? The api routes for sessions are not nested under applications and sessions are separate from applications. I feel like if we want to group them together we should change the top level from Applications to something like Access Controls and nest Sessions, Applications, and Permissions all underneath

@dhudec
Copy link
Contributor

dhudec commented Jan 11, 2023

GH won't let me comment on an unchanged line.. so here:

This line should probably change to say

Your ability to authenticate to the Basis Theory API is granted through an API Key associated with an Application or Session.

sidebars.js Outdated
items: ["api/applications/permissions"],
items: [
"api/applications/permissions",
"api/sessions"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we move the doc under the applications folder also so grouping matches?

@jleon15 jleon15 merged commit d732633 into master Jan 11, 2023
@jleon15 jleon15 deleted the eng-4000 branch January 11, 2023 16:26
bt-platform-eng pushed a commit that referenced this pull request Jan 11, 2023
# [1.11.0](v1.10.0...v1.11.0) (2023-01-11)

### Features

* documenting sessions ([#31](#31)) ([d732633](d732633))
@bt-platform-eng
Copy link

🎉 This PR is included in version 1.11.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

4 participants