Skip to content

Error message does not help identify the underlying cause #8

@fulcrum-stelios-papadopoulos

Description

I have an openapi json file generated using springdoc.

I used openapi-markdown to generate the markdown file.

After I modified the spring boot project (significantly) the markdown generation fails. I suspect some of the generated documentation is not to its liking, but I cannot pinpoint what could be the issue. I saddly cannot provide the source file, as it is an internal proprietary API.

Is there a way to indicate what part of the input json made it fail?

Traceback (most recent call last):
  File "/usr/local/bin/openapi2markdown", line 7, in <module>
    sys.exit(main())
             ~~~~^^
  File "/usr/local/lib/python3.14/site-packages/click/core.py", line 1161, in __call__
    return self.main(*args, **kwargs)
           ~~~~~~~~~^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.14/site-packages/click/core.py", line 1082, in main
    rv = self.invoke(ctx)
  File "/usr/local/lib/python3.14/site-packages/click/core.py", line 1443, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.14/site-packages/click/core.py", line 788, in invoke
    return __callback(*args, **kwargs)
  File "/usr/local/lib/python3.14/site-packages/openapi_markdown/bin/cli.py", line 34, in main
    raise e
  File "/usr/local/lib/python3.14/site-packages/openapi_markdown/bin/cli.py", line 29, in main
    to_markdown(input_file, output_file, templates_dir, options = {
    ~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        'filter_paths': filter_paths
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    })
    ^^
  File "/usr/local/lib/python3.14/site-packages/openapi_markdown/generator.py", line 78, in to_markdown
    template.render(spec=spec,
    ~~~~~~~~~~~~~~~^^^^^^^^^^^
                    ref_to_param=lambda ref: ref_to_param(ref, spec_data),
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
                    ref_to_schema=lambda ref: ref_to_schema(ref, spec_data))
                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.14/site-packages/jinja2/environment.py", line 1295, in render
    self.environment.handle_exception()
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^
  File "/usr/local/lib/python3.14/site-packages/jinja2/environment.py", line 942, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "/usr/local/lib/python3.14/site-packages/openapi_markdown/templates/api_doc_template.md.j2", line 1, in top-level template code
    # {{ spec.info.title }}
  File "/usr/local/lib/python3.14/site-packages/jinja2/environment.py", line 490, in getattr
    return getattr(obj, attribute)
jinja2.exceptions.UndefinedError: 'openapi_core.spec.paths.Spec object' has no attribute 'info'

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions