Skip to content

Endpoint macro should support deprecated #489

@just-be-dev

Description

@just-be-dev

The openapi spec supports a boolean field on the operation object that signifies the operation is deprecated. We should allow that to be specified via the endpoint macro.

Example

#[endpoint {
    method = GET,
    path = "/organizations/{organization_name}/projects/{project_name}/instances",
    tags = ["instances"],
    deprecated = true,
}]

One thing to consider is that if we deprecate something we should always provide documentation to the user on what to use instead. That could either be baked in to the api by having deprecated actually take a string or enforced later via a lint rule.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions