Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Should we use the swagger file for API docs? #343

Closed
paulo-ocean opened this issue Mar 15, 2024 · 3 comments
Closed

Should we use the swagger file for API docs? #343

paulo-ocean opened this issue Mar 15, 2024 · 3 comments
Assignees
Labels
Type: Enhancement New feature or request

Comments

@paulo-ocean
Copy link
Contributor

Right now we have the following lines on index:

 app.use(
    '/docs',
    swaggerUi.serve,
    swaggerUi.setup(undefined, {
      swaggerOptions: {
        url: '/swagger.json'
      }
    })
  )

but we are not using it all, and the page shows nothing..
We are just writing .md files, like README.md, API.md, env.md
should we write swagger docs from API.md for instance?

@paulo-ocean paulo-ocean added the Type: Enhancement New feature or request label Mar 15, 2024
@alexcos20
Copy link
Member

Let's see if there is a nice way of having both HTTP and P2P commands documented.
If not, we will stick to .md files

@paulo-ocean
Copy link
Contributor Author

paulo-ocean commented Apr 5, 2024

well, its probably is not worth the effort after all..
i'm having a lot of issues just trying to configure it and i'm not exactly sure how to document all without a big amount of work
probably better to stick with .md files and remove the swagger references and dependencies anyway

@paulo-ocean
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants