Document SCIM again #458
Document SCIM again #458
Conversation
✅ Deploy Preview for grist-help-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Reproducing the issueTo reproduce the original issue, you need to pull grist-core and apply this patch: diff --git a/app/client/apiconsole.ts b/app/client/apiconsole.ts
index 98bb59c0..3c6ae38b 100644
--- a/app/client/apiconsole.ts
+++ b/app/client/apiconsole.ts
@@ -327,7 +327,7 @@ createAppPage((appModel) => {
swaggerUI = buildSwaggerUI({
filter: true,
plugins: [gristPlugin.bind(null, appModel)],
- url: 'https://raw.githubusercontent.com/gristlabs/grist-help/master/api/grist.yml',
+ url: 'https://raw.githubusercontent.com/gristlabs/grist-help/b92a123677ee9d5b581b3edfd1f5c263d17bc54e/api/grist.yml',
domNode: rootNode,
showMutatedRequest: false,
requestInterceptor,Checking whether the fix worksYou may check whether the fix works by applying this patch: diff --git a/app/client/apiconsole.ts b/app/client/apiconsole.ts
index 98bb59c0..6b13a660 100644
--- a/app/client/apiconsole.ts
+++ b/app/client/apiconsole.ts
@@ -327,7 +327,7 @@ createAppPage((appModel) => {
swaggerUI = buildSwaggerUI({
filter: true,
plugins: [gristPlugin.bind(null, appModel)],
- url: 'https://raw.githubusercontent.com/gristlabs/grist-help/master/api/grist.yml',
+ url: 'https://raw.githubusercontent.com/gristlabs/grist-help/2d344f32d9fccbb32195c4ffa7cc5894c39ce76f/api/grist.yml',
domNode: rootNode,
showMutatedRequest: false,
requestInterceptor,I will make a self-review tomorrow. If you anyone wants to review until then, they are welcome |
help/en/docs/install/scim.md
Outdated
| Below is a list of environment variables you may use to configure SCIM: | ||
|
|
||
| - `GRIST_ENABLE_SCIM`: set its value to `true` so you enable the SCIM endpoints. | ||
| - `GRIST_SCIM_USER`: (optional) give this variable the email address of an account to give it access to the SCIM endpoints. |
There was a problem hiding this comment.
| - `GRIST_SCIM_USER`: (optional) give this variable the email address of an account to give it access to the SCIM endpoints. | |
| - `GRIST_SCIM_USER`: (optional) give this variable the email address of an account to give to it access to the SCIM endpoints. |
There was a problem hiding this comment.
I don't agree, we should say give [someone/something] access. It's ditransitive (source)
There was a problem hiding this comment.
Also the wiktionary gives the example of the give verb for the ditransitivity:
(of a verb) taking two objects, such as give in “Give me the ball” (where me is an indirect object and the ball is a direct object). Compare intransitive, transitive, and ambitransitive verbs.
help/en/docs/install/scim.md
Outdated
|
|
||
| ## The API | ||
|
|
||
| The SCIM implementation is documented in the [Grist Rest API reference](/api/#tag/scim). |
There was a problem hiding this comment.
| The SCIM implementation is documented in the [Grist Rest API reference](/api/#tag/scim). | |
| The SCIM implementation is documented in the [Grist REST API reference](/api/#tag/scim). |
api/scim/users.yml
Outdated
| summary: Retrieve list of users | ||
| operationId: getUsers | ||
| tags: | ||
| - users |
There was a problem hiding this comment.
Remove the users tag. Makes everything redundant in the API documentation.
Same below.
There was a problem hiding this comment.
Also add the endpoint so it is referenced in the left menu
|
Thank you @hexaltation! |
Restore #434 fixing the issue with the SCIM API yaml.