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

Set Up API Documentation Hosting #35

Open
Tracked by #25 ...
Luka-Loncar opened this issue May 30, 2024 · 9 comments
Open
Tracked by #25 ...

Set Up API Documentation Hosting #35

Luka-Loncar opened this issue May 30, 2024 · 9 comments

Comments

@Luka-Loncar
Copy link

Luka-Loncar commented May 30, 2024

  • Host the API documentation on platforms like SwaggerHub in GitHub Pages for accessibility.
  • Push the documentation to a Category on Masa Developer docs using a GitHub Action
  • Add a Domain for the EC2 instance where we have been running validator/miner/healthcheck
  • Make sure the healthcheck API running on port 4000 has an SSL certificate ( requirement to be called from the vercel instance )
@grantdfoster
Copy link
Contributor

Theoretically this ticket can be closed if we are able to access the /docs from the deployed validator. @hide-on-bush-x is the validator still deployed at: http://34.235.146.46:8000/docs? seems like it may have moved...

@hide-on-bush-x
Copy link
Contributor

@grantdfoster Devnet lost state, I need to go through the whole process on that machine again

Will do it later today

@Luka-Loncar
Copy link
Author

@hide-on-bush-x hey - how this went? Can we close the issue?

@hide-on-bush-x
Copy link
Contributor

@Luka-Loncar Not yet, ill double check that the docs are accessible today

@hide-on-bush-x
Copy link
Contributor

@5u6r054 Hey! Found out that for some reason the server is not reacheable tried a few things but wasn't able to reach it at all

It should be accessible through sending a GET to http://34.235.146.46:8000/axons

This is blocked until we figure out whats going on

@mudler
Copy link
Contributor

mudler commented Jun 21, 2024

@5u6r054 can you help here maybe?

@hide-on-bush-x
Copy link
Contributor

All clear now, validator is running on http://34.235.146.46:8000

To access docs everyone can go to http://34.235.146.46:8000/docs and it will be accessible, currently the validator is running on pm2

@mudler
Copy link
Contributor

mudler commented Jul 1, 2024

what is left here is to have a DNS for the swagger API's and link these to the masa developer docs for an example of the API endpoints.

@juanmanso juanmanso added the wontfix This will not be worked on label Jul 2, 2024
@mudler
Copy link
Contributor

mudler commented Jul 5, 2024

There are still items left on this card to do

@mudler mudler reopened this Jul 5, 2024
@Luka-Loncar Luka-Loncar removed the wontfix This will not be worked on label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants