Document Seam workspace scope #483
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DebbieAtSeam
approved these changes
Jan 14, 2025
src/layouts/api-endpoint.hbs
Outdated
| @@ -34,6 +34,9 @@ | |||
|
|
|||
| {{#each authMethods}} | |||
| - {{this}} | |||
| {{#if (eq this 'Personal access token')}} | |||
| - {{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request{{/if}} | |||
There was a problem hiding this comment.
Suggested change
| - {{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request{{/if}} | |
| - {{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request.{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request.{{/if}} |
Please add a period at the end of the statements for consistency with descriptions. Also, do you think it would look OK if we removed the nested bulleted list?
There was a problem hiding this comment.
Sure! Here's the commit f495396
There was a problem hiding this comment.
The statement wasn't rendering on a new line with the nested bullet point so I added the line break tag and it seems to work now. Let me know what you think.
There was a problem hiding this comment.
@andrii-balitskyi Looks excellent to me! Many thanks!
razor-x
approved these changes
Jan 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #461