Skip to content

Comments on the "new structured way to describe the functions" #2

@PrathibaJee

Description

@PrathibaJee

I reviewed the document Functions.md from entry level down to the Interpretation Functions. Please find the following review comments and let me know your views. Many thanks.

  1. Functions.md#L7 - [Prathiba] Shall we make measurement module to take care of the functionalities mentioned in the "Private InterpretationFunctions". If generically defined conditions are fulfilled, alarms shall be created. Further, implementation module shall call the either the "public interpretation functions" Or "REST APIs" to do the abstract request.
  2. Functions.md#L13 - [Prathiba] Shall we also mention about the rollback. Something like this "If the validation fails, no further actions will be performed as in the starting of every request the content of the RunningDS will be copied to the CandidateDS."
  3. ProcessingCreate.md#L14 - [Prathiba] shall we also indicate the list of validation functions that shall be called from here? If the validation functions are not generic across the APIs, then we can have separate section for each service and the validation functions shall be listed like how it is done in the ProcessingEstablish.md
  4. ProcessingCreate.md#L14 - [Prathiba] If the logical object could not be identify , then request shall be rejected with a custom response code. Shall we mention it here ? and Similar comment applicable for Update too.
  5. ProcessingRegard.md#L29 - [Prathiba] If the logical object could not be identify , then request shall be rejected with a custom response code.

Metadata

Metadata

Assignees

Labels

questionFurther information is requested

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions