code.vegaprotocol.io/vega@v0.79.0/.github/ISSUE_TEMPLATE/api_ticket.md (about)

     1  ---
     2  name: API request
     3  about: A request for an API to support a feature
     4  title: '[API]: '
     5  labels: "api"
     6  assignees: ''
     7  ---
     8  
     9  # API Overview
    10  
    11  **In order to** ... (context - overcome a problem or meet a requirement)
    12  **We will build an API to**... (what - describe what the API needs to do)
    13  **So that** ... (why - we create these outcomes)
    14  
    15  - 
    16  - 
    17  - 
    18  
    19  ## Specs
    20  [Spec name](URL) to spec or section within a spec
    21  
    22  ## API request details
    23  
    24  - [ ] Create an API that... (specific details about the API's functionality and what it should provide)
    25  - [ ] 
    26  
    27  ### Filtering requirements (inputs)
    28    - [ ] 
    29    - [ ] 
    30  
    31  ### Sample API output (optional)
    32  
    33  ```
    34  
    35  ```
    36  
    37  ## Questions 
    38  Open questions about the feature implementation, what can be done with the APIs, or currently unresolved questions around the feature.
    39  
    40  ## API test scenarios
    41  Detailed scenarios that can be executed as feature tests to verify that the API has been implemented as expected.
    42  
    43  GIVEN (setup/context) 
    44  WHEN (action) 
    45  THEN (assertion) For example...
    46  See [here](https://github.com/vegaprotocol/vega/tree/develop/core/integration) for more format information and examples.
    47  
    48  ### Additional Details (optional)
    49  Any additional information that provides context or gives information that will help us develop the feature.