runtimeverification / runtimeverification/haskell-backend
Proposal: drop `format` and `version` fields from the `kore-rpc` schema
Nobody has claimed this yet.
- Dominant language
- Haskell
- Stars
- 224
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
Instead of
{"format": "KORE", "version": 1, "term": {...}}
use the more concise
{...}
to encode KORE terms.
Rationale
The value for the "format" field is always "KORE", so it is superfluous. The value for the "version" field should be implied by the API version, so it can be extracted to either the response root or a separate endpoint, or dropped altogether.
Related discussion: https://github.com/runtimeverification/haskell-backend/pull/3604#discussion_r1230769595
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 reviewing the kore-rpc schema described in the issue and the related discussion in PR #3604. Resolve whether the version is represented at the response root, exposed through a separate endpoint, or dropped. Done means the agreed encoding no longer includes the redundant format and version fields and the API behavior is specified consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100