Skip to content

Support operation-level deprecated annotation#51

Open
deanmaunder wants to merge 1 commit into
coldbox-modules:developmentfrom
deanmaunder:feature/operation-deprecated
Open

Support operation-level deprecated annotation#51
deanmaunder wants to merge 1 commit into
coldbox-modules:developmentfrom
deanmaunder:feature/operation-deprecated

Conversation

@deanmaunder

@deanmaunder deanmaunder commented Jun 8, 2026

Copy link
Copy Markdown

Parse a deprecated annotation on handler actions and emit a standard OpenAPI operation-level deprecated: true. Function attributes arrive as strings (deprecated="true"), so the value is coerced to a real JSON boolean rather than serialised as the string "true".

Pairs with swagger-sdk's newMethod() deprecated default, which seeds the operation object with deprecated: false for non-annotated actions.

Generated with AI

Issues

#52

Type of change

Please delete options that are not relevant.

  • Improvement
  • This change requires a documentation update

Checklist

  • My code follows the style guidelines of this project cfformat
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Parse a `deprecated` annotation on handler actions and emit a standard
OpenAPI operation-level `deprecated: true`. Function attributes arrive as
strings (deprecated="true"), so the value is coerced to a real JSON
boolean rather than serialised as the string "true".

Pairs with swagger-sdk's `newMethod()` deprecated default, which seeds the
operation object with `deprecated: false` for non-annotated actions.

Generated with AI

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant