Skip to content

Commit

Permalink
readme updates for release 1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Simon committed Jun 21, 2017
1 parent 7a3619e commit 89956fa
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,17 @@ For defining a resource, a path must be provided. When using a path parameter, i
*/
public class ...
```

When using multiple path parameters, please ensure that the `@format` tag is always given. If you don't want to specify a format, leave the text behind the tag empty. Example:

```java
/**
* @path /type/{id}/{childId}
* @pathParam id @type string @format
* @pathParam childId @type number @format long
*/
public class ...
```

### Operations
An operation must be defined in the same file as its resource! Otherwise the operation will be ignored because it cannot be assigned to a resource.
Expand Down Expand Up @@ -134,3 +145,4 @@ Following section lists some errors that might occure when executing the plugin
</dependencies>
</plugin>
```
If the error persists, you can ignore the whole Java file by placing the following somewhere in the Javadoc comments: `@swagger:ignore_javafile`. This doesn't fix the problem but allows you to still create Swagger for all your other Java files.

0 comments on commit 89956fa

Please sign in to comment.