PaloAltoNetworks / docusaurus-openapi-docs

🦝 OpenAPI plugin for generating API reference docs in Docusaurus v3.
https://docusaurus-openapi.tryingpan.dev
MIT License
684 stars 232 forks source link

Postman plugin and theme #564

Closed gii-pan closed 3 months ago

gii-pan commented 1 year ago

Describe the bug

The section of postman plugin is without the theme and some of our documentation didn't get the postman code in mdx.

Expected behavior

The postman plugin should display the theme in all languages ​​as shown in the demo version of the website and the url should be automatically completed.

Current behavior

The Ruby, C#, PHP, Java and Powershell ​​are without the default theme and present the code in black and white. Some mdx files generated by the plugin do not contain the code that postman should manage.

Steps to reproduce

Live example

  1. Install Docusaurus;
  2. Install and config the plugin/theme of Open Api;
  3. Generate the docs;
  4. Start Docusaurus.

Screenshots

postman

requisicao

Context

We need the requests working for the users, as well as the styling for a homogeneous look.

Your Environment

welcome-to-palo-alto-networks[bot] commented 1 year ago

:tada: Thanks for opening your first issue here! Welcome to the community!

gii-pan commented 1 year ago

I found out today that the issue with the postman code not being generated is due to the (.pdf ) in some endpoints like the one below:

/api/empresas/docs/{ambiente}/{codModelo}/{cnpjInteressado}/{ano}/{serie}/{numero}.pdf

What could I do? How to proceed?

The issue with the theme not being applied(first gif above) still persists.

sserrata commented 1 year ago

Hi @gii-pan, for the languages missing the theme/highlighting, have you already defined them in additionalLanguages?

Example: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/demo/docusaurus.config.js#L139

Concerning the .pdf issue, can you explain why those operations/paths end in a file extension? I am not familiar with that use case. Thanks!

artushin commented 19 hours ago

@gii-pan Did you ever figure out a solution or workaround to your .pdf issue?