Materials-Consortia / Materials-Consortia/optimade-python-tools
Adding markdown links to OpenAPI schema
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 91
- Forks
- 54
- PR merge metrics
- No merged PRs in 30d
Description
I don't know that it's always preceded by "section", but maybe we can create an issue suggesting adding links to the OpenAPI descriptions and leave it for later to not block the release of v1.0.0-rc.2?
Originally posted by @CasperWA in https://github.com/Materials-Consortia/optimade-python-tools/pull/351
As seen in the quote above, I tried implementing this already in #351, however, due to the pressing release of v1.0.0-rc.2 of the OPTIMADE API specification, this addition was considered non-essential and too time consuming to implement in that PR.
Instead it has now become this issue, to track the progress of adding the various hyperlinks.
Contributor guide
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 reading the issue context and pull request #351, which contains the earlier attempted implementation. Trace where the OpenAPI descriptions are generated and identify the various descriptions that need hyperlinks; done means the relevant schema descriptions include the agreed links without blocking the release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100