@redocly/openapi-core 1.0.0-beta.126 → 1.0.0-beta.127

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -1,437 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`bundle should add to meta ref from redocly registry 1`] = `
-fileDependencies: {}
-rootType:
-  properties:
-    openapi: null
-    info:
-      properties:
-        title:
-          type: string
-        version:
-          type: string
-        description:
-          type: string
-        termsOfService:
-          type: string
-        contact:
-          properties:
-            name:
-              type: string
-            url:
-              type: string
-            email:
-              type: string
-          extensionsPrefix: x-
-          name: Contact
-        license:
-          properties:
-            name:
-              type: string
-            url:
-              type: string
-          required:
-            - name
-          extensionsPrefix: x-
-          name: License
-        x-logo:
-          properties:
-            url:
-              type: string
-            altText:
-              type: string
-            backgroundColor:
-              type: string
-            href:
-              type: string
-          name: Logo
-      required:
-        - title
-        - version
-      extensionsPrefix: x-
-      name: Info
-    servers:
-      name: ServerList
-      properties: {}
-      items:
-        properties:
-          url:
-            type: string
-          description:
-            type: string
-          variables:
-            name: ServerVariablesMap
-            properties: {}
-        required:
-          - url
-        extensionsPrefix: x-
-        name: Server
-    security:
-      name: SecurityRequirementList
-      properties: {}
-      items:
-        properties: {}
-        additionalProperties:
-          type: array
-          items:
-            type: string
-        name: SecurityRequirement
-    tags:
-      name: TagList
-      properties: {}
-      items:
-        properties:
-          name:
-            type: string
-          description:
-            type: string
-          externalDocs:
-            properties:
-              description:
-                type: string
-              url:
-                type: string
-            required:
-              - url
-            extensionsPrefix: x-
-            name: ExternalDocs
-          x-traitTag:
-            type: boolean
-          x-displayName:
-            type: string
-        required:
-          - name
-        extensionsPrefix: x-
-        name: Tag
-    externalDocs:
-      properties:
-        description:
-          type: string
-        url:
-          type: string
-      required:
-        - url
-      extensionsPrefix: x-
-      name: ExternalDocs
-    paths:
-      properties: {}
-      name: Paths
-    components:
-      properties:
-        parameters:
-          name: NamedParameters
-          properties: {}
-        schemas:
-          name: NamedSchemas
-          properties: {}
-        responses:
-          name: NamedResponses
-          properties: {}
-        examples:
-          name: NamedExamples
-          properties: {}
-        requestBodies:
-          name: NamedRequestBodies
-          properties: {}
-        headers:
-          name: NamedHeaders
-          properties: {}
-        securitySchemes:
-          name: NamedSecuritySchemes
-          properties: {}
-        links:
-          name: NamedLinks
-          properties: {}
-        callbacks:
-          name: NamedCallbacks
-          properties: {}
-      extensionsPrefix: x-
-      name: Components
-    x-webhooks:
-      properties: {}
-      name: WebhooksMap
-    x-tagGroups:
-      name: TagGroups
-      properties: {}
-      items:
-        properties:
-          name:
-            type: string
-          tags:
-            type: array
-            items:
-              type: string
-        extensionsPrefix: x-
-        name: TagGroup
-    x-ignoredHeaderParameters:
-      type: array
-      items:
-        type: string
-  required:
-    - openapi
-    - paths
-    - info
-  extensionsPrefix: x-
-  name: Root
-refTypes: {}
-visitorsData:
-  registry-dependencies:
-    links:
-      - https://api.redocly.com/registry/params
-
-`;
-
-exports[`bundle should bundle external refs 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-b'
-        - name: test
-    get:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-c'
-    post:
-      parameters:
-        - $ref: '#/paths/~1pet/put/parameters/2'
-components:
-  parameters:
-    param-a:
-      name: param_a
-      schema:
-        $ref: '#/components/schemas/schema-a'
-      examples:
-        first:
-          $ref: '#/components/examples/param-a-first'
-        second:
-          $ref: '#/components/examples/second'
-    path-param:
-      name: path_param
-      examples:
-        first:
-          $ref: '#/components/examples/first'
-    param-c:
-      name: param_c
-    param-b:
-      name: param_b
-  examples:
-    first:
-      value: b1
-    param-a-first:
-      value: a1
-    second:
-      value: a2
-  schemas:
-    schema-a:
-      type: string
-
-`;
-
-exports[`bundle should bundle external refs and warn for conflicting names 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: '#/components/parameters/param-b'
-        - $ref: '#/components/parameters/param-b-2'
-    get:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-c'
-components:
-  parameters:
-    param-a:
-      name: test
-    param-b:
-      name: param_b_alt
-    path-param:
-      name: path_param
-    param-c:
-      name: param_c
-    param-b-2:
-      name: param_b
-
-`;
-
-exports[`bundle should dereferenced correctly when used with dereference 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    get:
-      operationId: get
-      parameters:
-        - name: shared-a
-        - name: get_b
-    post:
-      operationId: post
-      parameters:
-        - name: shared-a
-components:
-  parameters:
-    shared_a:
-      name: shared-a
-
-`;
-
-exports[`bundle should not bundle url refs if used with keepUrlRefs 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: https://someexternal.schema
-        - $ref: '#/components/parameters/param-b'
-        - name: test
-    get:
-      parameters:
-        - $ref: http://someexternal.schema
-        - $ref: '#/components/parameters/param-c'
-components:
-  parameters:
-    path-param:
-      name: path_param
-    param-c:
-      name: param_c
-    param-b:
-      name: param_b
-
-`;
-
-exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    post:
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/requestBody'
-components:
-  schemas:
-    requestBody:
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              a:
-                type: string
-              b:
-                type: number
-
-`;
-
-exports[`bundle should place referenced schema inline when referenced schema name resolves to original schema name 1`] = `
-openapi: 3.1.0
-info:
-  title: My API
-  description: It ain't so wonderful, but at least it's mine.
-  version: '1.0'
-  contact:
-    email: me@theintenet.com
-    name: me
-paths:
-  /test:
-    get:
-      summary: test
-      responses:
-        '200':
-          description: test
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/vendor.schema'
-components:
-  schemas:
-    vendor:
-      $ref: '#/components/schemas/vendor.schema'
-    myvendor:
-      $ref: '#/components/schemas/vendor.schema'
-    simple:
-      type: string
-    A:
-      type: string
-    test:
-      $ref: '#/components/schemas/rename-2'
-    rename:
-      type: string
-    rename-2:
-      type: number
-    vendor.schema:
-      title: vendor
-      type: object
-      description: Vendors
-      properties:
-        key:
-          type: string
-          description: System-assigned key for the vendor.
-          readOnly: true
-        id:
-          type: string
-          description: >
-            Unique identifier of the vendor.
-
-            You must specify a unique vendor ID when creating a vendor unless
-            document sequencing is configured, in which case the ID is
-            auto-generated.
-        name:
-          type: string
-          description: Name of the vendor.
-        isOneTimeUse:
-          type: boolean
-          description: One-time use
-          default: false
-
-`;
-
-exports[`bundle should pull hosted schema 1`] = `
-openapi: 3.0.3
-info:
-  title: bugtest
-  version: '1.0'
-  description: Demo
-  license:
-    name: DEMO
-    url: https://demo.com
-servers:
-  - url: http://demo.com/api
-paths:
-  /customer:
-    summary: Customer scope
-    get:
-      summary: Get demo no refs
-      operationId: GetCustomer
-      description: Returns Demo No Refs
-      responses:
-        '200':
-          description: Demo No Refs
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Customer'
-components:
-  schemas:
-    Customer:
-      type: object
-      properties:
-        customerName:
-          type: string
-        accounts:
-          type: array
-          items:
-            $ref: '#/components/schemas/someexternal'
-    someexternal: External schema content
-
-`;

package/src/__tests__/bundle.test.ts

@@ -1,236 +0,0 @@
-import outdent from 'outdent';
-import * as path from 'path';
-
-import { bundleDocument, bundle } from '../bundle';
-import { parseYamlToDocument, yamlSerializer, makeConfig } from '../../__tests__/utils';
-import { StyleguideConfig, Config, ResolvedConfig } from '../config';
-import { BaseResolver } from '../resolve';
-
-describe('bundle', () => {
-  const fetchMock = jest.fn(() =>
-    Promise.resolve({
-      ok: true,
-      text: () => 'External schema content',
-      headers: {
-        get: () => '',
-      },
-    })
-  );
-
-  expect.addSnapshotSerializer(yamlSerializer);
-
-  const testDocument = parseYamlToDocument(
-    outdent`
-      openapi: 3.0.0
-      paths:
-        /pet:
-          get:
-            operationId: get
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-              - name: get_b
-          post:
-            operationId: post
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-      components:
-        parameters:
-          shared_a:
-            name: shared-a
-    `,
-    ''
-  );
-
-  it('change nothing with only internal refs', async () => {
-    const { bundle, problems } = await bundleDocument({
-      document: testDocument,
-      externalRefResolver: new BaseResolver(),
-      config: new StyleguideConfig({}),
-    });
-
-    const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
-
-    expect(problems).toHaveLength(0);
-    expect(bundle.parsed).toEqual(origCopy);
-  });
-
-  it('should bundle external refs', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/openapi-with-external-refs.yaml'),
-    });
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should bundle external refs and warn for conflicting names', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/openapi-with-external-refs-conflicting-names.yaml'),
-    });
-    expect(problems).toHaveLength(1);
-    expect(problems[0].message).toEqual(
-      `Two schemas are referenced with the same name but different content. Renamed param-b to param-b-2.`
-    );
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should dereferenced correctly when used with dereference', async () => {
-    const { bundle: res, problems } = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      config: new StyleguideConfig({}),
-      document: testDocument,
-      dereference: true,
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should place referenced schema inline when referenced schema name resolves to original schema name', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/externalref.yaml'),
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should pull hosted schema', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      externalRefResolver: new BaseResolver({
-        http: {
-          customFetch: fetchMock,
-          headers: [],
-        },
-      }),
-      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml'),
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(fetchMock).toHaveBeenCalledWith('https://someexternal.schema', {
-      headers: {},
-    });
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should not bundle url refs if used with keepUrlRefs', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      externalRefResolver: new BaseResolver({
-        http: {
-          customFetch: fetchMock,
-          headers: [],
-        },
-      }),
-      ref: path.join(__dirname, 'fixtures/refs/openapi-with-url-refs.yaml'),
-      keepUrlRefs: true,
-    });
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should add to meta ref from redocly registry', async () => {
-    const testDocument = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        paths:
-          /pet:
-            get:
-              operationId: get
-              parameters:
-                - $ref: '#/components/parameters/shared_a'
-                - name: get_b
-            post:
-              operationId: post
-              parameters:
-                - $ref: 'https://api.redocly.com/registry/params'
-        components:
-          parameters:
-            shared_a:
-              name: shared-a
-      `,
-      ''
-    );
-
-    const config = await makeConfig({}, { 'registry-dependencies': 'on' });
-
-    const {
-      bundle: result,
-      problems,
-      ...meta
-    } = await bundleDocument({
-      document: testDocument,
-      config: config,
-      externalRefResolver: new BaseResolver({
-        http: {
-          customFetch: fetchMock,
-          headers: [],
-        },
-      }),
-    });
-
-    const parsedMeta = JSON.parse(JSON.stringify(meta));
-
-    expect(problems).toHaveLength(0);
-    expect(parsedMeta).toMatchSnapshot();
-  });
-
-  it('should bundle refs using $anchors', async () => {
-    const testDocument = parseYamlToDocument(
-      outdent`
-        openapi: 3.1.0
-        components:
-          schemas:
-            User:
-              type: object
-              properties:
-                profile:
-                  $ref: '#user-profile'
-            UserProfile:
-              $anchor: user-profile
-              type: string
-      `,
-      ''
-    );
-
-    const config = await makeConfig({});
-
-    const {
-      bundle: { parsed },
-      problems,
-    } = await bundleDocument({
-      document: testDocument,
-      config: config,
-      externalRefResolver: new BaseResolver(),
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(parsed).toMatchInlineSnapshot(`
-      openapi: 3.1.0
-      components:
-        schemas:
-          User:
-            type: object
-            properties:
-              profile:
-                $ref: '#user-profile'
-          UserProfile:
-            $anchor: user-profile
-            type: string
-
-    `);
-  });
-});