pyramid_openapi3 icon indicating copy to clipboard operation
pyramid_openapi3 copied to clipboard

Need help with using $refs

Open 123survesh opened this issue 2 years ago • 1 comments

My current directory structure:

| spec
      | main.yaml
      | template.yaml
      | organisation
          | organisation.yaml

I am trying to import a schema written in template.yaml to organisation.yaml. organisation.yaml contains operations for a path and it will again be added via refs to main.yaml to a path.

I am facing an issue when trying to reference a schema template.yaml in organisation.yaml.

organisation.yaml

get:
    summary: Fetch an organisation's data
    responses:
      "200":
        description: ok
        content:
          application/json:
            schema:
              type: object
              properties:
                gkstatus:
                  $ref: "../template.yaml#/components/schemas/gkstatus"
  1. When I try ../template.yaml, it searches in the parent directory of spec
  2. When I try ../spec/template.yaml, it searches in /spec/spec/template.yaml
  3. I got it working by having a copy of template.yaml inside the organisation folder and one inside the spec folder near the main.yaml file

I am confused, can some one help me out?

123survesh avatar Dec 09 '22 17:12 123survesh

I've never personally used multiple yaml files, so can't help you with this one, sorry :(

That said, I'm very interested in having a working example of this included in https://github.com/Pylons/pyramid_openapi3/tree/main/examples, could you submit a Pull Request to add it once you've figured it out?

zupo avatar Dec 09 '22 22:12 zupo