Skip to content

Generate SRS and protocol #11

@dfelipe64

Description

@dfelipe64

After eo150-app SRS revision these 2 specifications must be removed. In order to be able to cover this HIS functionalities, an HIS-api SRS and protocol must be generated.

TO DO

Generate an SRS with next specifications:

_APP-SRS-0001_ It must be possible to generate an api file to complete server information
_APP-SRS-0010_ A documentation must be delivered with HIS feature

Generate a protocol with next tests:

_APP-TST-0001 refers to APP-SRS-0001_

Feature: HIS api.json generation
  Scenario: HIS api.json generation
    Given an his-connectivity up to date

    When launching next command from his-cli:

      npm_config_registry=https://npm.pkg.github.com/eove npx @eove/his-cli generate-api-doc \
        --moduleApiVersion 32.2 \
        --productType eo150 \
        --locale en-EN \
        --outputFile ~/Downloads/exemple_his_api.json

    Then json file is generated in the outputFile .......................... PASS [ ] / FAIL [ ]
      And the json file displays HIS apiVersion ............................ PASS [ ] / FAIL [ ]
      And the json file displays module apiVersion ......................... PASS [ ] / FAIL [ ]
      And the json file displays product type .............................. PASS [ ] / FAIL [ ]
      And the json file displays labels and units for monitoring items ..... PASS [ ] / FAIL [ ]
      And the json file displays labels and units for modes items .......... PASS [ ] / FAIL [ ]
      And the json file displays labels and units for alarms items ......... PASS [ ] / FAIL [ ]
      And the json file displays labels, priority and category for alarms items .............................................................................................. PASS [ ] / FAIL [ ]
      And the json file displays labels for alarms categories items ........ PASS [ ] / FAIL [ ]
      And the json file displays labels for alarms priorities items ........ PASS [ ] / FAIL [ ]
      And the json file displays labels and units for waveforms items ...... PASS [ ] / FAIL [ ]
      And the json file displays labels for units items .................... PASS [ ] / FAIL [ ]


_APP-TST-0010 refers to APP-SRS-0010_

Feature: HIS documentation
  Scenario: HIS documentation

    Given an his-connectivity up to date

    When going to his-api/docs/eove-his-interface.md repository

    Then an his-api user manual is displayed .................................... PASS [ ] / FAIL [ ]
      And this document allow user to develop his own client .................... PASS [ ] / FAIL [ ]
      ANd there is a text explaining that eove can not be responsible of the software developped to use eo150 data ............................................................ PASS [ ] / FAIL [ ]

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions