Rename requirement state `archived` to `closed`
What does this MR do?
Renames Requirement state archive
to close
in preparation for when Requirement
becomes an Issue
type.
In the GraphQL API, ARCHIVE
is still an alias for searching and updating requirements.
Screenshots (strongly suggested)
Name | Before | After |
---|---|---|
Categories | ||
Button & Tooltip | ||
Successful close | ||
Error on close |
Updated queries
You can now use either CLOSED
or ARCHIVED
as requirement states on query/mutation input.
Searching by requirement state
query {
project(fullPath: "group/project_path") {
requirements(state: CLOSED) {
nodes {
title
state
}
}
}
}
Result will be
{
"data": {
"project": {
"requirements": {
"nodes": [
{
"title": "Ut enim ad minim veniam",
"state": "CLOSED"
}
]
}
}
}
}
Updating
Using ARCHIVED
this time:
mutation {
updateRequirement(input:
{ projectPath: "group/project_path",
iid: "1", state: ARCHIVED }) {
errors
requirement {
iid
state
}
}
}
will result in
{
"data": {
"updateRequirement": {
"errors": [],
"requirement": {
"iid": "1",
"state": "CLOSED"
}
}
}
}
The alias isn't 100%, since it will only ever return CLOSED
. But for searching (as above), creating or updating, you can provide ARCHIVED
.
Conformity
-
I have included a changelog entry, or it's not needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) - [-] I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?)
-
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team
Related to #323779 (closed)
Edited by charlie ablett