Skip to content

Define error responses for endpoints in the OpenAPI spec #12116

@amhn

Description

@amhn

NetBox version

v3.5-beta

Feature type

Change to existing functionality

Proposed functionality

This is based on #4986

The new API definition only includes the default response for a path. This makes it hard for code generators to create working code.

Adding the following responses to the relevant paths would help:
400: All responses?
404: All except post and bulk actions
403: All responses with security

Use case

More correct API definition to help library developers and automatic code generators

Database changes

No response

External dependencies

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    pending closureRequires immediate attention to avoid being closed for inactivitystatus: under reviewFurther discussion is needed to determine this issue's scope and/or implementationtopic: OpenAPItype: featureIntroduction of new functionality to the application

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions