Docs/Backend API docs #109
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ZergLev
changed the title
Ramimashkouk
requested changes
Jan 28, 2025
| """Starts a `build` process with the given preset. | ||
|
|
||
| This runs a background task to check the status of the process every 2 seconds. | ||
|
|
||
| Args: | ||
| preset (Preset): The preset to set the build process for. Must be among ("success", "failure", "loop") | ||
| background_tasks (BackgroundTasks): A background tasks manager. Required to schedule a task that checks the |
There was a problem hiding this comment.
Suggested change
| background_tasks (BackgroundTasks): A background tasks manager. Required to schedule a task that checks the | |
| background_tasks (BackgroundTasks): A background tasks manager. Required to schedule a task that keeps checking the status of the build process in the background after returning a response. |
There was a problem hiding this comment.
Changed the description now. Commit number: 32243f9.
| @@ -159,6 +204,9 @@ async def start_run( | |||
| Args: | |||
| build_id (int): The id of the build process to start running. | |||
| preset (Preset): The preset to set the build process for. Must be among ("success", "failure", "loop") | |||
| background_tasks (BackgroundTasks): A background tasks manager. Required to schedule a task that checks the | |||
There was a problem hiding this comment.
Changed the description now. Commit number: 32243f9.
| ) -> Dict[str, str]: | ||
| """Write the flows to the frontend_flows.yaml file.""" | ||
| """Write the flows to the frontend_flows.yaml file. |
There was a problem hiding this comment.
Suggested change
| """Write the flows to the frontend_flows.yaml file. | |
| """Write the flows to the frontend_flows.yaml file. Then commit changes to git without a tag. |
tags are only created when building. their names are the builds ids
There was a problem hiding this comment.
Merge dev to your branch to see this fix
There was a problem hiding this comment.
Merged dev, but that didn't fix it, so I did it manually. Commit number: 536215b.
| @@ -18,7 +18,16 @@ | |||
| async def flows_get( | |||
| build_id: Optional[int] = None, build_manager: BuildManager = Depends(get_build_manager) | |||
| ) -> Dict[str, Union[str, Dict[str, Union[list, dict]]]]: | |||
| """Get the flows by reading the frontend_flows.yaml file.""" | |||
| """Get the flows by reading the frontend_flows.yaml file. | |||
There was a problem hiding this comment.
Suggested change
| """Get the flows by reading the frontend_flows.yaml file. | |
| """Gets the flows by reading the frontend_flows.yaml file. If the build_id isn't passed then it will return the last saved (committed) flow. |
There was a problem hiding this comment.
Changed the description now. Commit number: 536215b.
backend/chatsky_ui/api/deps.py
Outdated
| @@ -4,6 +4,7 @@ | |||
|
|
|||
|
|
|||
| def get_build_manager() -> BuildManager: | |||
| """Returns the `build` process manager.""" | |||
There was a problem hiding this comment.
Suggested change
| """Returns the `build` process manager.""" | |
| """Returns the only used instance of `build` process manager.""" |
There was a problem hiding this comment.
True, that explains it better. Changed it now in 54abaca.
backend/chatsky_ui/api/deps.py
Outdated
| @@ -14,6 +15,7 @@ def get_build_manager() -> BuildManager: | |||
|
|
|||
|
|
|||
| def get_run_manager() -> RunManager: | |||
| """Returns the `run` process manager.""" | |||
There was a problem hiding this comment.
Same as above. Changed it now in 54abaca.
…hatsky-ui into docs/endpoints_docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added documentation for backend API. (api/endpoints and services/json_converter)
Added Bun installation to CONTRIBUTING.md
Checklist
To Consider