Remove closed issues referenced in docs #3327

alex-fusionauth · 2024-10-10T18:10:30Z

441
171
275
494
77
1319
added in 1.45
1699
1939
2237
2736

mooreds · 2024-10-11T22:01:29Z

will take a look at this in a week or so, @alex-fusionauth . Sorry for the delay.

mooreds

Some changes requested.

As you indicated, most of the complexity is around the patch issue. Let's talk about that sync if needed.

mooreds · 2024-10-21T20:40:37Z

astro/src/components/api/API.astro

  description?: string;
-  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';


I don't feel comfortable changing the quote choice in this kind of PR. From looking at a few other components, we seem to use single quotes.

Please either reverse or get @lyleschemmerling or another engineer to bless these changes.

mooreds · 2024-10-21T20:41:01Z

astro/src/components/api/API.astro

  }

  // Optionally extract one or more segment.
-  let type = 'literal';
-  let atom = '';
+  let type = "literal";


I don't feel comfortable changing the quote choice in this kind of PR. From looking at a few other components, we seem to use single quotes.

Please either reverse or get @lyleschemmerling or another engineer to bless these changes.

I just had a chat in the engineering huddle with the team this morning. I do think that we are going to go with double quotes, but I want to get that into eslint and then do a big bang commit that cleans up the code per the rules

mooreds · 2024-10-21T20:41:06Z

astro/src/components/api/API.astro


  for (let i = 0; i < url.length; i++) {
    let c = url.charAt(i);
    atom += c;

-    if (c === '{') {
+    if (c === "{") {


I don't feel comfortable changing the quote choice in this kind of PR. From looking at a few other components, we seem to use single quotes.

Please either reverse or get @lyleschemmerling or another engineer to bless these changes.

mooreds · 2024-10-21T20:44:02Z

...c/content/docs/apis/identity-providers/_identity-provider-login-method-request-parameter.mdx

@@ -11,6 +11,6 @@ import APIField from 'src/components/api/APIField.astro';

  {props.idp_type === 'Google' && <>
    <span class="text-green-600">Since 1.44.0</span> <br/>
-    <strong>If you are using a version of FusionAuth older than 1.44.0</strong>, <code>UsePopup</code> won't work. <code>UseRedirect</code> will continue to work after this date. Please see <a href="https://github.com/FusionAuth/fusionauth-issues/issues/1939">Issue #1939</a> for more. This <a href="/community/forum/topic/2329/upcoming-google-identity-provider-changes">forum post</a> has more details on an available workaround and upgrade process.
+    <strong>If you are using a version of FusionAuth older than 1.44.0</strong>, <code>UsePopup</code> won't work. <code>UseRedirect</code> will continue to work after this date. Please see [release 1.44.0](/docs/release-notes/#version-1-44-0) for more information. This <a href="/community/forum/topic/2329/upcoming-google-identity-provider-changes">forum post</a> has more details on an available workaround and upgrade process.


Suggested change

<strong>If you are using a version of FusionAuth older than 1.44.0</strong>, <code>UsePopup</code> won't work. <code>UseRedirect</code> will continue to work after this date. Please see [release 1.44.0](/docs/release-notes/#version-1-44-0) for more information. This <a href="/community/forum/topic/2329/upcoming-google-identity-provider-changes">forum post</a> has more details on an available workaround and upgrade process.

<strong>If you are using a version of FusionAuth older than 1.44.0</strong>, <code>UsePopup</code> won't work. <code>UseRedirect</code> will continue to work after this date. Please see [the 1.44.0 release notes](/docs/release-notes/#version-1-44-0) for more information. This [forum post](/community/forum/topic/2329/upcoming-google-identity-provider-changes) has more details on an available workaround and upgrade process.

mooreds · 2024-10-21T20:44:18Z

astro/src/content/docs/customize/look-and-feel/helpers.mdx

@@ -190,5 +190,5 @@ If you wish to enable an [invisible reCAPTCHA](https://developers.google.com/rec
 ```

 <Aside type="note">
-On versions of FusionAuth prior to 1.46.0 you will need to update the JavaScript in order to properly handle the form submit for invisible reCAPTCHA. See [this GitHub issue](https://github.com/FusionAuth/fusionauth-issues/issues/2237) for more information.
+On versions of FusionAuth prior to 1.46.0 you will need to update the JavaScript in order to properly handle the form submit for invisible reCAPTCHA. See [release 1.46.0](/docs/release-notes/#version-1-46-0) for more information.


Suggested change

On versions of FusionAuth prior to 1.46.0 you will need to update the JavaScript in order to properly handle the form submit for invisible reCAPTCHA. See [release 1.46.0](/docs/release-notes/#version-1-46-0) for more information.

On versions of FusionAuth prior to 1.46.0 you will need to update the JavaScript in order to properly handle the form submit for invisible reCAPTCHA. See [the 1.46.0 release notes](/docs/release-notes/#version-1-46-0) for more information.

mooreds · 2024-10-21T21:51:40Z

astro/src/content/docs/lifecycle/migrate-users/general-migration.mdx

@@ -501,7 +501,7 @@ FA_HOST=...
 curl -H "Authorization: $API_KEY" $FA_HOST'/api/user/search?queryString=data.migrated%3Atrue%0A'
 ```

-This will return all the users who've been migrated as well as a count, subject to the limits of FusionAuth's Elasticsearch integration. See this [GitHub issue](https://github.com/FusionAuth/fusionauth-issues/issues/494) for more on those limits. Here's an example of the output:
+This will return all the users who've been migrated as well as a count, subject to the limits of FusionAuth's Elasticsearch integration. See [Maximum Users Returned Workarounds](/docs/get-started/core-concepts/limitations#maximum-users-returned-workarounds) for how to get more from search. Here's an example of the output:


Suggested change

This will return all the users who've been migrated as well as a count, subject to the limits of FusionAuth's Elasticsearch integration. See [Maximum Users Returned Workarounds](/docs/get-started/core-concepts/limitations#maximum-users-returned-workarounds) for how to get more from search. Here's an example of the output:

This will return all the users who've been migrated as well as a count, subject to the limits of FusionAuth's Elasticsearch integration. Prior to version 1.48.0, there were limits on the number of users returned [which required workarounds](/docs/get-started/core-concepts/limitations#maximum-users-returned-workarounds). After version 1.48.0, [use pagination to retrieve all users](/docs/lifecycle/manage-users/search/search#extended-pagination).

Here's an example of the output:

mooreds · 2024-10-21T22:00:18Z

astro/src/content/docs/lifecycle/authenticate-users/single-sign-on.mdx

@@ -376,5 +376,5 @@ Navigate to <Breadcrumb>Applications -> Your Application -> OAuth</Breadcrumb> a

 * You can view the [example application's codebase](https://github.com/fusionauth/fusionauth-example-node-sso).
 * The [Tenant API](/docs/apis/tenants) can be used to manage single sign-on related configuration.
-* This guide uses the hosted login pages. If you are using the Login API and building your own pages, [check out the comments on this issue](https://github.com/FusionAuth/fusionauth-issues/issues/171) for guidance.
+* This guide uses the hosted login pages. If you are using the Login API and building your own pages, [see our Login API Overview](/docs/lifecycle/authenticate-users/login-api/) for guidance.


Hmmm. If you look at the comments on 171, particularly FusionAuth/fusionauth-issues#171 (comment) then it is clear our overview is not a substitute.

But I don't think we want to document using the login API to recreate SSO at this time (which would require sifting through those comments, making an example app, etc).

Suggested change

* This guide uses the hosted login pages. If you are using the Login API and building your own pages, [see our Login API Overview](/docs/lifecycle/authenticate-users/login-api/) for guidance.

* This guide uses the hosted login pages.

So I'd suggest this.

mooreds · 2024-10-21T22:00:54Z

astro/src/content/docs/lifecycle/authenticate-users/single-sign-on.mdx

@@ -15,7 +15,7 @@ import SessionsExpiration from 'src/content/docs/lifecycle/authenticate-users/_s
 import SSOLogin from 'src/diagrams/docs/lifecycle/authenticate-users/sso-login.astro';
 import SSOLogout from 'src/diagrams/docs/lifecycle/authenticate-users/sso-logout.astro';
 import { YouTube } from '@astro-community/astro-embed-youtube';
-import {RemoteCode} from '@fusionauth/astro-components';
+import { RemoteCode } from '@fusionauth/astro-components';


Suggested change

import { RemoteCode } from '@fusionauth/astro-components';

import {RemoteCode} from '@fusionauth/astro-components';

Consistency :)

mooreds · 2024-10-21T22:01:31Z

astro/src/content/docs/lifecycle/authenticate-users/oauth/modes.mdx

@@ -214,7 +214,7 @@ The **First-party service authorization** mode is the inverse of the **Third-par

 With this mode, your OAuth server might display a "permission grant screen" to the user asking if they want to grant the third-party application permissions to your APIs. This isn't strictly necessary and depends on your requirements, but if it is, you want custom scopes.

-Custom scopes are not currently supported in FusionAuth; here's the [GitHub tracking issue](https://github.com/FusionAuth/fusionauth-issues/issues/275).
+Custom scopes are now supported in FusionAuth; you can find more information within [OAuth Scopes](/docs/get-started/core-concepts/scopes).


Suggested change

Custom scopes are now supported in FusionAuth; you can find more information within [OAuth Scopes](/docs/get-started/core-concepts/scopes).

Custom scopes are now supported in FusionAuth; you can find more information in the [OAuth Scopes documentation](/docs/get-started/core-concepts/scopes).

mooreds · 2024-10-21T22:02:50Z

astro/src/content/docs/lifecycle/authenticate-users/multi-factor-authentication.mdx

-The reason you need to retrieve the user and modify the data, then use `PUT` to update it, is because of how `PATCH` handles arrays.
-[Read this tracking issue for more info.](https://github.com/FusionAuth/fusionauth-issues/issues/441)
+{/* TODO: check if this still makes sense */}
+<StaticPatchNote />


I would not put the static patch note here. I do think that you can remove Read this tracking issue for more info.](https://github.com/FusionAuth/fusionauth-issues/issues/441) and point folks at https://fusionauth.io/docs/apis/#the-patch-http-method

lyleschemmerling · 2024-10-22T18:28:00Z

astro/src/components/api/API.astro

-  'client-credentials': '/docs/apis/authentication#client-credentials',
-  'local-bypass': '/docs/apis/authentication#localhost-authentication-bypass'
-}
+  "api-key": "/docs/apis/authentication#api-key-authentication",


Were you running Prettier or something similar, or were just going off of rules in VS Code?

lyleschemmerling · 2024-10-22T18:28:47Z

astro/src/components/api/API.astro

-            <APIAuthenticationIcon type={auth}/>
-          </a>
+{
+  (authentication || title) && (


Yeah the formatting changes are pretty distracting and it is hard to tell what is content and what is syntax

lyleschemmerling · 2024-10-22T18:34:38Z

astro/src/content/docs/sdks/_static-patch-note.mdx

+*/}
+
+<Aside type="note" title="Please read">
+  <p>When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either <a href="https://www.rfc-editor.org/rfc/rfc6902">JSON Patch/RFC 6902]</a> or <a href="https://www.rfc-editor.org/rfc/rfc7396">JSON Merge Patch/RFC 7396</a>. See the <a href="/docs/apis/#the-patch-http-method">PATCH documentation</a> for more information.</p>


Another thing I have a linter check WIP for

lyleschemmerling · 2024-10-22T18:38:48Z

astro/src/content/docs/sdks/_static-patch-note.mdx

-An alternative that allows you to use typed objects immediately is to perform a retrieve operation, modify the object in memory, and then execute an update operation. These are functionally equivalent to a single `PATCH` operation.
-
+{/* 
+TODO: Does this make sense to update fully to allowing PATCH in this way?


Agree, looking at https://fusionauth.io/docs/sdks/java#patch-requests there is a lot of extra information in there that vanishes when using this aside

lyleschemmerling · 2024-10-22T18:40:05Z

astro/src/components/api/API.astro

+  showPatch && method == "PUT" && (
+    <div class="mb-14">
+      <Astro.self method="PATCH" uri={uri} />
+      <StaticPatchNote />


This actually looks right for the api doc, but is not what we want on the sdk pages

alex-fusionauth added 11 commits October 8, 2024 16:19

441

37c7344

171

a58101f

275

e353151

494

edb831d

77

879fd6f

1319

df1c7fc

added in 1.45

8b150ca

1699

7c9e26d

1939

6669ccb

2237

e730698

2736

d95bdd6

alex-fusionauth requested review from a team as code owners October 10, 2024 18:10

alex-fusionauth added 2 commits October 10, 2024 15:41

fix doc link

186900c

urls ugh

7388f46

mooreds requested changes Oct 21, 2024

View reviewed changes

lyleschemmerling reviewed Oct 22, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove closed issues referenced in docs #3327

Remove closed issues referenced in docs #3327

alex-fusionauth commented Oct 10, 2024

mooreds commented Oct 11, 2024

mooreds left a comment •

edited

Loading

mooreds Oct 21, 2024

mooreds Oct 21, 2024

lyleschemmerling Oct 22, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

mooreds Oct 21, 2024

lyleschemmerling Oct 22, 2024

lyleschemmerling Oct 22, 2024

lyleschemmerling Oct 22, 2024

lyleschemmerling Oct 22, 2024

lyleschemmerling Oct 22, 2024

		description?: string;
		method: 'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE';

	On versions of FusionAuth prior to 1.46.0 you will need to update the JavaScript in order to properly handle the form submit for invisible reCAPTCHA. See [release 1.46.0](/docs/release-notes/#version-1-46-0) for more information.
	On versions of FusionAuth prior to 1.46.0 you will need to update the JavaScript in order to properly handle the form submit for invisible reCAPTCHA. See [the 1.46.0 release notes](/docs/release-notes/#version-1-46-0) for more information.

	* This guide uses the hosted login pages. If you are using the Login API and building your own pages, [see our Login API Overview](/docs/lifecycle/authenticate-users/login-api/) for guidance.
	* This guide uses the hosted login pages.

	import { RemoteCode } from '@fusionauth/astro-components';
	import {RemoteCode} from '@fusionauth/astro-components';

	Custom scopes are now supported in FusionAuth; you can find more information within [OAuth Scopes](/docs/get-started/core-concepts/scopes).
	Custom scopes are now supported in FusionAuth; you can find more information in the [OAuth Scopes documentation](/docs/get-started/core-concepts/scopes).

Remove closed issues referenced in docs #3327

Are you sure you want to change the base?

Remove closed issues referenced in docs #3327

Conversation

alex-fusionauth commented Oct 10, 2024

mooreds commented Oct 11, 2024

mooreds left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mooreds left a comment •

edited

Loading