starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Journal entries: dcim.interface - can create but no Journal tab for interfaces and error generated in Journal viewer #7008

New Issue
Closed
opened 2025-12-29 19:47:49 +01:00 by adam · 4 comments
adam commented 2025-12-29 19:47:49 +01:00
Owner
Copy Link

Originally created by @palmersample on GitHub (Sep 20, 2022).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.2.7

Python version

3.9

Steps to Reproduce

  1. Create a journal entry using the REST API. Target: /api/extras/journal-entries Payload:
{
    "assigned_object_type": "dcim.interface",
    "assigned_object_id": 163,
    "kind": "info",
    "comments": "Hey.  I assigned an IP address to this interface as a test."
}
  1. HTTP status 201 Created received.
  2. Navigate to the interface page, no Journal tab is listed.
  3. Navigate to Other -> Journal Entries and journal entry is listed
    image
  4. Click on journal entry, an error is generated:
    image

My apologies is this has been corrected in 3.3, unable to update at this time so reporting as a 3.2.7 problem.

Expected Behavior

Ability to view journal entries for an interface, either on the interface page or via the journal viewer.

Observed Behavior

Successfully submitted a journal entry via REST API but unable to view in either the interface or journal viewer context.

Originally created by @palmersample on GitHub (Sep 20, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.2.7 ### Python version 3.9 ### Steps to Reproduce 1. Create a journal entry using the REST API. Target: ```/api/extras/journal-entries``` Payload: ```python { "assigned_object_type": "dcim.interface", "assigned_object_id": 163, "kind": "info", "comments": "Hey. I assigned an IP address to this interface as a test." } ``` 2. HTTP status ```201 Created``` received. 3. Navigate to the interface page, no Journal tab is listed. 4. Navigate to **Other** -> **Journal Entries** and journal entry is listed <img width="1019" alt="image" src="https://user-images.githubusercontent.com/40956652/191370386-1faf74d0-164b-412b-9ae9-55d0ee0236ae.png"> 5. Click on journal entry, an error is generated: <img width="897" alt="image" src="https://user-images.githubusercontent.com/40956652/191370452-e143bf94-4867-486a-8663-97620ae2030d.png"> My apologies is this has been corrected in 3.3, unable to update at this time so reporting as a 3.2.7 problem. ### Expected Behavior Ability to view journal entries for an interface, either on the interface page or via the journal viewer. ### Observed Behavior Successfully submitted a journal entry via REST API but unable to view in either the interface or journal viewer context.
adam added the type: bugstatus: accepted labels 2025-12-29 19:47:49 +01:00
adam closed this issue 2025-12-29 19:47:49 +01:00
adam commented 2025-12-29 19:47:49 +01:00
Author
Owner
Copy Link

@jsenecal commented on GitHub (Sep 21, 2022):

Hi @palmersample, this was likely an oversight and should not be made available from the API at all.

What is the intended use of the journaling functionality on interfaces ?

@jsenecal commented on GitHub (Sep 21, 2022): Hi @palmersample, this was likely an oversight and should not be made available from the API at all. What is the intended use of the journaling functionality on interfaces ?
adam commented 2025-12-29 19:47:49 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Sep 21, 2022):

Journalling was added under #151.

I don't see a reason not to extend journalling to components.

@DanSheps commented on GitHub (Sep 21, 2022): Journalling was added under #151. I don't see a reason not to extend journalling to components.
adam commented 2025-12-29 19:47:50 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 27, 2022):

Currently, we don't officially support journaling for interfaces, or for any other models where no "Journal" tab appears within its UI view. However, there's no firm validation in place to prevent the creation of journal entries for unsupported types. (This is a byproduct of these models inheriting from the NetBoxFeatureSet class.)

I see two options:

  1. Implement validation to prevent the creation of journal entries for unsupported models.
  2. Officially extend journaling support to these other models.

If we pick option two, it would probably make sense to implement #9072 first, as that should allow us to more easily register journal views for each model. (This is currently done via a manual URL path definition for each model in its respective urls.py file.)

@jeremystretch commented on GitHub (Sep 27, 2022): Currently, we don't officially support journaling for interfaces, or for any other models where no "Journal" tab appears within its UI view. However, there's no firm validation in place to prevent the creation of journal entries for unsupported types. (This is a byproduct of these models inheriting from the `NetBoxFeatureSet` class.) I see two options: 1. Implement validation to prevent the creation of journal entries for unsupported models. 2. Officially extend journaling support to these other models. If we pick option two, it would probably make sense to implement #9072 first, as that should allow us to more easily register journal views for each model. (This is currently done via a manual URL path definition for each model in its respective `urls.py` file.)
adam commented 2025-12-29 19:47:50 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 4, 2022):

I'm going to proceed with option 1 above to resolve this bug. Happy to revisit expanding support for journaling to other models once #9072 has been addressed if there's demand for it.

@jeremystretch commented on GitHub (Oct 4, 2022): I'm going to proceed with option 1 above to resolve this bug. Happy to revisit expanding support for journaling to other models once #9072 has been addressed if there's demand for it.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#7008
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?