OpenRefine / OpenRefine/OpenRefine
Clean up and document REST API
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 12k
- Forks
- 2.2k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 27
Description
The current REST API was designed and implemented organically, so it is not always internally consistent, which in turn hinders the ability to use common code to generate and consume responses. There are also places where it doesn't follow best REST practices.
This top level ticket collects the various things that we need to do as part of this.
Acceptance criteria
- Revised protocol which follows best practices
- Swagger/OpenAPI definition which matches the implementation
- both web client and server updated to new protocol
Alternatives considered
Leave things as they are
Additional context
This cleanup is independent of any decision as to whether to support the API for external use by anything other than the OpenRefine web client. That would require a protocol test suite, additional documentation, and perhaps supported client libraries.
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
No files, tests, or entry points are named. Begin by mapping the current REST protocol across the web client and server, then define the revised protocol and corresponding Swagger/OpenAPI definition; done means both implementations match the revised protocol.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, full-stack
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100