OpenAPITools/openapi-generator

Feature: [TypeScript] "CollectParameters" to accept params as option-bag

Open

#865 geöffnet am 21. Aug. 2018

Auf GitHub ansehen
 (15 Kommentare) (15 Reaktionen) (0 zugewiesene Personen)Java (7.516 Forks)batch import
Client: TypeScriptEnhancement: FeatureHacktoberfesthelp wanted

Repository-Metriken

Stars
 (26.243 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 9T 1h) (123 gemergte PRs in 30 T)

Beschreibung

Description

I would like the TypeScript code generator to support "CollectParameters" extension, which tells generated methods to accept all parameters as a single object / option-bag instead of multiple, positional arguments.

This extension is described here:
https://blog.apimatic.io/swagger-2-0-extension-for-code-generation-settings-abf602c3869d

openapi-generator version

3.2.1

OpenAPI declaration file content or url
paths:
  /favorites:
    get:
      operationId: GetFavorites
      x-operation-settings:
        CollectParameters: true
      parameters:
        - in: query
          name: account_id
          type: string
        - in: query
          name: user_id
          type: string
      responses:
        '200':
          description: '200'
          schema:
            $ref: '#/definitions/Favorites'

CollectParameters: true should generate client methods that accept an option-bag of params.

await client.getFavorites({account_id: '123', user_id: '456'});
Related issues/PRs

Rewrite of TypeScript generators

Contributor Guide

Research-Richtung
Untersuchen Sie die Behandlung der x operation settings Erweiterung im TypeScript Codegenerator und implementieren Sie die Unterstützung für CollectParameters. Sehen Sie sich an, wie der Generator derzeit Parameter behandelt, und ändern Sie ihn so, dass er bei CollectParameters true ein Optionspaket akzeptiert.
Tech Stack
typescriptjava
Domain
backendtooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitTypeScriptOpenAPI
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75