Transfer descriptions of attributes from XML Schema Definitions
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- Python
- Stars
- 16
- Forks
- 50
- PR merge metrics
- No merged PRs in 30d
Description
For uploading, there are .xsd files which not only define the typedness of various attributes, but they also contain a textual description of the attribute. We should preserver this documentation and include it in the final REST API documentation.
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.
Research direction
Start by locating the upload handling for .xsd files and the process that produces the final REST API documentation. Check how typed attributes are transferred, then preserve each XSD textual description in the resulting documentation; done means those descriptions appear alongside the corresponding attributes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, xml
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100