Add files support to $ref

[roman-savitski]

Not sure whether this is not working or I'm doing something wrong. But if my $ref points to another file - result interfaces generated incorrectly.

Example:
api.yaml

openapi: 3.0.0
info:
  title: Test
  version: '1.0'
paths:
  '/my-api':
    get:
      responses:
        '200':
          description: Test command
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyModel'
components:
  schemas:
    MyModel:
      $ref: ./api-model.yaml

api-model.yaml

title: My Model
type: object
properties:
  myModelProperty:
    type: string

I run openapi --input api.yaml --output ./dist

As result I'm getting ./dist/models/MyModel.ts

import type { api_model_yaml } from './api_model_yaml';

export type MyModel = api_model_yaml;

There is no api_model_yaml obviously. So idea of keeping models in separate files - failed. Could you please suggest me solution of this problem?

[ferdikoomen]

@raman-savitski there was already a question / PR with the same: #433 In that PR i mentioned that I'm working on some core rewrites, the resolving / bundeling logic is indeed nice to add. I am creating a page now with some goals for the next release

[cima]

I am affraid that not only different file references are not correctly working. Suppose below YAML

{
  "swagger": "2.0",
    "version": "6.1-preview"
  },
  "host": "dev.azure.com",
  "x-ms-vss-area": "TestPlan",
  "basePath": "/",
  "schemes": [
    "https"
  ],
  "paths": {
    "/{organization}/{project}/_apis/testplan/Plans/{planId}/suites": {
      "post": {
        "tags": [
          "Test  Suites"
        ],
        "x-ms-docs-override-version": "6.1-preview.1",
        "x-ms-vss-resource": "suites",
        "x-ms-vss-method": "CreateTestSuite",
        "x-ms-preview": true,
        "description": "Create test suite.",
        "operationId": "Test  Suites_Create",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "organization",
            "description": "The name of the Azure DevOps organization.",
            "required": true,
            "type": "string"
          },
          {
            "in": "body",
            "name": "body",
            "description": "Parameters for suite creation",
            "required": true,
            "schema": {
              "$ref": "#/definitions/TestSuiteCreateParams"
            }
          },
          {
            "in": "path",
            "name": "project",
            "description": "Project ID or project name",
            "required": true,
            "type": "string"
          },
          {
            "in": "path",
            "name": "planId",
            "description": "ID of the test plan that contains the suites.",
            "required": true,
            "type": "integer",
            "format": "int32"
          },
          {
            "$ref": "#/parameters/api-Version-preview.1"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "#/definitions/TestSuite"
            }
          }
        },
        "security": [
          {
            "oauth2": [
              "vso.test_write"
            ]
          }
        ],
        "x-ms-examples": {
          "Create a test suite.": {
            "$ref": "./httpExamples/Suites/CreateTestSuite.json"
          }
        }
      }
  },
  "parameters": {
    "api-Version-preview.1": {
      "name": "api-version",
      "in": "query",
      "description": "Version of the API to use.  This should be set to '6.1-preview.1' to use this version of the api.",
      "required": true,
      "type": "string"
    }
  }
}

(Whole json file can be found at: testPlan.json)
the reference "$ref": "#/parameters/api-Version-preview.1" suppose to create query parameter but actually there is none and azure complains about the version not being sent within the request. See below screenshots.

resulting error message 'No api-version was supplied for the "POST" request. The version must be supplied either as part of the Accept header (e.g. "application/json; api-version=1.0") or as a query parameter (e.g. "?api-version=1.0").'

Reagrdles of the particular Azure usage the main point is that resulting code lacks the part specified by reference:

    public static async testSuitesCreate(
organization: string,
body: TestSuiteCreateParams,
project: string,
planId: number,
): Promise<TestSuite> {
        const result = await __request({
            method: 'POST',
            path: `/${organization}/${project}/_apis/testplan/Plans/${planId}/suites`,
            body: body,
        });
        return result.body;
    }

[ferdikoomen]

@cima i just pushed 0.11.5 with support for this scenario. This only works when you generate the spec from the url:

$ openapi --input https://raw.githubusercontent.com/MicrosoftDocs/vsts-rest-api-specs/master/specification/testPlan/6.1/testPlan.json --out ./generated