matrix-org / matrix-org/matrix-spec
Identity-service API: Terms of service retrieval endpoint response is not fully specified
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Link to problem area**: https://matrix.org/docs/spec/identity_service/latest#get-matrix-identity-v2-terms
**Issue**
The schema for `Policy Object` (maybe rename it to `Policies`?) lists only the version field, while from the example it becomes clear that there can be arbitrary other keys, each one containing an object that in turn holds a name and url field.
Contributor guide
Research direction
Start at the GET /_matrix/identity/v2/terms section linked in the issue and compare the Policy Object schema with its example. Update the specification so the schema describes the version field and arbitrary policy entries containing name and url fields, then verify it matches the example.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100