Skip to content

Service Interface validator #402

@aregtech

Description

@aregtech

Description:

When user creates Service Interface file, there should be an option to validate the Service Interface.
The validation should have following types of messages:

  1. Error -- for example, the used data type or linked response name are wrong (not existing);
  2. Warning -- for example, the response is not linked with any request of a data type is never used;
  3. Information -- missed descriptions, presence of deprecations (deprecated types, attributes, methods, constants, etc.).

The errors have impact on build process, meaning that it indicates that the build can be broken (like call or not existing method / response).
The warning do not have impact on the build process, but they may confuse the user (like unused Response).
The information is something that nice to keep the data clean and structured.

The service interface validator should output messages in the Output Window.
The errors, warnings and information should be grouped.
Each error, warning and information should have clear and understandable description (section, entry, field).
If possible, by double clicking on the entry, the application should switch to the section which generated message and highlight the problematic entry (entries) helping the user to fix the issue as fast as possible.
If possible, the fixed issue should have immediate impact and display the entry as "fixed" without removing the entry to give the user the idea what has been fixed and what is still remaining.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions