HathorNetwork / HathorNetwork/hathor-core

Parse and validate API parameters from OpenAPI

Open
#56 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
92
Forks
45
PR merge metrics
No merged PRs in 30d

Description

From [this comment](https://gitlab.com/HathorNetwork/hathor-python/-/merge_requests/365#note_281736002). @msbrogli suggested:

"Instead of manually validating each input, isn't it easier to get the basic validation rules from the OpenAPI Specification of each API?

I'd say we would be able to validate 99% of the input errors using it, and it would also return the parsed object. Maybe we should have a ParsedQuery object with the types so mypy can check the types as well."

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked merge-request comment and review how API parameters are currently handled in the repository. Define the scope for deriving validation and parsed types from each OpenAPI specification, including whether a ParsedQuery object and mypy support are required. Done means the intended parameter validation and parsing behavior is specified and implemented consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.