OpenAPITools / OpenAPITools/openapi-generator

[BUG][swift5] Optional parameters miss delimiters

Open
#5,774 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Client: Swift Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • What's the version of OpenAPI Generator used?
  • Have you search for related issues/PRs?
  • [-] What's the actual output vs expected output?
  • [-] [Optional] Bounty to sponsor the fix (example)
Description

Generating a client with the swift5 generator yields missing delimiters in function declarations.

openapi-generator version

4.3.0

OpenAPI declaration file content or url

The spec is public, see https://github.com/cedricziel/instana-swift/blob/master/meta/openapi.json

Command line used for generation

See below.

Steps to reproduce

Check the following commit that corrects some of the issues after generation: https://github.com/cedricziel/instana-swift/commit/20c7093c1be526923b75c803ff1811827f1bb573

You can checkout the repo and run ./regenerate.sh to reproduce.

Related issues/PRs
Suggest a fix

It is not deterministic to me and seems to have something to do with the hasMore helper in the template.

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

Start by checking the referenced regenerate.sh script and the Swift generator template code around the hasMore helper. Regenerate the client from the linked public OpenAPI spec, compare the function declarations with the linked corrective commit, and verify that optional parameters have the expected delimiters.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, swift
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.