Reintroduce steps API based on GovStack spec #2833
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
jyeshe
changed the title
jyeshe
force-pushed
the
steps-api
branch
2 times, most recently
from
5809500 to
1b9fd4d
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2833 +/- ##
==========================================
+ Coverage 91.37% 91.43% +0.06%
==========================================
Files 340 342 +2
Lines 12225 12253 +28
==========================================
+ Hits 11171 11204 +33
+ Misses 1054 1049 -5 ☔ View full report in Codecov by Sentry. |
jyeshe
changed the title
elias-ba
approved these changes
Jan 21, 2025
| @@ -17,6 +17,9 @@ and this project adheres to | |||
|
|
|||
| ### Added | |||
|
|
|||
| - Reintroduce steps (old runs) API based on GovStack spec. | |||
There was a problem hiding this comment.
Could we mention that we are reintroducing them in the runs api. That way we are clear that it has no UI implications.
Comment on lines
+1
to
+63
| defmodule LightningWeb.API.StepController do | ||
| use LightningWeb, :controller | ||
|
|
||
| alias Lightning.Invocation | ||
| alias Lightning.Policies.Permissions | ||
| alias Lightning.Policies.ProjectUsers | ||
| alias Lightning.Projects | ||
|
|
||
| @valid_params ~w(page page_size project_id) | ||
| @max_page_size Application.compile_env( | ||
| :lightning, | ||
| LightningWeb.API.StepController | ||
| )[:max_page_size] || 100 | ||
|
|
||
| action_fallback LightningWeb.FallbackController | ||
|
|
||
| def index(conn, %{"project_id" => project_id} = params) do | ||
| with :ok <- validate_params(params), | ||
| :ok <- authorize_read(conn, project_id) do | ||
| pagination_attrs = | ||
| params | ||
| |> Map.take(["page", "page_size"]) | ||
| |> Map.update( | ||
| "page_size", | ||
| @max_page_size, | ||
| &min(@max_page_size, String.to_integer(&1)) | ||
| ) | ||
|
|
||
| page = | ||
| project_id | ||
| |> Projects.get_project!() | ||
| |> Invocation.list_steps_for_project(pagination_attrs) | ||
|
|
||
| render(conn, "index.json", %{page: page, conn: conn}) | ||
| end | ||
| end | ||
|
|
||
| def show(conn, %{"project_id" => project_id, "id" => id}) do | ||
| with :ok <- authorize_read(conn, project_id) do | ||
| step = Invocation.get_step_with_job!(id) | ||
| render(conn, "show.json", %{step: step, conn: conn}) | ||
| end | ||
| end | ||
|
|
||
| defp validate_params(params) do | ||
| with [] <- Map.keys(params) -- @valid_params, | ||
| {_n, ""} <- Integer.parse(params["page"] || "1"), | ||
| {_n, ""} <- Integer.parse(params["page_size"] || "1") do | ||
| :ok | ||
| else | ||
| _invalid -> {:error, :bad_request} | ||
| end | ||
| end | ||
|
|
||
| defp authorize_read(conn, project_id) do | ||
| Permissions.can( | ||
| ProjectUsers, | ||
| :access_project, | ||
| conn.assigns.current_resource, | ||
| %{project_id: project_id} | ||
| ) | ||
| end | ||
| end |
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
This PR adds a Steps API based on the GovStack Workflow Process API spec.
Closes #1656
Validation steps
/api/projects/<project_id>/steps//api/projects/<project_id>/steps/<step_id>/api/projects/<project_id>/steps/usingpageandpage_sizequery params (defaultpage_sizeis 10 and max is 100)Additional notes for the reviewer
/api/projectsAI Usage
Please disclose how you've used AI in this work (it's cool, we just want to know!):
You can read more details in our Responsible AI Policy
Pre-submission checklist
:owner,:admin,:editor,:viewer)