@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

package/__tests__/fixtures/refs/param-b.yaml

@@ -1 +0,0 @@
-name: param_b

package/__tests__/fixtures/refs/param-c.yaml

@@ -1 +0,0 @@
-name: param_c

package/__tests__/fixtures/refs/rename.yaml

@@ -1 +0,0 @@
-type: number

package/__tests__/fixtures/refs/requestBody.yaml

@@ -1,9 +0,0 @@
-content: 
-  application/json: 
-    schema: 
-      type: object
-      properties: 
-        a:
-          type: string
-        b:
-          type: number

package/__tests__/fixtures/refs/schema-a.yaml

@@ -1 +0,0 @@
-type: string

package/__tests__/fixtures/refs/simple.yaml

@@ -1 +0,0 @@
-type: string

package/__tests__/fixtures/refs/vendor.schema.yaml

@@ -1,20 +0,0 @@
-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

package/__tests__/fixtures/resolve/External.yaml

@@ -1,10 +0,0 @@
-type: object
-properties:
-  string:
-    type: string
-  number:
-    type: number
-  external:
-    $ref: ./External2.yaml
-  unknown:
-    type: string

package/__tests__/fixtures/resolve/External2.yaml

@@ -1,4 +0,0 @@
-type: object
-properties:
-  circularParent:
-    $ref: ./External.yaml#/properties

package/__tests__/fixtures/resolve/description.md

@@ -1,3 +0,0 @@
-# Hello World
-
-Lorem ipsum

package/__tests__/fixtures/resolve/externalInfo.yaml

@@ -1,4 +0,0 @@
-info:
-  contact: {}
-  license:
-    $ref: ./externalLicense.yaml

package/__tests__/fixtures/resolve/externalLicense.yaml

@@ -1 +0,0 @@
-name: MIT

package/__tests__/fixtures/resolve/openapi-with-back.yaml

@@ -1,13 +0,0 @@
-openapi: "3.0.1"
-info:
-  title: Open API
-  description: Open API
-  version: v0
-  contact:
-    email: some@body.com
-components:
-  schemas:
-    TypeA:
-      $ref: ./schemas/type-a.yaml#/
-    TypeB:
-      $ref: ./schemas/type-b.yaml#/

package/__tests__/fixtures/resolve/openapi-with-md-description.yaml

@@ -1,5 +0,0 @@
-openapi: 3.0.0
-info:
-  description:
-    $ref: ./description.md
-paths: {}

package/__tests__/fixtures/resolve/openapi.yaml

@@ -1,28 +0,0 @@
-openapi: 3.0.0
-paths:
-  /pet:
-    put:
-      requestBody:
-        content:
-          application/json:
-            schema:
-              type: object
-              properties:
-                local:
-                  $ref: '#/components/schemas/Local'
-                localTransitive:
-                  $ref: '#/components/schemas/Local/properties/string'
-                externalWithPointer:
-                  $ref: ./External.yaml#/properties/string
-                external:
-                  $ref: ./External.yaml
-components:
-  schemas:
-    Local:
-      properties:
-        number:
-          type: number
-        string:
-          type: string
-        localCircular:
-          $ref: '#/components/schemas/Local'

package/__tests__/fixtures/resolve/schemas/type-a.yaml

@@ -1,10 +0,0 @@
-allOf:
-  - type: object
-    required:
-      - name
-      - integration_type
-    properties:
-      integration_type:
-        $ref: "../openapi-with-back.yaml#/components/schemas/TypeB"
-      name:
-        type: string

package/__tests__/fixtures/resolve/schemas/type-b.yaml

@@ -1,6 +0,0 @@
-type: string
-enum:
-  - webhook
-  - api_key
-  - sftp
-  - netsuite

package/__tests__/fixtures/resolve/transitive/a.yaml

@@ -1 +0,0 @@
-type: string

package/__tests__/fixtures/resolve/transitive/components.yaml

@@ -1,5 +0,0 @@
-components:
-  schemas:
-    $ref: ./schemas.yaml#/schemas
-  shouldNotCrash:
-    $ref: ./schemas.yaml#invalid-hash-fragment

package/__tests__/fixtures/resolve/transitive/schemas.yaml

@@ -1,3 +0,0 @@
-schemas:
-  a:
-    $ref: a.yaml

package/__tests__/lint.test.ts

@@ -1,17 +0,0 @@
-import outdent from 'outdent';
-import { detectOpenAPI } from '../src/oas-types';
-import { parseYamlToDocument } from './utils';
-
-describe('lint', () => {
-	it('detect OpenAPI should throw an error when version is not string', () => {
-
-	const testDocument = parseYamlToDocument(
-      outdent`
-        openapi: 3.0
-      `,
-      '',
-    );
-		expect(() => detectOpenAPI(testDocument.parsed))
-			.toThrow(`Invalid OpenAPI version: should be a string but got "number"`)
-	});
-});

package/__tests__/login.test.ts

@@ -1,17 +0,0 @@
-import { RedoclyClient } from '../src/redocly';
-
-describe.skip('login', () => {
-  it('should call login with setAccessTokens function', async () => {
-    const client = new RedoclyClient();
-    Object.defineProperty(client, 'registryApi', {
-      value: {
-        setAccessTokens: jest.fn(),
-        authStatus: jest.fn(() => true)
-      },
-      writable: true,
-      configurable: true
-    });
-    await client.login('token'); // TODO: bug with rewrite local config file
-    expect(client.registryApi.setAccessTokens).toHaveBeenCalled();
-  });
-});

package/__tests__/normalizeVisitors.test.ts

@@ -1,151 +0,0 @@
-import { normalizeVisitors, VisitorLevelContext } from '../src/visitors';
-import { Oas3RuleSet } from '../src/oas-types';
-import { Oas3Types } from '../src/types/oas3';
-import { normalizeTypes } from '../src/types';
-
-describe('Normalize visitors', () => {
-  it('should work correctly for single rule', () => {
-    const schemaEnter = () => undefined;
-
-    const ruleset: Oas3RuleSet[] = [
-      {
-        test: () => {
-          return {
-            Schema: schemaEnter,
-          };
-        },
-      },
-    ];
-
-    const visitors = ruleset.flatMap((ruleset) =>
-      Object.keys(ruleset).map((ruleId) => ({
-        ruleId,
-        severity: 'error' as 'error',
-        visitor: ruleset[ruleId]({}),
-      })),
-    );
-
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
-    expect(normalized).toBeDefined();
-    expect(normalized.Schema.enter).toHaveLength(1);
-    expect(normalized.Schema.enter[0].visit).toEqual(schemaEnter);
-    expect(normalized.Schema.enter[0].context.parent).toEqual(null);
-    const { type, ...contextWithoutType } = normalized.Schema.enter[0]
-      .context as VisitorLevelContext;
-
-    expect(contextWithoutType).toEqual({
-      activatedOn: null,
-      parent: null,
-      isSkippedLevel: false,
-    });
-
-    expect(type.name).toEqual('Schema');
-  });
-
-  it('should work for nested rule', () => {
-    const infoEnter = () => undefined;
-    const infoLeave = () => undefined;
-    const contactEnter = () => undefined;
-
-    const ruleset: Oas3RuleSet[] = [
-      {
-        test: () => {
-          return {
-            Info: {
-              enter: infoEnter,
-              leave: infoLeave,
-              Contact: contactEnter,
-            },
-          };
-        },
-      },
-    ];
-
-    const visitors = ruleset.flatMap((ruleset) =>
-      Object.keys(ruleset).map((ruleId) => ({
-        ruleId,
-        severity: 'error' as 'error',
-        visitor: ruleset[ruleId]({}),
-      })),
-    );
-
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
-    expect(normalized).toBeDefined();
-    expect(normalized.Info.enter).toHaveLength(1);
-
-    expect(normalized.Info.enter[0].context).toStrictEqual(normalized.Info.leave[0].context);
-
-    expect(normalized.Info.enter[0].visit).toEqual(infoEnter);
-    expect(normalized.Contact.enter[0].visit).toEqual(contactEnter);
-
-    expect(normalized.Contact.enter[0].context.parent).toEqual(normalized.Info.enter[0].context);
-
-    expect(normalized.Info.leave).toHaveLength(1);
-    expect(normalized.Info.leave[0].visit).toEqual(infoLeave);
-  });
-
-  it('should normalize with weak intermittent types', () => {
-    const contactEnter = () => undefined;
-
-    const ruleset: Oas3RuleSet[] = [
-      {
-        test: () => {
-          return {
-            PathItem: {
-              Parameter: contactEnter,
-            },
-          };
-        },
-      },
-    ];
-
-    const visitors = ruleset.flatMap((ruleset) =>
-      Object.keys(ruleset).map((ruleId) => ({
-        ruleId,
-        severity: 'error' as 'error',
-        visitor: ruleset[ruleId]({}),
-      })),
-    );
-
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
-    expect(normalized).toBeDefined();
-    expect(normalized.PathItem.enter).toHaveLength(1);
-    expect(normalized.Operation.enter).toHaveLength(1);
-    expect(normalized.Parameter.enter).toHaveLength(1);
-    expect(normalized.ParameterList.enter).toHaveLength(2);
-  });
-
-  it('should order deeper visitors first', () => {
-    const pathParam = () => undefined;
-    const operationParam = () => undefined;
-
-    const ruleset: Oas3RuleSet[] = [
-      {
-        test: () => {
-          return {
-            PathItem: {
-              Parameter: pathParam,
-              Operation: {
-                Parameter: operationParam,
-              },
-            },
-          };
-        },
-      },
-    ];
-
-    const visitors = ruleset.flatMap((ruleset) =>
-      Object.keys(ruleset).map((ruleId) => ({
-        ruleId,
-        severity: 'error' as 'error',
-        visitor: ruleset[ruleId]({}),
-      })),
-    );
-
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
-    expect(normalized).toBeDefined();
-    expect(normalized.Parameter.enter).toHaveLength(2);
-    expect(normalized.Parameter.enter[0].visit).toStrictEqual(operationParam);
-    expect(normalized.Parameter.enter[1].visit).toStrictEqual(pathParam);
-  });
-});

package/__tests__/ref-utils.test.ts

@@ -1,120 +0,0 @@
-import outdent from 'outdent';
-import { parseYamlToDocument } from './utils';
-import { parseRef, refBaseName } from '../src/ref-utils';
-import { lintDocument } from '../src/lint';
-import { LintConfig } from '../src/config';
-import { BaseResolver } from '../src/resolve';
-
-describe('ref-utils', () => {
-  it(`should unescape refs with '/'`, () => {
-    const reference = 'somefile.yaml#/components/schemas/scope~1domain-schema';
-    expect(parseRef(reference)).toMatchInlineSnapshot(`
-      Object {
-        "pointer": Array [
-          "components",
-          "schemas",
-          "scope/domain-schema",
-        ],
-        "uri": "somefile.yaml",
-      }
-    `);
-  });
-
-  it(`should unescape refs with '~'`, () => {
-    const reference = 'somefile.yaml#/components/schemas/complex~0name';
-    expect(parseRef(reference)).toMatchInlineSnapshot(`
-      Object {
-        "pointer": Array [
-          "components",
-          "schemas",
-          "complex~name",
-        ],
-        "uri": "somefile.yaml",
-      }
-    `);
-  });
-
-  it(`should unescape complex urlencoded paths`, () => {
-    const referene = 'somefile.yaml#/components/schemas/scope%2Fcomplex~name';
-    expect(parseRef(referene)).toMatchInlineSnapshot(`
-      Object {
-        "pointer": Array [
-          "components",
-          "schemas",
-          "scope/complex~name",
-        ],
-        "uri": "somefile.yaml",
-      }
-    `);
-  });
-
-  it(`should validate definition with urlencoded paths`, async () => {
-    const document = parseYamlToDocument(
-      outdent` 
-        openapi: "3.0.0"
-        info:
-          version: 1.0.0
-          title: Swagger Petstore
-          description: Test definition
-          license:
-            name: MIT
-            url: https://opensource.org/licenses/MIT
-        servers:
-          - url: http://petstore.swagger.io/v1
-        paths:
-          /pet:
-            get:
-              summary: List all pets
-              operationId: listPets
-              responses:
-                '200':
-                  description: A paged array of pets
-                  content:
-                    application/json:
-                      schema:
-                        $ref: "#/components/schemas/scope%3A%7Banimals~1Pet%7D"
-        components:
-          schemas:
-            scope:{animals/Pet}:
-              type: object
-              properties:
-                id:
-                  type: integer
-                  format: int64
-                name:
-                  type: string
-      `,
-      '',
-    );
-
-    const result = await lintDocument({
-      document,
-      externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
-    });
-
-    expect(result).toMatchInlineSnapshot(`Array []`);
-  });
-
-  describe('refBaseName', () => {
-    it("returns base name for file reference", () => {
-      expect(refBaseName("../testcase/Pet.yaml")).toStrictEqual("Pet");
-    });
-
-    it("returns base name for local file reference", () => {
-      expect(refBaseName("Cat.json")).toStrictEqual("Cat");
-    });
-
-    it("returns base name for url reference", () => {
-      expect(refBaseName("http://example.com/tests/crocodile.json")).toStrictEqual("crocodile");
-    });
-
-    it("returns base name for file with multiple dots in name", () => {
-      expect(refBaseName("feline.tiger.v1.yaml")).toStrictEqual("feline.tiger.v1");
-    });
-
-    it("returns base name for file without any dots in name", () => {
-      expect(refBaseName("abcdefg")).toStrictEqual("abcdefg");
-    });
-  });
-});

package/__tests__/resolve-http.test.ts

@@ -1,77 +0,0 @@
-import { outdent } from 'outdent';
-
-import { resolveDocument, BaseResolver } from '../src/resolve';
-import { parseYamlToDocument } from './utils';
-import { Oas3Types } from '../src/types/oas3';
-import { normalizeTypes } from '../src/types';
-
-describe('Resolve http-headers', () => {
-  it('should use matching http-headers', async () => {
-    const rootDocument = parseYamlToDocument(
-      outdent`
-        openapi: 3.0.0
-        components:
-          schemas:
-            A:
-              $ref: 'https://example.com/test.yaml'
-            B:
-              $ref: 'https://sample.com/test.yaml'
-            C:
-              $ref: 'https://sample.com/test/a/test.yaml'
-      `,
-      'foobar.yaml',
-    );
-
-    const fetchMock = jest.fn(() => Promise.resolve({ ok: true, text: Promise.resolve('') }));
-
-    await resolveDocument({
-      rootDocument,
-      externalRefResolver: new BaseResolver({
-        http: {
-          customFetch: fetchMock,
-          headers: [
-            {
-              name: 'X_TEST',
-              matches: 'example.com/*',
-              value: '123',
-            },
-            {
-              name: 'X_TEST',
-              matches: 'https://sample.com/test/**',
-              value: '321',
-            },
-          ],
-        },
-      }),
-      rootType: normalizeTypes(Oas3Types).DefinitionRoot,
-    });
-
-    expect(fetchMock).toBeCalledTimes(3);
-    expect(fetchMock.mock.calls).toMatchInlineSnapshot(`
-      Array [
-        Array [
-          "https://example.com/test.yaml",
-          Object {
-            "headers": Object {
-              "X_TEST": "123",
-            },
-          },
-        ],
-        Array [
-          "https://sample.com/test.yaml",
-          Object {
-            "headers": Object {},
-          },
-        ],
-        Array [
-          "https://sample.com/test/a/test.yaml",
-          Object {
-            "headers": Object {
-              "X_TEST": "321",
-            },
-          },
-        ],
-      ]
-    `);
-  });
-});