Clarify server handling of related topics
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 50/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- api, documentation
Research direction
Start with the documentation or README referenced in the issue and find the section describing related topics and topic retrieval. Clarify that servers supporting topic relations return every relation in related_topics in both directions, so clients do not need to enumerate other topics. Done means this behavior is stated unambiguously.
Written by the indexing model from the issue text.
Description
This came up from @pasi-paasiala
We should update the documentation / README to ensure that it's clear that servers that support topic relations are always expected to return all the relations when getting topic data, so that a client would never have to enumerate all other topics to check if a relation exists.
Meaning, if we query the server to get a "child" topic, it will include the "parent" topic in it's 'related_topics' list (and vice versa).
- Dominant language
- No language data
- Stars
- 238
- Forks
- 67
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from buildingSMART/BCF-API
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
buildingSMART/BCF-API#395 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
buildingSMART/BCF-API#394 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
buildingSMART/BCF-API#392 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 45/100
buildingSMART/BCF-API#390 ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
buildingSMART/BCF-API#389 · 2 comments ·
All issues in buildingSMART/BCF-API
Similar issues
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100