Skip to content

Add deprecated flag to operation template #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
deanmaunder wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Add deprecated flag to operation template #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

----
## [Unreleased]
### Added

* `newMethod()` now includes a `deprecated` flag on the operation template, defaulting to `false`, so generated operation objects declare the standard OpenAPI `deprecated` field.

## [3.0.0] => 2024-MAY-30
### Fixed
Expand Down
1 change: 1 addition & 0 deletions models/OpenAPI/Util.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ component name="OpenAPIUtil" accessors="true" {
{ "tags" : [] },
{ "description" : "" },
{ "operationId" : "" },
{ "deprecated" : false },
{ "parameters" : [] },
{ "responses" : { "default" : descMap } }
];
Expand Down
10 changes: 10 additions & 0 deletions test-harness/tests/specs/DocumentSpec.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@ component extends="tests.resources.BaseOpenAPISpec" {
} );
} );

describe( "Operation template tests", function(){
it( "Tests that newMethod() includes a deprecated flag defaulting to false", function(){
var method = getInstance( "OpenAPIUtil@SwaggerSDK" ).newMethod();

expect( method ).toBeStruct().toHaveKey( "deprecated" );
expect( method[ "deprecated" ] ).toBeBoolean();
expect( method[ "deprecated" ] ).toBeFalse();
} );
} );

describe( "Core functionality tests", function(){
it( "Tests that an attempt to locate an invalid path with return a $ref object", function(){
var DocumentObject = getInstance( "OpenAPIDocument@SwaggerSDK" ).init( VARIABLES.testDocument );
Expand Down