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

API: BuildCommands and missing fields to build v3 API #11179

Open
agjohnson opened this issue Mar 2, 2024 · 3 comments
Open

API: BuildCommands and missing fields to build v3 API #11179

agjohnson opened this issue Mar 2, 2024 · 3 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@agjohnson
Copy link
Contributor

agjohnson commented Mar 2, 2024

On the new dashboard, the build detail view is still using the v2 API. I would like to eventually rely on APIv3 on the dashboard, as that is the stronger API. I encountered the following data from the v2 API was not implemented in the V3 API however:

  • BuildCommands don't seem to be implemented -- this is the largest blocker
  • docs_url
  • commit_url
  • builder (for debugging only, not super important)

I did find I need the following changes once I can use the APIv3 build enpoint:

  • add ?expand=config for the config object

It would help if we could expand the notifications on the build APIv3 call and save the extra polling calls. Without this, that view needs to poll two APIs every two seconds while the build is still active.

For now, I can use the notification API v2 endpoints.

@humitos
Copy link
Member

humitos commented Mar 27, 2024

Noting for reference that we may also want to add ?expand=notifications for the APIv3 build endpoint: readthedocs/ext-theme#300 (comment)

@agjohnson
Copy link
Contributor Author

Pushing this to later, but we should consider fixing up build API v3 for our use high priority and get away from relying on API v2.

@agjohnson
Copy link
Contributor Author

I'm not sure exactly how to prioritize this at the moment, I was hoping we'd be farther into APIv3 fixes for permissions probably. I'm going to move this to new dashboard features milestone, even though this isn't much of a feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
Status: Planned
Development

No branches or pull requests

2 participants