Support defining query params as object properties

オープン
#84 コメント 1 件 リアクション 5 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
45/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi, typescript
領域
api

調査の方向性

Start with the failing test suite linked in PR #83 and trace how query parameters are handled when their schema is an object. Compare that path with the OpenAPI 3.x example in the issue. Done means the demonstrated free-form query parameter is accepted and the failing tests pass.

索引モデルが issue の本文から書いたものです。

説明

enhancement help wanted new feature

OpenAPI 3.x supports specifying accepted query parameters as a schema object, which among other things allows API spec authors to accept free-form parameters 🎉

Unfortunately, this does not currently work in OpenAPI Backend - I added a PR here with a failing test suite to demonstrate: #83

Here's an example from the docs:

{
  "in": "query",
  "name": "freeForm",
  "schema": {
    "type": "object",
    "additionalProperties": {
      "type": "integer"
    },
  },
  "style": "form"
}
主要言語
TypeScript
スター
689
フォーク
97
平均マージ
2時間 36分
マージ済み PR(30日)
11

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

openapistack/openapi-backend のほかの issue

openapistack/openapi-backend の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。