Topic description still valid?

Open
#337 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
api, documentation

Research direction

Review the README and the referenced Schemas/Collaboration/Topic/topic_GET.json entry. First establish whether the description field remains valid in the current and feature versions; done when its status is clarified and the README or schema documentation reflects the decision.

Written by the indexing model from the issue text.

Description

Hello, topic defines a description but is not documented in the readme.
https://github.com/buildingSMART/BCF-API/blob/edfde645e1a53955ad2774374fc60f909f99b8c0/Schemas/Collaboration/Topic/topic_GET.json#L66
Is this still a valid field in the current and feature version?

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from buildingSMART/BCF-API

All issues in buildingSMART/BCF-API

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.