Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GEANT] Cannot change incident description #811

Closed
elfjes opened this issue May 10, 2024 · 2 comments · Fixed by #852
Closed

[GEANT] Cannot change incident description #811

elfjes opened this issue May 10, 2024 · 2 comments · Fixed by #852
Assignees
Labels
enhancement New feature or request

Comments

@elfjes
Copy link
Collaborator

elfjes commented May 10, 2024

During our PENDING phase, an incident's description may change. We would like to update an Incident's description in Argus. Currently this is not allowed as per:

class IncidentPureDeserializer(serializers.ModelSerializer):
EDITABLE_FIELDS = set(["ticket_url", "details_url", "level", "metadata"])
tags = IncidentTagRelationSerializer(many=True, write_only=True)
class Meta:
model = Incident
fields = [
"tags",
"details_url",
"ticket_url",
"level",
"metadata",
]

We would like this to be changed so that we can update an Incident description

@elfjes
Copy link
Collaborator Author

elfjes commented May 13, 2024

We have discussed that we could put our description in the metadata instead of making use of the Argus' provided Incident.description field. This is indeed a possibility but I'm a little bit reluctant to using it as I'm not quite sure how many places in the (upcoming) UI the description field might be used (which we would have to substitute for our metadata.description). And then the number of places may grow in the future as the UI evolves. I fear that this may lead to a reduced maintainablity on our side.

So I'd very much prefer it if Incident.description becomes an editable field. Or if that is not possible, that we (on our side) can change the render context for any template that uses description to show our specified Incident.metadata.description instead of the (default) incident.description

@github-project-automation github-project-automation bot moved this to 📋 Backlog in HTMXify Argus May 24, 2024
@lunkwill42 lunkwill42 added the enhancement New feature or request label May 24, 2024
@lunkwill42
Copy link
Member

I see no reason why incident descriptions could not be editable, as long as we follow the established pattern of logging a change event that describes what changed and who did it.

@lunkwill42 lunkwill42 moved this from 📋 Backlog to 🔖 Ready in HTMXify Argus May 24, 2024
@johannaengland johannaengland moved this from 🔖 Ready to 🏗 In progress in HTMXify Argus Jul 26, 2024
@hmpf hmpf closed this as completed in #852 Aug 19, 2024
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in HTMXify Argus Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants