Reports and Scripts definitions are missing from OpenAPI #8257

Closed
opened 2025-12-29 20:34:25 +01:00 by adam · 3 comments
Owner

Originally created by @abhi1693 on GitHub (Jun 28, 2023).

Originally assigned to: @arthanson on GitHub.

NetBox version

v3.5.4

Python version

3.10

Steps to Reproduce

This can be seen on the demo instance under extras at https://demo.netbox.dev/api/schema/swagger-ui/#/extras. There are no definitions displayed pertaining to scripts or reports.

You can still see these partially at https://demo.netbox.dev/api/extras/scripts/ and https://demo.netbox.dev/api/extras/reports/.

However, the same was available in v3.4.10.

Expected Behavior

GET and POST definitions for scripts and reports should be visible under OpenAPI.

Observed Behavior

No definitions for scripts and reports are visible in OpenAPI definition

Originally created by @abhi1693 on GitHub (Jun 28, 2023). Originally assigned to: @arthanson on GitHub. ### NetBox version v3.5.4 ### Python version 3.10 ### Steps to Reproduce This can be seen on the demo instance under extras at https://demo.netbox.dev/api/schema/swagger-ui/#/extras. There are no definitions displayed pertaining to scripts or reports. You can still see these partially at https://demo.netbox.dev/api/extras/scripts/ and https://demo.netbox.dev/api/extras/reports/. However, the same was available in v3.4.10. ### Expected Behavior GET and POST definitions for scripts and reports should be visible under OpenAPI. ### Observed Behavior No definitions for scripts and reports are visible in OpenAPI definition
adam added the type: bugstatus: blockedseverity: lowtopic: OpenAPI labels 2025-12-29 20:34:25 +01:00
adam closed this issue 2025-12-29 20:34:25 +01:00
Author
Owner

@arthanson commented on GitHub (Aug 9, 2023):

The reports and scripts are not direct models so have to be done a bit different, as these will probably be combined together in 4.0 it makes sense to wait for then to do this.

@arthanson commented on GitHub (Aug 9, 2023): The reports and scripts are not direct models so have to be done a bit different, as these will probably be combined together in 4.0 it makes sense to wait for then to do this.
Author
Owner

@abhi1693 commented on GitHub (Feb 21, 2024):

Blocked by #14438

@abhi1693 commented on GitHub (Feb 21, 2024): Blocked by #14438
Author
Owner

@arthanson commented on GitHub (Feb 27, 2024):

This is fixed as part of #14438 which will be in NB 4.0 (see screenshot of swagger docs) so closing.
Monosnap NetBox REST API 2024-02-27 10-18-28

@arthanson commented on GitHub (Feb 27, 2024): This is fixed as part of #14438 which will be in NB 4.0 (see screenshot of swagger docs) so closing. ![Monosnap NetBox REST API 2024-02-27 10-18-28](https://github.com/netbox-community/netbox/assets/99642/f7eb0239-0cff-4d77-bd2e-5e55aa49cf84)
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8257