swagger-api/swagger-codegen

[Swift] responses: schema: type: object --> RequestBuilder<Inline_response_200> ?

Open

#2,093 opened on Feb 10, 2016

View on GitHub
 (31 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: SwiftEnhancement: Generalhelp wanted

Description

When I feed an API with the following responses definition:

      responses:
        '200':
          description: Request was successful
          schema:
            type: object

the codegen generates something like the following client-side code:

public class func usercount(Swaggerwhere Swaggerwhere: String?) -> RequestBuilder<Inline_response_200> {

where I don't understand how to handle the returned object value...? I would expect an plain object is mapped to a dictionary so that access key-value pairs can be read... Would you kindly tell me if I'm mistaking something?

When I tried Obj-C and it also behaves in a similar manner:

-(NSNumber*) userCountWithCompletionBlock :(NSString*) where
    completionHandler: (void (^)(XXInlineResponse200* output, NSError* error))completionBlock;

So, there might be some design decision already discussed and it has been decided to generate Inline_response_200 thing for object response type. But I still don't see how to handle the returned object. Any help would be much appreciated! (@bajtos wanted to keep informed about this too)

Contributor guide

Tech stack
swiftobjective c
Domain
apideveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swift programmingOpenAPI specification basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Examine the Swift code generation templates in the swagger codegen repository, specifically how response schema of type 'object' is handled. Review the generated Inline response 200 class to understand its structure. Check the issue comments for any proposed solutions or workarounds. Consider adding documentation or modifying the template to generate a dictionary type instead of a custom class when the schema is undefined object.
[Swift] responses: schema: type: object --> RequestBuilder<Inline_response_200> ? · swagger-api/swagger-codegen#2093 | Good First Issue