Vridlo/types/Issue: Difference between revisions

From ALT Linux Wiki
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Issue''' is a '''''primary''''' structure that represents an issue beloging to specific '''[[Vridlo/types/Rpm|Rpm]]'''. It is described as:
'''Issue''' is a '''''primary''''' structure that represents an issue belonging to the specific '''[[Vridlo/types/App|application]]''' or '''[[Vridlo/types/Rpm|RPM]]'''. It is described as:


* '''id''' is ''natural '''mandatory read-only'''''
* '''id''' is ''natural '''mandatory read-only'''''
  Unique internal identifier of the issue.
  Unique identifier of the issue.


* '''kind''' is ''string '''mandatory read-only'''''
* '''kind''' is ''string '''mandatory write-once'''''
  Kind of the issue, it describes a source, which the issue has been got from. It is unchangeable.
  Kind of the issue, it describes a source, which the issue has been got from. It is unchangeable.


* '''no''' is ''string '''mandatory read-only'''''
* '''no''' is ''string '''mandatory write-once'''''
  Number of code of the issue, in the pair with kind is an unique identifier of the issue in the system. It is unchangeable.
  Number of code of the issue, in the pair with kind is an unique identifier of the issue in the system. It is unchangeable.


Line 16: Line 16:
  Severity of the issue. Must contain one of ''normal'', ''critical'', ''major'', ''enhancement'', ''minor'', ''blocker''.
  Severity of the issue. Must contain one of ''normal'', ''critical'', ''major'', ''enhancement'', ''minor'', ''blocker''.


* '''revrb''' is ''string '''mandatory'''''
* '''target_kind''' is ''string '''mandatory'''''
  Unique rpm identifier slug if the application, including, ''epoch'', ''version'', ''release'', ''buildtime'' of the app separated by "'''-'''" minus sign, which the issue belongs to.
Kind of the issue target, can be one of ''rpm'', ''app''.
 
* '''target''' is ''string '''mandatory'''''
  Unique identifier of the issue target, when '''target_kind''' is ''rpm'', identifier is the RPM identifier '''slug''' in '''revrb''' format, which includes ''epoch'', ''version'', ''release'', ''buildtime'' of the RPM separated by "'''-'''" minus sign. When '''target_kind''' is ''app'', identifier is the '''[[Vridlo/types/App|application]]''' '''slug'''.


* '''reporter_email''' is ''string '''mandatory'''''
* '''reporter_email''' is ''string '''mandatory'''''
Line 27: Line 30:
* '''description''' is ''string '''optional'''''
* '''description''' is ''string '''optional'''''
  Description of the problem. It is formatted as defined in the '''description_format''' field.
  Description of the problem. It is formatted as defined in the '''description_format''' field.
* '''description_title''' is ''string '''optional'''''
Description title, which can contain the single line of description optionally with with maintain URI, which the issue is based on. The URI can be served as an external description URI for the issue. It is formatted also as the description itself, i.e. as defined in the '''description_format''' field. Must be presented, when '''description''' is also presented.


* '''description_format''' is ''string '''optional'''''
* '''description_format''' is ''string '''optional'''''
  Format of the text, which the description of the problem is written in. Can be one of ''html'', ''markdown'', ''text''.
  Format of the text, which the description of the problem is written in. Can be one of ''html'', ''markdown'', ''text''. Must be blank when '''description''' and '''description_title''' are also blank.
 
* '''description_title''' is ''string '''optional'''''
Description title, which can contain the single line of description optionally with with maintain URI, which the issue is based on. The URI can be served as an external description URI for the issue. It is formatted also as the description itself, i.e. as defined in the '''description_format''' field.


* '''reported_at''' is ''datetime '''optional'''''
* '''reported_at''' is ''datetime '''optional'''''
Line 40: Line 43:
  The date and time, when the issue was resolved, i.e. get resolved state last time.
  The date and time, when the issue was resolved, i.e. get resolved state last time.


* '''touched_at''' is ''string '''optional'''''
* '''touched_at''' is ''datetime '''optional'''''
  The date and time, when '''status''' was updated last time.
  The date and time, when '''status''' was updated last time.


Combination of '''kind''', '''no''' must be unique for the system.
Combination of '''kind''', '''no''' must be unique for the system.

Latest revision as of 16:34, 25 December 2019

Issue is a primary structure that represents an issue belonging to the specific application or RPM. It is described as:

  • id is natural mandatory read-only
Unique identifier of the issue.
  • kind is string mandatory write-once
Kind of the issue, it describes a source, which the issue has been got from. It is unchangeable.
  • no is string mandatory write-once
Number of code of the issue, in the pair with kind is an unique identifier of the issue in the system. It is unchangeable.
  • status is string mandatory
Status of the issue. Must contain one of new, resolved, assigned, verified, reopened, closed
  • severity is string mandatory
Severity of the issue. Must contain one of normal, critical, major, enhancement, minor, blocker.
  • target_kind is string mandatory
Kind of the issue target, can be one of rpm, app.
  • target is string mandatory
Unique identifier of the issue target, when target_kind is rpm, identifier is the RPM identifier slug in revrb format, which includes epoch, version, release, buildtime of the RPM separated by "-" minus sign. When target_kind is app, identifier is the application slug.
  • reporter_email is string mandatory
Email of the person or bot who is reported the problem / issue.
  • resolution is string optional
Status of the issue resolution. May contain one of fixed, worksforme, notabug, wontfix, duplicate, later, or blank value.
  • description is string optional
Description of the problem. It is formatted as defined in the description_format field.
  • description_title is string optional
Description title, which can contain the single line of description optionally with with maintain URI, which the issue is based on. The URI can be served as an external description URI for the issue. It is formatted also as the description itself, i.e. as defined in the description_format field. Must be presented, when description is also presented.
  • description_format is string optional
Format of the text, which the description of the problem is written in. Can be one of html, markdown, text. Must be blank when description and description_title are also blank.
  • reported_at is datetime optional
The date and time, when the report was acquired from the reporter.
  • resolved_at is datetime optional
The date and time, when the issue was resolved, i.e. get resolved state last time.
  • touched_at is datetime optional
The date and time, when status was updated last time.

Combination of kind, no must be unique for the system.