schema-components - v3.7.0
    Preparing search index...

    Variable REF_PREFIXESConst

    REF_PREFIXES: {
        components: {
            schemas: "#/components/schemas/";
            parameters: "#/components/parameters/";
            responses: "#/components/responses/";
            requestBodies: "#/components/requestBodies/";
            headers: "#/components/headers/";
            examples: "#/components/examples/";
            links: "#/components/links/";
            callbacks: "#/components/callbacks/";
            securitySchemes: "#/components/securitySchemes/";
            pathItems: "#/components/pathItems/";
        };
        swagger2: {
            definitions: "#/definitions/";
            parameters: "#/parameters/";
            responses: "#/responses/";
        };
    } = ...

    Canonical $ref prefix table for the JSON Pointer locations used by OpenAPI 3.x and Swagger 2.0 documents.

    Type Declaration

    • Readonlycomponents: {
          schemas: "#/components/schemas/";
          parameters: "#/components/parameters/";
          responses: "#/components/responses/";
          requestBodies: "#/components/requestBodies/";
          headers: "#/components/headers/";
          examples: "#/components/examples/";
          links: "#/components/links/";
          callbacks: "#/components/callbacks/";
          securitySchemes: "#/components/securitySchemes/";
          pathItems: "#/components/pathItems/";
      }

      OpenAPI 3.x — most schemas live under components.schemas.

    • Readonlyswagger2: {
          definitions: "#/definitions/";
          parameters: "#/parameters/";
          responses: "#/responses/";
      }

      Swagger 2.0 legacy prefixes.

    Settings

    Member Visibility