OpenAPI/Swagger 仕様の一部として解釈できる JSON ファイルを検出します。

そのようなファイルには明示的な仕様属性は含まれていませんが、近くにあるプライマリ仕様ファイルから参照されます。

次の例では、同じディレクトリに存在する 2 つのファイルがあります。 1 つ目のファイルは単純なプライマリ仕様ファイルです。 2 つ目は最初のファイルから参照されているため、同様に仕様と見なすことが提案されます。

プライマリ仕様ファイル openapi.yaml:


openapi: 3.1.0
components:
  schemas:
    CustomSchema:
      description: Custom schema object
      properties:
        foo:
          $ref: 'common.components.json#/components/schemas/CommonSchema'

仕様ファイル候補 common.components.json:


{
  "components": { // 'Mark file as OpenAPI specification' highlighting
    "schemas": {
      "CommonSchema": {
        "description": "Common schema object reused in several specifications"
      }
    }
  }
}