Uploaded image for project: 'Beam'
  1. Beam
  2. BEAM-13028

[Playground] Examples API

Details

    Description

      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:

      1. 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
      2. 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
      3. 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
      4. 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
      5. 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
      6. Examples Catalog is displayed in the example selector
        Same Scenario as in AC2.
      7. Protobuf file is updated and tested with frontend and backend

      Attachments

        There are no Sub-Tasks for this issue.

        Activity

          People

            daria.malkova Daria Malkova
            Artur.Khanin Artur Khanin
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 4h 40m
                4h 40m