ergoplatform / ergoplatform/explorer-backend
Incompatible doc
- Dominant language
- Scala
- Stars
- 23
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
The documentation for V1 contains type inconsistencies with the actual API return types. For instance, the `additionalRegisters` field is documented as a simple string for each key, but the actual return value is an object containing `serializedValue` and `renderedValue`. This inconsistency can cause misunderstandings for users and more serious issues when using autogenerated API response types based on the documentation.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the V1 API documentation and the response definition for additionalRegisters. Compare the documented field types with the actual return structure, including serializedValue and renderedValue, then update the inconsistent documentation and verify that the V1 response types are accurately represented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100