@redocly/openapi-core 1.0.0 → 1.0.1

package/src/__tests__/fixtures/refs/openapi-with-external-refs.yaml

@@ -0,0 +1,33 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: '#/components/parameters/param-a'
+        - $ref: ./param-b.yaml
+        - name: test
+    get:
+      parameters:
+        - $ref: '#/components/parameters/param-a'
+        - $ref: ./param-c.yaml
+    post:
+      parameters:
+        - $ref: '#/paths/~1pet/put/parameters/2'
+components:
+  parameters:
+    param-a:
+      name: param_a
+      schema:
+        $ref: ./schema-a.yaml
+      examples:
+        first:
+          $ref: ./examples.yaml#/param-a/first
+        second:
+          $ref: ./examples.yaml#/param-a/second
+    path-param:
+      name: path_param
+      examples:
+        first:
+          $ref: ./examples.yaml#/path-param/first

package/src/__tests__/fixtures/refs/openapi-with-url-refs.yaml

@@ -0,0 +1,18 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    parameters:
+      - $ref: '#/components/parameters/path-param'
+    put:
+      parameters:
+        - $ref: 'https://someexternal.schema'
+        - $ref: ./param-b.yaml
+        - name: test
+    get:
+      parameters:
+        - $ref: 'http://someexternal.schema'
+        - $ref: ./param-c.yaml
+components:
+  parameters:
+    path-param:
+      name: path_param

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

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

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

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

package/src/__tests__/fixtures/refs/rename.yaml

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

package/src/__tests__/fixtures/refs/requestBody.yaml

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

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

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

package/src/__tests__/fixtures/refs/simple.yaml

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

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

@@ -0,0 +1,20 @@
+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/src/__tests__/fixtures/resolve/External.yaml

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

package/src/__tests__/fixtures/resolve/External2.yaml

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

package/src/__tests__/fixtures/resolve/description.md

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

package/src/__tests__/fixtures/resolve/externalInfo.yaml

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

package/src/__tests__/fixtures/resolve/externalLicense.yaml

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

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

@@ -0,0 +1,13 @@
+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/src/__tests__/fixtures/resolve/openapi-with-md-description.yaml

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

package/src/__tests__/fixtures/resolve/openapi.yaml

@@ -0,0 +1,28 @@
+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/src/__tests__/fixtures/resolve/schemas/type-a.yaml

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

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

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

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

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

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

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

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

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

package/src/__tests__/format.test.ts

@@ -0,0 +1,76 @@
+import { outdent } from 'outdent';
+
+import { formatProblems, getTotals } from '../format/format';
+
+describe('format', () => {
+  function replaceColors(log: string) {
+    return log
+      .replace(/\x1b\[33m(.*?)\x1b\[39m/g, '<o>$1</o>') // orange
+      .replace(/\x1b\[31m(.*?)\x1b\[39m/g, '<r>$1</r>'); // red
+  }
+
+  const problems = [
+    {
+      ruleId: 'spec',
+      location: [],
+      severity: 'error' as const,
+      message: 'message',
+      suggest: [],
+    },
+    {
+      ruleId: 'spec',
+      location: [],
+      severity: 'error' as const,
+      message: 'message 2',
+      suggest: [],
+    },
+    {
+      ruleId: 'other-rule',
+      location: [],
+      severity: 'warn' as const,
+      message: 'message',
+      suggest: [],
+    },
+  ];
+
+  let output = '';
+  beforeEach(() => {
+    output = '';
+    jest.spyOn(process.stderr, 'write').mockImplementation((str: string | Uint8Array) => {
+      output += str;
+      return true;
+    });
+  });
+
+  it('should correctly format summary output', () => {
+    formatProblems(problems, {
+      format: 'summary',
+      version: '1.0.0',
+      totals: getTotals(problems),
+      color: false,
+    });
+
+    expect(output).toMatchInlineSnapshot(`
+      "error   spec: 2
+      warning other-rule: 1
+
+      "
+    `);
+  });
+
+  it('should correctly format summary output in color mode', () => {
+    formatProblems(problems, {
+      format: 'summary',
+      version: '1.0.0',
+      totals: getTotals(problems),
+      color: true,
+    });
+
+    expect(replaceColors(output)).toMatchInlineSnapshot(`
+      "<r>error  </r> spec: 2
+      <o>warning</o> other-rule: 1
+
+      "
+    `);
+  });
+});

package/src/__tests__/js-yaml.test.ts

@@ -0,0 +1,73 @@
+import { outdent } from 'outdent';
+import { parseYaml, stringifyYaml } from '../js-yaml';
+
+const yaml = `
+  emptyValue:
+  spaces in keys: spaces in keys
+  numberString: '0123456789'
+  number: 1000
+  decimal: 12.34
+  boolean: true
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  array:
+    - 1
+    - 2
+  object:
+    key1: 1
+    key2: 2
+`;
+
+const yamlToDump = outdent`
+  date: '2022-01-21T11:29:56.694Z'
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  dateImplicit: !!str 2020-01-01
+  string: test
+  stringWithQuotes: 'test'
+  stringWithDoubleQuotes: "test"
+`;
+
+const jsObject = {
+  emptyValue: null,
+  'spaces in keys': 'spaces in keys',
+  numberString: '0123456789',
+  number: 1000,
+  decimal: 12.34,
+  boolean: true,
+  dateWithoutQuotes: '2020-01-01',
+  dateWithQuotes: '2020-01-01',
+  array: [1, 2],
+  object: { key1: 1, key2: 2 },
+};
+
+describe('js-yaml', () => {
+  test('parseYaml', () => {
+    expect(parseYaml(yaml)).toEqual(jsObject);
+  });
+
+  test('should correctly dump date and string', () => {
+    expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
+      `
+    "date: '2022-01-21T11:29:56.694Z'
+    dateWithoutQuotes: '2020-01-01'
+    dateWithQuotes: '2020-01-01'
+    dateImplicit: '2020-01-01'
+    string: test
+    stringWithQuotes: test
+    stringWithDoubleQuotes: test
+    "
+    `
+    );
+  });
+
+  test('parse and stringify', () => {
+    expect(parseYaml(stringifyYaml(jsObject))).toEqual(jsObject);
+  });
+
+  test('should throw an error for unsupported types', () => {
+    expect(() => stringifyYaml({ foo: () => {} })).toThrow(
+      'unacceptable kind of an object to dump [object Function]'
+    );
+  });
+});