[jira] [Updated] (BEAM-13028) [Playground] Examples API

["Artur Khanin (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/BEAM-13028?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Artur Khanin updated BEAM-13028:
--------------------------------
    Labels: beam-playground-backend beam-playground-frontend beam-playground-sprint-2 beam-playground-sprint-3 beam-playground-sprint-4  (was: beam-playground-backend beam-playground-frontend beam-playground-sprint-2 beam-playground-sprint-3)

> [Playground] Examples API
> -------------------------
>
>                 Key: BEAM-13028
>                 URL: https://issues.apache.org/jira/browse/BEAM-13028
>             Project: Beam
>          Issue Type: New Feature
>          Components: beam-playground
>            Reporter: Artur Khanin
>            Assignee: Daria Malkova
>            Priority: P3
>              Labels: beam-playground-backend, beam-playground-frontend, beam-playground-sprint-2, beam-playground-sprint-3, beam-playground-sprint-4
>
> As a Beam Playground application developer, I want to store examples with their predefined output and be able to retrieve them via gRPC.
> Acceptance criteria:
>  # Examples storing is designed and implemented
>  _*Scenario: Developer adds a new example*_
>  *Given:* Developer has the Apache Beam example as a file
> *And:* Developer has the output of the Apache Beam example as a file
> *When*: Developer puts the file with the Apache Beam example to the storage
> *And:* Developer puts the output of the Apache Beam example next to the file with example
>  *Then*: The example appears in Beam Playground Example Catalog
>  # A list of existing examples is retrieved
>  _*Scenario: User opens Example selector*_
>  *Given:* Client sent a gRPC call for a list of existing examples
> *When*: Server accessed the Examples storage
>  *And:* Server made a list of all examples in the storage
>  *Then*: The response for the gRPC call with the list of existing examples is received
>  *And:* User sees the Catalog of all available examples
>  # The Initial (default) example is retrieved
>  _*Scenario: User chooses another SDK*_
>  *Given:* Client sent a gRPC call for an initial example for a given SDK
> *When*: Server accessed the Examples storage
>  *And:* Server gets the initial example for the given SDK
>  *Then*: The response for the gRPC call with an initial example for the given SDK is received
>  *And:* User sees the initial example in the code editor
>  # Each example provides a corresponding category and description
>  _*Scenario: User opens Example selector and focuses on one example*_
>  *Given:* A list of available examples is already retrieved
> *When*: User hovers the pointer over a specific example
>  *Then*: User sees a popup with a description of the example
>   __ 
>  _*Scenario: User opens Example selector*_
>  *Given:* A list of available examples is already retrieved
> *When*: User open Example selector
>  *Then*: User sees the Example Catalog with examples divided by categories
>  # The predefined output of the example is displayed after its run
>  _*Scenario: User run an example without modifications of it*_
>  *Given:* User didn't change the chosen example
> *When*: User pressed Run button
>  *Then*: User sees the output of the example without actual calculations
>  *And:* User sees the output of the example fast
>  # Examples Catalog is displayed in the example selector
>  _*Same Scenario as in AC2.*_
>  # Protobuf file is updated and tested with frontend and backend



--
This message was sent by Atlassian Jira
(v8.20.1#820001)