Add doc annotation #3530
Open
Add doc annotation #3530
+478
−89
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
…es page to include the referenced cookies
This is a six digit, zero padded version of the semver version number. If it is passed, then the contents of AvailableSince only get rendered if the since value is greater than the showSince value. this handles the case where we are adding a field definition into a new component. For example, the user.login.suspicious event was added in 1.30.0 and returns an authentication type. But some of those authentication types (Apple) were added before this event was added.
…new showSince attribute
note that I only disabled it in the webhooks because I fiddled with it for 15 min and couldn't figure out how to both display the interpolated variable value and use markdown for the code formatting
bhalsey
reviewed
Feb 26, 2025
spwitt
requested changes
Feb 26, 2025
astro/src/content/docs/apis/entities/_entity-search-request-parameters.mdx
Outdated
Show resolved
Hide resolved
astro/src/content/docs/apis/_user-search-request-parameters.mdx
Outdated
Show resolved
Hide resolved
| const { showVersion } = Astro.props; | ||
| --- | ||
|
|
||
| <ul> |
There was a problem hiding this comment.
I'm not sure I understand the need for this and authentication-type-values.astro. They are identical other than the logic for showing the version.
This component is only used with showVersion=true. I think authentication-type-values.astro can achieve the same thing by passing showSince=1.0.0
Fixed copy pasta typos and use markdown for links. Co-authored-by: Spencer Witt <[email protected]>
…sionauth-site into mooreds/add-doc-annotation
spwitt
approved these changes
Feb 27, 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.
This is an update to #3503
This doc PR is tied to https://github.com/FusionAuth/fusionauth-app/pull/655
It consumes JSON generated by processing annotations and then builds reference documentation from it.
The missing piece that I'm still working on is the script which reads the annotations and builds the JSON. That will live in another repo and be called on a schedule, similar to https://github.com/FusionAuth/fusionauth-theme-history-updater/
That will require some additional permissions and work, but I wanted to get this up for review, since there's value in merging this today (since it is up to date for 1.55.1 code).