MS3Inc / MS3Inc/camel-restdsl-openapi-plugin

Implementation stubs should contain examples from spec

Open
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
3
Forks
3
Avg merge
25m
Merged PRs (30d)
1

Description

API specs often include examples of what is returned by a request. This task explores how to detect examples in an OpenAPI document and add them to generated code using setBody(). Currently the returned value is a JSON body with a property for the opId.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the plugin reads an OpenAPI document and generates route implementation stubs. Identify where the current JSON body containing the opId is produced, then verify how examples can be detected and passed to setBody(). Done means generated stubs use the specification’s response examples when available.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.