Skip to content

fix(openapi-generator): Optionally generate @Beta annotation on interfaces #688

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

Merged
newtork merged 4 commits into from
Jan 14, 2025
Merged

fix(openapi-generator): Optionally generate @Beta annotation on interfaces #688

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2135f69
Initial
a-d Jan 10, 2025
52682f3
Fix
a-d Jan 10, 2025
1268008
Update assertion
a-d Jan 10, 2025
1b68e05
Merge branch 'main' into openapi/anyof-annotation-beta
newtork Jan 10, 2025
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: 2 additions & 1 deletion ...enerator/src/main/resources/openapi-generator/mustache-templates/oneof_interface.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
* {{description}}{{^description}}{{classname}}{{/description}}{{#isDeprecated}}
* @deprecated{{/isDeprecated}}
*/{{#isDeprecated}}
@Deprecated{{/isDeprecated}}
@Deprecated{{/isDeprecated}}{{^isReleased}}
@Beta{{/isReleased}}
{{>additionalOneOfTypeAnnotations}}{{>typeInfoAnnotation}}{{>xmlAnnotation}}
public interface {{classname}} {{#vendorExtensions.x-implements}}{{#-first}}extends {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{/vendorExtensions.x-implements}} {
{{#discriminator}}
Expand Down
2 changes: 1 addition & 1 deletion ...java/com/sap/cloud/sdk/datamodel/openapi/generator/DataModelGeneratorIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ private enum TestCase
"sodastore.yaml",
"test",
"test",
ApiMaturity.RELEASED,
ApiMaturity.BETA,
true,
true,
8,
Expand Down
7 changes: 4 additions & 3 deletions ...sources/DataModelGeneratorIntegrationTest/oneof-interfaces-enabled/output/test/AllOf.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -31,14 +31,15 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* AllOf
*/
// CHECKSTYLE:OFF

@Beta// CHECKSTYLE:OFF
public class AllOf
// CHECKSTYLE:ON
{
Expand Down
7 changes: 4 additions & 3 deletions ...sources/DataModelGeneratorIntegrationTest/oneof-interfaces-enabled/output/test/AnyOf.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -33,14 +33,15 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* AnyOf
*/
// CHECKSTYLE:OFF

@Beta// CHECKSTYLE:OFF
public class AnyOf
// CHECKSTYLE:ON
{
Expand Down
7 changes: 4 additions & 3 deletions ...esources/DataModelGeneratorIntegrationTest/oneof-interfaces-enabled/output/test/Cola.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -34,14 +34,15 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* Cola
*/
// CHECKSTYLE:OFF

@Beta// CHECKSTYLE:OFF
public class Cola implements OneOf, OneOfWithDiscriminator, OneOfWithDiscriminatorAndMapping
// CHECKSTYLE:ON
{
Expand Down
3 changes: 2 additions & 1 deletion ...es/DataModelGeneratorIntegrationTest/oneof-interfaces-enabled/output/test/DefaultApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

package test;
Expand Down Expand Up @@ -36,6 +36,7 @@
*
* API for managing sodas in a soda store
*/
@Beta
public class DefaultApi extends AbstractOpenApiService {
/**
* Instantiates this API class to invoke operations on the Soda Store API.
Expand Down
7 changes: 4 additions & 3 deletions ...sources/DataModelGeneratorIntegrationTest/oneof-interfaces-enabled/output/test/Fanta.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -34,14 +34,15 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* Fanta
*/
// CHECKSTYLE:OFF

@Beta// CHECKSTYLE:OFF
public class Fanta implements OneOf, OneOfWithDiscriminator, OneOfWithDiscriminatorAndMapping
// CHECKSTYLE:ON
{
Expand Down
5 changes: 3 additions & 2 deletions ...sources/DataModelGeneratorIntegrationTest/oneof-interfaces-enabled/output/test/OneOf.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -36,13 +36,14 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* OneOf
*/
@Beta
Copy link
Contributor Author

@newtork newtork Jan 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Comment)

This annotation was not generated before.

@JsonTypeInfo(use = JsonTypeInfo.Id.DEDUCTION)
@JsonSubTypes({
@JsonSubTypes.Type(value = Cola.class),
Expand Down
5 changes: 3 additions & 2 deletions ...GeneratorIntegrationTest/oneof-interfaces-enabled/output/test/OneOfWithDiscriminator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -36,13 +36,14 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* OneOfWithDiscriminator
*/
@Beta
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "sodaType", visible = true)
@JsonSubTypes({
@JsonSubTypes.Type(value = Cola.class, name = "Cola"),
Expand Down
5 changes: 3 additions & 2 deletions ...ntegrationTest/oneof-interfaces-enabled/output/test/OneOfWithDiscriminatorAndMapping.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
* Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
*/

/*
Expand Down Expand Up @@ -36,13 +36,14 @@
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;

import com.google.common.annotations.Beta;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
* OneOfWithDiscriminatorAndMapping
*/
@Beta
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "sodaType", visible = true)
@JsonSubTypes({
@JsonSubTypes.Type(value = Cola.class, name = "cool_cola"),
Expand Down
Loading