OpenAPITools / OpenAPITools/openapi-generator

[REQ][cpp-ue4] A working example

Open
#10,947 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

I don't know how to make use of the generated code.

Looking at the interfaces I get some idea, but it takes a while to grok and I'm still not sure if using it correctly.

For example, I'm setting up a request but getting malformed data back. Is that because of how I'm using it or something else?

Describe the solution you'd like

I would like to have a basic example of setting up a request, making the request, and handling the response using the generated code.

Some additional commenting about what functions I should be using and making calls from, or even a mini readme that gets generated along with the code.

(I would also like to have an example on this ticket to selfishly unblock me)

Additional context

This is my hacky code at the moment.

JIRACloudApiV2ServerInfoApi api;
api.SetURL("https://my.jira.instance/");
JIRACloudApiV2ServerInfoApi::GetServerInfoRequest req;
api.GetServerInfo(req);

And the error code I'm getting back.

[2021.11.24-00.26.33:596][ 45]LogJIRACloudApiV2: Error: Failed to deserialize Http response content (type:application/xml;charset=UTF-8):

Contributor guide

Open the contributing guide

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

The request concerns the cpp-ue4 generated client and its request/response usage; no repository file or test is named. Start by locating the cpp-ue4 generator templates and any existing generated documentation or examples, then compare the request setup, call, and response handling described in the issue. Done means a basic example plus usage comments or a generated mini-README explaining the relevant entry points.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, unreal-engine
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.