JanssenProject / JanssenProject/jans

Review schema descriptions

Open
#1,063 1 comment 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
Java
Stars
648
Forks
174
Avg merge
1d 18h
Merged PRs (30d)
110

Description

There are descriptions in `jans_schema.json` looking off or that can be enhanced at least. Examples:

- Several attributes have `"desc": "jans Policy URI"`.
- Extremely concise like `"desc": "jans Req Obj Enc Alg"` (average dev cannot guess what this is about)

If the schema had better descriptions we would avoid creating duplicate attributes.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the descriptions in jans_schema.json, especially attributes using "jans Policy URI" and "jans Req Obj Enc Alg". Identify other overly terse or misleading descriptions and compare nearby schema entries for context. Done means the relevant descriptions clearly explain their attributes and reduce the risk of duplicate attributes.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.