Skip to content

Commit 066b2f7

Browse files
webronwebron
committed
Reformatting
1 parent 945c318 commit 066b2f7

File tree

375 files changed

+17408
-16563
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

375 files changed

+17408
-16563
lines changed

‎modules/swagger-annotations/pom.xml‎

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
3-
<parent>
2+
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
4+
<parent>
5+
<groupId>io.swagger</groupId>
6+
<artifactId>swagger-project</artifactId>
7+
<version>1.5.0-SNAPSHOT</version>
8+
<relativePath>../..</relativePath>
9+
</parent>
10+
<modelVersion>4.0.0</modelVersion>
411
<groupId>io.swagger</groupId>
5-
<artifactId>swagger-project</artifactId>
12+
<artifactId>swagger-annotations</artifactId>
613
<version>1.5.0-SNAPSHOT</version>
7-
<relativePath>../..</relativePath>
8-
</parent>
9-
<modelVersion>4.0.0</modelVersion>
10-
<groupId>io.swagger</groupId>
11-
<artifactId>swagger-annotations</artifactId>
12-
<version>1.5.0-SNAPSHOT</version>
13-
<packaging>bundle</packaging>
14-
<name>swagger-annotations</name>
14+
<packaging>bundle</packaging>
15+
<name>swagger-annotations</name>
1516

16-
<build>
17-
<sourceDirectory>src/main/java</sourceDirectory>
18-
<defaultGoal>install</defaultGoal>
17+
<build>
18+
<sourceDirectory>src/main/java</sourceDirectory>
19+
<defaultGoal>install</defaultGoal>
1920

20-
<plugins>
21-
<plugin>
22-
<groupId>org.apache.felix</groupId>
23-
<artifactId>maven-bundle-plugin</artifactId>
24-
<extensions>true</extensions>
25-
<configuration>
26-
<instructions>
27-
<Export-Package>io.swagger.annotations</Export-Package>
28-
</instructions>
29-
</configuration>
30-
</plugin>
31-
</plugins>
21+
<plugins>
22+
<plugin>
23+
<groupId>org.apache.felix</groupId>
24+
<artifactId>maven-bundle-plugin</artifactId>
25+
<extensions>true</extensions>
26+
<configuration>
27+
<instructions>
28+
<Export-Package>io.swagger.annotations</Export-Package>
29+
</instructions>
30+
</configuration>
31+
</plugin>
32+
</plugins>
3233

33-
</build>
34+
</build>
3435
</project>

‎modules/swagger-annotations/src/main/java/io/swagger/annotations/Api.java‎

Lines changed: 114 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,26 @@
11
/**
2-
* Copyright 2015 SmartBear Software
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License");
5-
* you may not use this file except in compliance with the License.
6-
* You may obtain a copy of the License at
7-
*
8-
* http://www.apache.org/licenses/LICENSE-2.0
9-
*
10-
* Unless required by applicable law or agreed to in writing, software
11-
* distributed under the License is distributed on an "AS IS" BASIS,
12-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13-
* See the License for the specific language governing permissions and
14-
* limitations under the License.
2+
* Copyright 2015 SmartBear Software
3+
* <p/>
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
* <p/>
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
* <p/>
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
1515
*/
1616

1717
package io.swagger.annotations;
1818

19-
import java.lang.annotation.*;
19+
import java.lang.annotation.ElementType;
20+
import java.lang.annotation.Inherited;
21+
import java.lang.annotation.Retention;
22+
import java.lang.annotation.RetentionPolicy;
23+
import java.lang.annotation.Target;
2024

2125

2226
/**
@@ -30,112 +34,109 @@
3034
@Retention(RetentionPolicy.RUNTIME)
3135
@Inherited
3236
public @interface Api {
33-
/**
34-
* Implicitly sets a tag for the operations, legacy support (read description).
35-
* <p>
36-
* In swagger-core 1.3.X, this was used as the 'path' that is to host the API Declaration of the
37-
* resource. This is no longer relevant in swagger-core 1.5.X.
38-
* <p>
39-
* If {@link #tags()} is <i>not</i> used, this value will be used to set the tag for the operations described by this
40-
* resource. Otherwise, the value will be ignored.
41-
* <p>
42-
* The leading / (if exists) will be removed.
43-
*
44-
* @return tag name for operations under this resource, unless {@link #tags()} is defined.
45-
*/
46-
String value() default "";
37+
/**
38+
* Implicitly sets a tag for the operations, legacy support (read description).
39+
* <p>
40+
* In swagger-core 1.3.X, this was used as the 'path' that is to host the API Declaration of the
41+
* resource. This is no longer relevant in swagger-core 1.5.X.
42+
* <p>
43+
* If {@link #tags()} is <i>not</i> used, this value will be used to set the tag for the operations described by this
44+
* resource. Otherwise, the value will be ignored.
45+
* <p>
46+
* The leading / (if exists) will be removed.
47+
*
48+
* @return tag name for operations under this resource, unless {@link #tags()} is defined.
49+
*/
50+
String value() default "";
4751

48-
/**
49-
* A list of tags for API documentation control.
50-
* Tags can be used for logical grouping of operations by resources or any other qualifier.
51-
* <p>
52-
* A non-empty value will override the value provided in {@link #value()}.
53-
*
54-
* @since 1.5.2-M1
55-
*
56-
* @return a string array of tag values
57-
*/
58-
String[] tags() default "";
52+
/**
53+
* A list of tags for API documentation control.
54+
* Tags can be used for logical grouping of operations by resources or any other qualifier.
55+
* <p>
56+
* A non-empty value will override the value provided in {@link #value()}.
57+
*
58+
* @since 1.5.2-M1
59+
*
60+
* @return a string array of tag values
61+
*/
62+
String[] tags() default "";
5963

60-
/**
61-
* Not used in 1.5.X, kept for legacy support.
62-
*
63-
* @return a longer description about this API, no longer used.
64-
*/
65-
@Deprecated
66-
String description() default "";
64+
/**
65+
* Not used in 1.5.X, kept for legacy support.
66+
*
67+
* @return a longer description about this API, no longer used.
68+
*/
69+
@Deprecated String description() default "";
6770

68-
/**
69-
* Not used in 1.5.X, kept for legacy support.
70-
*
71-
* @return the basePath for this operation, no longer used.
72-
*/
73-
@Deprecated
74-
String basePath() default "";
71+
/**
72+
* Not used in 1.5.X, kept for legacy support.
73+
*
74+
* @return the basePath for this operation, no longer used.
75+
*/
76+
@Deprecated String basePath() default "";
7577

76-
/**
77-
* Not used in 1.5.X, kept for legacy support.
78-
*
79-
* @return the position of this API in the resource listing, no longer used.
80-
*/
81-
@Deprecated
82-
int position() default 0;
78+
/**
79+
* Not used in 1.5.X, kept for legacy support.
80+
*
81+
* @return the position of this API in the resource listing, no longer used.
82+
*/
83+
@Deprecated int position() default 0;
8384

84-
/**
85-
* Corresponds to the `produces` field of the operations under this resource.
86-
* <p>
87-
* Takes in comma-separated values of content types.
88-
* For example, "application/json, application/xml" would suggest the operations
89-
* generate JSON and XML output.
90-
* <p>
91-
* For JAX-RS resources, this would automatically take the value of the {@code @Produces}
92-
* annotation if such exists. It can also be used to override the {@code @Produces} values
93-
* for the Swagger documentation.
94-
*
95-
* @return the supported media types supported by the server, or an empty string if not set.
96-
*/
97-
String produces() default "";
85+
/**
86+
* Corresponds to the `produces` field of the operations under this resource.
87+
* <p>
88+
* Takes in comma-separated values of content types.
89+
* For example, "application/json, application/xml" would suggest the operations
90+
* generate JSON and XML output.
91+
* <p>
92+
* For JAX-RS resources, this would automatically take the value of the {@code @Produces}
93+
* annotation if such exists. It can also be used to override the {@code @Produces} values
94+
* for the Swagger documentation.
95+
*
96+
* @return the supported media types supported by the server, or an empty string if not set.
97+
*/
98+
String produces() default "";
9899

99-
/**
100-
* Corresponds to the `consumes` field of the operations under this resource.
101-
* <p>
102-
* Takes in comma-separated values of content types.
103-
* For example, "application/json, application/xml" would suggest the operations
104-
* accept JSON and XML input.
105-
* <p>
106-
* For JAX-RS resources, this would automatically take the value of the {@code @Consumes}
107-
* annotation if such exists. It can also be used to override the {@code @Consumes} values
108-
* for the Swagger documentation.
109-
*
110-
* @return the consumes value, or empty string if not set
111-
*/
112-
String consumes() default "";
100+
/**
101+
* Corresponds to the `consumes` field of the operations under this resource.
102+
* <p>
103+
* Takes in comma-separated values of content types.
104+
* For example, "application/json, application/xml" would suggest the operations
105+
* accept JSON and XML input.
106+
* <p>
107+
* For JAX-RS resources, this would automatically take the value of the {@code @Consumes}
108+
* annotation if such exists. It can also be used to override the {@code @Consumes} values
109+
* for the Swagger documentation.
110+
*
111+
* @return the consumes value, or empty string if not set
112+
*/
113+
String consumes() default "";
113114

114-
/**
115-
* Sets specific protocols (schemes) for the operations under this resource.
116-
* <p>
117-
* Comma-separated values of the available protocols. Possible values: http, https, ws, wss.
118-
*
119-
* @return the protocols supported by the operations under the resource.
120-
*/
121-
String protocols() default "";
115+
/**
116+
* Sets specific protocols (schemes) for the operations under this resource.
117+
* <p>
118+
* Comma-separated values of the available protocols. Possible values: http, https, ws, wss.
119+
*
120+
* @return the protocols supported by the operations under the resource.
121+
*/
122+
String protocols() default "";
122123

123-
/**
124-
* Corresponds to the `security` field of the Operation Object.
125-
* <p>
126-
* Takes in a list of the authorizations (security requirements) for the operations under this resource.
127-
* This may be overridden by specific operations.
128-
*
129-
* @see Authorization
130-
*
131-
* @return an array of authorizations required by the server, or a single, empty authorization value if not set.
132-
*/
133-
Authorization[] authorizations() default @Authorization(value = "");
124+
/**
125+
* Corresponds to the `security` field of the Operation Object.
126+
* <p>
127+
* Takes in a list of the authorizations (security requirements) for the operations under this resource.
128+
* This may be overridden by specific operations.
129+
*
130+
* @see Authorization
131+
*
132+
* @return an array of authorizations required by the server, or a single, empty authorization value if not set.
133+
*/
134+
Authorization[] authorizations() default @Authorization(value = "");
134135

135-
/**
136-
* Hides the operations under this resource.
137-
*
138-
* @return true if the api should be hidden from the swagger documentation
139-
*/
140-
boolean hidden() default false;
136+
/**
137+
* Hides the operations under this resource.
138+
*
139+
* @return true if the api should be hidden from the swagger documentation
140+
*/
141+
boolean hidden() default false;
141142
}

0 commit comments

Comments
 (0)