keycloak/keycloak-js

Add documentation for "scope" in JS adapter init options

Open

#23 opened on Jun 9, 2022

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)JavaScript (46 forks)auto 404
good first issue

Repository metrics

Stars
 (90 stars)
PR merge metrics
 (PR metrics pending)

Description

Description

The "scope" option is not documented in https://www.keycloak.org/docs/latest/securing_apps/index.html#javascript-adapter-reference even though it exists in the source code here: https://github.com/keycloak/keycloak/blob/3c19ad627f99ff5294b5619e1edc29c4710ae09b/adapters/oidc/js/src/keycloak.js#L151-L153.

Could it be added to the supported options in the documentation repository here: https://github.com/keycloak/keycloak-documentation/blob/main/securing_apps/topics/oidc/javascript-adapter.adoc#properties?

Discussion

No response

Motivation

No response

Details

No response

Contributor guide

Research direction
Locate the documentation file and add the 'scope' option to the init options list.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85