Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Support for anyOf/minProperties for required schema properties.

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

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
42/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
停滞
技術スタック
openapi, react, typescript
領域
documentation

調査の方向性

Start by reproducing the issue with the provided OpenAPI YAML and inspect the schema-rendering path that produces the Docusaurus Tabs error. Support the anyOf required-property case, including minProperties if relevant; done means the page renders and communicates the either/or requirement without the no-TabItem error.

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

説明

bug

Describe the bug

Given the following schema the generated page does not properly render and instead gives an error:

Docusaurus error: the <Tabs> component requires at least one <TabItem> children component
post:
  tags:
  - Suggested Entitlement Description
  operationId: submitSedBatchRequest
  summary: Submit Sed Batch Request
  description: 'Submit Sed Batch Request.

    Request body has one of the following:
      - a list of entitlement Ids
      - a list of SED Ids
    that user wants to have description generated by LLM. 
    API responses with batchId that groups Ids together'
  requestBody:
    description: Sed Batch Request
    content:
      application/json:
        schema:
          description: Sed Batch Request
          type: object
          anyOf:
            - required: [entitlements]
            - required: [seds]
          properties:
            entitlements:
              description: list of entitlement ids
              type: array
              items:
                type: string
                example: 016629d1-1d25-463f-97f3-c6686846650
            seds:
              description: list of sed ids
              type: array
              items:
                type: string
                example: 016629d1-1d25-463f-97f3-c6686846650

Expected behavior

Request body should display and show that you must specific either an array of entitlements or an array of sed ids.

Current behavior

I receive the error above, I believe this is because the plugin is not accounting for this use-case in open api specification.

Possible solution

Steps to reproduce

Create a schema with the use of anyOf property to denote that you must include either property.

Screenshots

Context

Your Environment

  • Version used:
  • Environment name and version (e.g. Chrome 59, node.js 5.4, python 3.7.3): Node v20.9.0
  • Operating System and version (desktop or mobile): MacOS Sonoma 14.7
  • Link to your project:
主要言語
TypeScript
スター
1.1k
フォーク
319
平均マージ
2日 8時間
マージ済み PR(30日)
28

環境構築

はじめの一歩

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

PaloAltoNetworks/docusaurus-openapi-docs のほかの issue

PaloAltoNetworks/docusaurus-openapi-docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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