Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
LSO
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
GÉANT Orchestration and Automation Team
GAP
LSO
Commits
6b84bc01
Verified
Commit
6b84bc01
authored
1 year ago
by
Karel van Klink
Browse files
Options
Downloads
Patches
Plain Diff
fix docstring indentation
parent
87a58ef4
No related branches found
No related tags found
No related merge requests found
Pipeline
#84801
passed
1 year ago
Stage: tox
Stage: documentation
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
lso/playbook.py
+4
-3
4 additions, 3 deletions
lso/playbook.py
with
4 additions
and
3 deletions
lso/playbook.py
+
4
−
3
View file @
6b84bc01
...
@@ -39,8 +39,8 @@ def playbook_launch_error(reason: str, status_code: int = status.HTTP_400_BAD_RE
...
@@ -39,8 +39,8 @@ def playbook_launch_error(reason: str, status_code: int = status.HTTP_400_BAD_RE
"""
Return a :class:`PlaybookLaunchResponse` for the erroneous start of a playbook execution.
"""
Return a :class:`PlaybookLaunchResponse` for the erroneous start of a playbook execution.
:param str reason: The reason why a request has failed.
:param str reason: The reason why a request has failed.
:param status status_code: The HTTP status code that should be associated with this request. Defaults to HTTP 400
:param status status_code: The HTTP status code that should be associated with this request. Defaults to HTTP 400
:
"
Bad request
"
.
Bad request.
:return JSONResponse: A playbook launch response that
'
s unsuccessful.
:return JSONResponse: A playbook launch response that
'
s unsuccessful.
"""
"""
return
JSONResponse
(
content
=
{
"
error
"
:
reason
},
status_code
=
status_code
)
return
JSONResponse
(
content
=
{
"
error
"
:
reason
},
status_code
=
status_code
)
...
@@ -164,7 +164,8 @@ def run_playbook(
...
@@ -164,7 +164,8 @@ def run_playbook(
:param dict[str, Any] extra_vars: Any extra vars needed for the playbook to run.
:param dict[str, Any] extra_vars: Any extra vars needed for the playbook to run.
:param dict[str, Any] | str inventory: The inventory that the playbook is executed against.
:param dict[str, Any] | str inventory: The inventory that the playbook is executed against.
:param :class:`HttpUrl` callback: Callback URL where the playbook should send a status update when execution is
:param :class:`HttpUrl` callback: Callback URL where the playbook should send a status update when execution is
completed. This is used for workflow-orchestrator to continue with the next step in a workflow.
completed. This is used for workflow-orchestrator to continue with the next step
in a workflow.
:return: Result of playbook launch, this could either be successful or unsuccessful.
:return: Result of playbook launch, this could either be successful or unsuccessful.
:rtype: :class:`fastapi.responses.JSONResponse`
:rtype: :class:`fastapi.responses.JSONResponse`
"""
"""
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment