Skip to content

Commit

Permalink
swagger: Remove prefix "I" from all swagger model interfaces
Browse files Browse the repository at this point in the history 
This is to allow generation of the api doc close to the implementation.

Change-Id: Idcbf5da66d1aa267a879ccb4b97f54b1fd687c25
Signed-off-by: Bernd Hufmann <Bernd.Hufmann@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/191918
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Tested-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-by: Patrick Tasse <patrick.tasse@gmail.com>
Reviewed-by: Marco Miller <marco.miller@ericsson.com>
  • Loading branch information
@bhufmann
bhufmann committed Mar 17, 2022
1 parent 364d14d commit d75ef08
Show file tree
Hide file tree
Showing 55 changed files with 216 additions and 218 deletions.
4 changes: 2 additions & 2 deletions ...r/jersey/rest/core/model/IAnnotation.java → ...er/jersey/rest/core/model/Annotation.java
View file
Expand Up @@ -20,7 +20,7 @@
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(description = "An annotation is used to mark an interesting area at a given time or time range")
public interface IAnnotation {
public interface Annotation {

/**
* The annotation types.
Expand Down Expand Up @@ -65,5 +65,5 @@ enum AnnotationType {
* @return The style.
*/
@Nullable
IOutputElementStyle getStyle();
OutputElementStyle getStyle();
}
2 changes: 1 addition & 1 deletion ...ore/model/IAnnotationCategoriesModel.java → ...core/model/AnnotationCategoriesModel.java
View file
Expand Up @@ -20,7 +20,7 @@
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(description = "Model returned by outputs that contains annotation categories available for this output")
public interface IAnnotationCategoriesModel {
public interface AnnotationCategoriesModel {

/**
* @return The annotation categories.
Expand Down
6 changes: 3 additions & 3 deletions ...st/core/model/ITimeGraphTreeResponse.java → ...e/model/AnnotationCategoriesResponse.java
View file
Expand Up @@ -18,12 +18,12 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(allOf = IGenericResponse.class)
public interface ITimeGraphTreeResponse {
@Schema(allOf = GenericResponse.class)
public interface AnnotationCategoriesResponse {

/**
* @return The model.
*/
@Nullable
ITimeGraphTreeModel getModel();
AnnotationCategoriesModel getModel();
}
4 changes: 2 additions & 2 deletions ...sey/rest/core/model/IAnnotationModel.java → ...rsey/rest/core/model/AnnotationModel.java
View file
Expand Up @@ -20,11 +20,11 @@
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(description = "Model returned by outputs that contains annotations per category")
public interface IAnnotationModel {
public interface AnnotationModel {

/**
* @return The annotations per category.
*/
@Schema(description = "Map of annotations where the keys are categories")
Map<String, Collection<IAnnotation>> getAnnotations();
Map<String, Collection<Annotation>> getAnnotations();
}
6 changes: 3 additions & 3 deletions .../rest/core/model/IAnnotationResponse.java → ...y/rest/core/model/AnnotationResponse.java
View file
Expand Up @@ -18,12 +18,12 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(allOf = IGenericResponse.class)
public interface IAnnotationResponse {
@Schema(allOf = GenericResponse.class)
public interface AnnotationResponse {

/**
* @return The model.
*/
@Nullable
IAnnotationModel getModel();
AnnotationModel getModel();
}
6 changes: 3 additions & 3 deletions ...re/model/IAnnotationsQueryParameters.java → ...ore/model/AnnotationsQueryParameters.java
View file
Expand Up @@ -20,19 +20,19 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IAnnotationsQueryParameters {
public interface AnnotationsQueryParameters {

/**
* @return The parameters.
*/
@NonNull
@Schema(required = true)
IAnnotationsParameters getParameters();
AnnotationsParameters getParameters();

/**
* Property names below use underscores as per trace-server protocol.
*/
interface IAnnotationsParameters {
interface AnnotationsParameters {

@JsonProperty("requested_times")
@Schema(required = true)
Expand Down
6 changes: 3 additions & 3 deletions ...st/core/model/IArrowsQueryParameters.java → ...est/core/model/ArrowsQueryParameters.java
View file
Expand Up @@ -20,19 +20,19 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IArrowsQueryParameters {
public interface ArrowsQueryParameters {

/**
* @return The parameters.
*/
@NonNull
@Schema(required = true)
IArrowsParameters getParameters();
ArrowsParameters getParameters();

/**
* Property name(s) below use underscores as per trace-server protocol.
*/
interface IArrowsParameters {
interface ArrowsParameters {

@JsonProperty("requested_times")
@Schema(required = true)
Expand Down
2 changes: 1 addition & 1 deletion ...jersey/rest/core/model/IDataProvider.java → .../jersey/rest/core/model/DataProvider.java
View file
Expand Up @@ -16,7 +16,7 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IDataProvider {
public interface DataProvider {

/**
* The provider types.
Expand Down
2 changes: 1 addition & 1 deletion ...rver/jersey/rest/core/model/IElement.java → ...erver/jersey/rest/core/model/Element.java
View file
Expand Up @@ -19,7 +19,7 @@
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(description = "An element model to be identified")
public interface IElement {
public interface Element {

/**
* The element types.
Expand Down
4 changes: 2 additions & 2 deletions ...r/jersey/rest/core/model/IExperiment.java → ...er/jersey/rest/core/model/Experiment.java
View file
Expand Up @@ -22,7 +22,7 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IExperiment {
public interface Experiment {

/**
* @return The name.
Expand Down Expand Up @@ -65,5 +65,5 @@ public interface IExperiment {
* @return The traces.
*/
@ArraySchema(arraySchema = @Schema(description = "The traces encapsulated by this experiment"))
List<ITrace> getTraces();
List<Trace> getTraces();
}
2 changes: 1 addition & 1 deletion ...ore/model/IExperimentQueryParameters.java → ...core/model/ExperimentQueryParameters.java
View file
Expand Up @@ -22,7 +22,7 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IExperimentQueryParameters {
public interface ExperimentQueryParameters {

/**
* @return The name.
Expand Down
2 changes: 1 addition & 1 deletion ...sey/rest/core/model/IGenericResponse.java → ...rsey/rest/core/model/GenericResponse.java
View file
Expand Up @@ -17,7 +17,7 @@
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(description = "Response that includes the status and a status message")
public interface IGenericResponse {
public interface GenericResponse {

/**
* The statuses.
Expand Down
29 changes: 0 additions & 29 deletions ...incubator/internal/trace/server/jersey/rest/core/model/IAnnotationCategoriesResponse.java
View file

This file was deleted.

29 changes: 0 additions & 29 deletions ...compass/incubator/internal/trace/server/jersey/rest/core/model/IVirtualTableResponse.java
View file

This file was deleted.

6 changes: 3 additions & 3 deletions ...est/core/model/ILinesQueryParameters.java → ...rest/core/model/LinesQueryParameters.java
View file
Expand Up @@ -22,19 +22,19 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface ILinesQueryParameters {
public interface LinesQueryParameters {

/**
* @return The parameters.
*/
@NonNull
@Schema(required = true)
ILinesParameters getParameters();
LinesParameters getParameters();

/**
* Property names below use underscores as per trace-server protocol.
*/
interface ILinesParameters {
interface LinesParameters {

enum Direction {
NEXT, PREVIOUS
Expand Down
2 changes: 1 addition & 1 deletion ...er/jersey/rest/core/model/IMarkerSet.java → ...ver/jersey/rest/core/model/MarkerSet.java
View file
Expand Up @@ -17,7 +17,7 @@
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(description = "A marker set is used to represent a set of annotations that can be fetched")
public interface IMarkerSet {
public interface MarkerSet {

/**
* @return The name.
Expand Down
6 changes: 3 additions & 3 deletions .../rest/core/model/IMarkerSetsResponse.java → ...y/rest/core/model/MarkerSetsResponse.java
View file
Expand Up @@ -20,12 +20,12 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(allOf = IGenericResponse.class)
public interface IMarkerSetsResponse {
@Schema(allOf = GenericResponse.class)
public interface MarkerSetsResponse {

/**
* @return The model.
*/
@Nullable
List<IMarkerSet> getModel();
List<MarkerSet> getModel();
}
6 changes: 3 additions & 3 deletions .../core/model/IOptionalQueryParameters.java → ...t/core/model/OptionalQueryParameters.java
View file
Expand Up @@ -18,18 +18,18 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IOptionalQueryParameters {
public interface OptionalQueryParameters {

/**
* @return The parameters.
*/
@NonNull
@Schema(required = true)
IOptionalParameters getParameters();
OptionalParameters getParameters();

/**
* No expected properties below, as per current trace-server protocol.
*/
interface IOptionalParameters {
interface OptionalParameters {
}
}
2 changes: 1 addition & 1 deletion .../rest/core/model/IOutputElementStyle.java → ...y/rest/core/model/OutputElementStyle.java
View file
Expand Up @@ -23,7 +23,7 @@
@Schema(description = "Represents the style on an element (ex. Entry, TimeGraphState, ...) returned by any output. " +
"Supports style inheritance. " +
"To avoid having too many styles, the element style can have a parent style and will have all the same style property values as the parent, and can add or override style properties.")
public interface IOutputElementStyle {
public interface OutputElementStyle {

/**
* @return The parent key.
Expand Down
4 changes: 2 additions & 2 deletions ...ey/rest/core/model/IOutputStyleModel.java → ...sey/rest/core/model/OutputStyleModel.java
View file
Expand Up @@ -22,11 +22,11 @@
*/
@Schema(description = "Map of styles specific to an output where values give hints on the style. " +
"The keys are strings that can be used in OutputElementStyle")
public interface IOutputStyleModel {
public interface OutputStyleModel {

/**
* @return The styles.
*/
@NonNull
Map<@NonNull String, @NonNull IOutputElementStyle> getStyles();
Map<@NonNull String, @NonNull OutputElementStyle> getStyles();
}
6 changes: 3 additions & 3 deletions ...core/model/IRequestedQueryParameters.java → .../core/model/RequestedQueryParameters.java
View file
Expand Up @@ -20,19 +20,19 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IRequestedQueryParameters {
public interface RequestedQueryParameters {

/**
* @return The parameters.
*/
@NonNull
@Schema(required = true)
IRequestedParameters getParameters();
RequestedParameters getParameters();

/**
* Property names below use underscores as per trace-server protocol.
*/
interface IRequestedParameters {
interface RequestedParameters {

@JsonProperty("requested_times")
@Schema(required = true)
Expand Down
2 changes: 1 addition & 1 deletion .../jersey/rest/core/model/ISeriesModel.java → ...r/jersey/rest/core/model/SeriesModel.java
View file
Expand Up @@ -21,7 +21,7 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface ISeriesModel {
public interface SeriesModel {

/**
* @return The series ID.
Expand Down
2 changes: 1 addition & 1 deletion ...jersey/rest/core/model/IServerStatus.java → .../jersey/rest/core/model/ServerStatus.java
View file
Expand Up @@ -16,7 +16,7 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface IServerStatus {
public interface ServerStatus {

/**
* The statuses.
Expand Down
6 changes: 3 additions & 3 deletions ...rsey/rest/core/model/IStylesResponse.java → ...ersey/rest/core/model/StylesResponse.java
View file
Expand Up @@ -18,12 +18,12 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
@Schema(allOf = IGenericResponse.class)
public interface IStylesResponse {
@Schema(allOf = GenericResponse.class)
public interface StylesResponse {

/**
* @return The model.
*/
@NonNull
IOutputStyleModel getModel();
OutputStyleModel getModel();
}
2 changes: 1 addition & 1 deletion ...y/rest/core/model/ITableColumnHeader.java → ...ey/rest/core/model/TableColumnHeader.java
View file
Expand Up @@ -16,7 +16,7 @@
/**
* Contributes to the model used for TSP swagger-core annotations.
*/
public interface ITableColumnHeader {
public interface TableColumnHeader {

/**
* @return The ID.
Expand Down

0 comments on commit d75ef08

Please sign in to comment.