OAS file fails to resolve schema $ref to external JSON file

[nehaghub]

Saving proxy in apigee fails with "bundle contains errors" when request-payload-schema.json is referenced via $ref from the main OAS YAML using a JSON pointer fragment.

Error: error unmarshaling JSON: while decoding JSON: failed to unmarshal property "components" (*openapi3.Components): failed to unmarshal property "schemas" (*openapi3.Schemas): failed to unmarshal extension properties: json: cannot unmarshal string into Go value of type map[string]jsontext.Value ("./request-payload-schema.json#/components/schemas/ServiceContractRequest")

Expected: OASValidation should resolve the $ref and validate successfully.
Actual: Proxy revision fails to save with bundle validation error.

[miqui]

@nehaghub - Did this ever work with apigee? For this type of inquiry you are missing a lot of baseline information that could help this call.

[karenetheridge]

This is the repository for the OpenAPI specification; we have no control over what tools do. Please open an issue with your tooling provider.

[nehaghub]

Thanks for your quick responses.
Sorry, if this question relates to only apigee. I am new to this.
Just want to ask in openApi specification is it possible to refer external schema?

[karenetheridge]

Yes, a $ref can be an absolute or relative URI in any location where $ref is permitted; if it is not absolute, it is resolved against the identifier for the main document. Example:

openapi: 3.2.0
info:
  title: Test API
  version: 1.2.3
$self: https://example.com/api
paths:
  /foo/{x}/{y}:
    parameters:
      - in: path
        name: x
        schema:
          $ref: '/definitions#/components/schemas/x_schema'
      - $ref: '/definitions#/components/parameters/y_parameter'

openapi: 3.2.0
info:
  title: Definitions for Test API
  version: 1.2.3
$self: https://example.com/definitions
components:
  schemas:
    x_schema:
      type: string
  parameters:
    y_parameter:
      in: path
      name: y
      schema:
        type: string

[nehaghub]

Thank you for this. This will help. Thanks all for your understanding and support.