Skip to content

Latest commit

 

History

History
156 lines (139 loc) · 3.3 KB

example3.rst

File metadata and controls

156 lines (139 loc) · 3.3 KB
Raw

# structure

tree
examples/nested
├── main.yaml
└── swagger-bundler.ini

0 directories, 2 files
swagger-bundler bundle main.yaml > generated.yaml

## swagger-bundler.ini(config file)

[DEFAULT]

[special_marker]
# todo: gentle description.
namespace = x-bundler-namespace
compose = x-bundler-compose
concat = x-bundler-concat
exposed = x-bundler-exposed

[postscript_hook]
# lambda ctx, data, *args, **kwargs: do_something()
## examples:
# swagger_bundler.postscript:echo
# or
# a/b/c/d.py:function_name
compose =
bundle = swagger_bundler.postscript:lifting_definition
add_namespace =
validate =

nested/main.yaml

definitions:
  X:
    type: string
  Foo:
    type: object
    properties:
      bar:
        type: object
        properties:
          booAbcXyz:
            type: object
            properties:
              yoo:
                type: object
                properties:
                  yah:
                    type: object
                    properties:
                      yay:
                        type: string
              x:
                $ref: '#/definitions/X'

  Boo:
    type: array
    items:
      type: object
      properties:
        foo:
          $ref: "#/definitions/Foo"
        user:
          properties:
            name:
              type: string
            age:
              type: number
        grouplist:
          type: array
          items:
            properties:
              name:
                type: string

## generated.yaml

definitions:
  X:
    type: string
  Foo:
    type: object
    properties:
      bar:
        $ref: '#/definitions/FooBar'
  FooBar:
    type: object
    properties:
      booAbcXyz:
        $ref: '#/definitions/FooBarBooAbcXyz'
    x-auto-generated: true
  FooBarBooAbcXyz:
    type: object
    properties:
      yoo:
        $ref: '#/definitions/FooBarBooAbcXyzYoo'
      x:
        $ref: '#/definitions/X'
    x-auto-generated: true
  FooBarBooAbcXyzYoo:
    type: object
    properties:
      yah:
        $ref: '#/definitions/FooBarBooAbcXyzYooYah'
    x-auto-generated: true
  FooBarBooAbcXyzYooYah:
    type: object
    properties:
      yay:
        type: string
    x-auto-generated: true
  Boo:
    type: array
    items:
      $ref: '#/definitions/BooItem'
  BooItem:
    type: object
    properties:
      foo:
        $ref: '#/definitions/Foo'
      user:
        $ref: '#/definitions/BooItemUser'
      grouplist:
        $ref: '#/definitions/BooItemGrouplist'
    x-auto-generated: true
  BooItemGrouplist:
    type: array
    items:
      $ref: '#/definitions/BooItemGrouplistItem'
    x-auto-generated: true
  BooItemGrouplistItem:
    type: object
    properties:
      name:
        type: string
    x-auto-generated: true
  BooItemUser:
    type: object
    properties:
      name:
        type: string
      age:
        type: number
    x-auto-generated: true