fix: fix no-$ref-siblings error

[shenbenson]

Fixes the no-$ref-siblings error seen in this PR

Ticket: DX-1580

This is done by wrapping innerSchema $ref's in an allOf in the case that a ref is present and has siblings.

Result:

The following code:

import * as t from 'io-ts';
import * as h from '@api-ts/io-ts-http';
/**
 * A simple route with type descriptions for references
 *
 * @operationId api.v1.test
 * @tag Test Routes
 */
export const route = h.httpRoute({
  path: '/foo',
  method: 'GET',
  request: h.httpRequest({}),
  response: {
    200: SimpleRouteResponse
  },
 });


 /**
  * Human readable description of the Simple Route Response
  * @title Human Readable Simple Route Response
 */
const SimpleRouteResponse = t.type({
  /** List of test refs */
  test: t.array(TestRef)
});

const TestRefBase = t.string;

const TestRef = TestRefBase;

Now results in:

  {
    openapi: '3.0.3',
    info: {
      title: 'Test',
      version: '1.0.0',
    },
    paths: {
      '/foo': {
        get: {
          summary: 'A simple route with type descriptions for references',
          operationId: 'api.v1.test',
          tags: ['Test Routes'],
          parameters: [],
          responses: {
            '200': {
              description: 'OK',
              content: {
                'application/json': {
                  schema: {
                    $ref: '#/components/schemas/SimpleRouteResponse',
                  },
                },
              },
            },
          },
        },
      },
    },
    components: {
      schemas: {
        SimpleRouteResponse: {
          description: 'Human readable description of the Simple Route Response',
          properties: {
            test: {
              type: 'array',
              items: {
+              allOf: [{ $ref: '#/components/schemas/TestRefBase' }],
-              $ref: '#/components/schemas/TestRefBase',
                description: 'List of test refs',
              },
            },
          },
          required: ['test'],
          title: 'Human Readable Simple Route Response',
          type: 'object',
        },
        TestRefBase: {
          title: 'TestRefBase',
          type: 'string',
        },
        TestRef: {
          allOf: [
            {
              title: 'TestRef',
            },
            {
              $ref: '#/components/schemas/TestRefBase',
            },
          ],
        },
      },
    },
  }

[ericcrosson-bitgo]

Alley-oop'ing

Thanks @shenbenson and @starfy84!

[github-actions]

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version @api-ts/[email protected] 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀