added documentation for query parameters #78

abelsilva · Jul 7, 2017 · 03c216d · 03c216d
1 parent 1783a9a
commit 03c216d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -214,20 +214,20 @@ Note: make sure you add at least the `DataContract` and `DataMember` attributes
 
 ## Attributes
 
-| Attribute | Used in | Description | Options |
-| ---------------------- |------------------------------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------- |
-| `SwaggerWcf` | `Class`, `Interface` | Enable parsing WCF service | `ServicePath` |
-| `SwaggerWcfHidden` | `Class`, `Method`, `Property`, `Parameter` | Hide element from Swagger | |
-| `SwaggerWcfTag` | `Class`, `Method`, `Property`, `Parameter` | Add a tag to an element | `TagName`, `HideFromSpec` |
-| `SwaggerWcfHeader` | `Method` | Configure method HTTP headers | `Name`, `Required`, `Description`, `DefaultValue` |
-| `SwaggerWcfPath` | `Method` | Configure a method in Swagger | `Summary`, `Description`, `OperationId`, `ExternalDocsDescription`, `ExternalDocsUrl`, `Deprecated` |
-| `SwaggerWcfParameter` | `Parameter` | Configure method parameters | `Required`, `Description`   |
-| `SwaggerWcfProperty` | `Property` | Configure property parameters | `Required`, `Description`, `Minimum`, `Maximum`, `Default`, ...  |
-| `SwaggerWcfResponse` | `Method` | Configure method return value | `Code`, `Description`, `EmptyResponseOverride`, `Headers` |
-| `SwaggerWcfDefinition` | `Class` | Configure a data type | `ExternalDocsDescription`, `ExternalDocsUrl` |
-| `SwaggerWcfReturnType` | `Method` | Override method return type | `ReturnType` |
-| `SwaggerWcfContentTypes` | `Method` | Override consume/produce content-types  | `ConsumeTypes`, `ProduceTypes` |
-| `SwaggerWcfSecurity` | `Method` | Add security background to this method | `SecurityDefinitionName`, `params Scopes` |
+| Attribute  | Used in | Description  | Options |
+| ------------------------ |------------------------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------- |
+| `SwaggerWcf`  | `Class`, `Interface` | Enable parsing WCF service  | `ServicePath` |
+| `SwaggerWcfHidden`  | `Class`, `Method`, `Property`, `Parameter` | Hide element from Swagger  | |
+| `SwaggerWcfTag`  | `Class`, `Method`, `Property`, `Parameter` | Add a tag to an element  | `TagName`, `HideFromSpec` |
+| `SwaggerWcfHeader`  | `Method`  | Configure method HTTP headers  | `Name`, `Required`, `Description`, `DefaultValue`  |
+| `SwaggerWcfPath`  | `Method` | Configure a method in Swagger  | `Summary`, `Description`, `OperationId`, `ExternalDocsDescription`, `ExternalDocsUrl`, `Deprecated` |
+| `SwaggerWcfParameter`  | `Parameter` | Configure method parameters   | `Required`, `Description`, `ParameterType` |
+| `SwaggerWcfProperty`  | `Property`  | Configure property parameters  | `Required`, `Description`, `Minimum`, `Maximum`, `Default`, ... |
+| `SwaggerWcfResponse`  | `Method` | Configure method return value  | `Code`, `Description`, `EmptyResponseOverride`, `Headers` |
+| `SwaggerWcfDefinition`  | `Class` | Configure a data type  | `ExternalDocsDescription`, `ExternalDocsUrl` |
+| `SwaggerWcfReturnType`  | `Method` | Override method return type  | `ReturnType`  |
+| `SwaggerWcfContentTypes` | `Method` | Override consume/produce content-types | `ConsumeTypes`, `ProduceTypes`  |
+| `SwaggerWcfSecurity`  | `Method`  | Add security background to this method | `SecurityDefinitionName`, `params Scopes`  |
 
 
 ## Tags
@@ -243,6 +243,15 @@ This will prevent this tag to be displayed in the Swagger output.
 
 When combined with `SwaggerWcfHidden`, if the tag has the value `visible` as `true` in `web.config` file, the element will be visible
 
+## Query Parameter
+
+To specify query parameters to a function you may use the following syntax
+
+```csharp
+[WebGet(UriTemplate = "/books?filter={filter}", BodyStyle = WebMessageBodyStyle.Bare)]
+Book[] ReadBooks(string filter = null);
+```
+
 ## Optional Parameters
 
 To specify a paramter as optional for swagger-ui provide a default value for the parameter on the interface.

diff --git a/src/SwaggerWcf/SwaggerWcf.nuspec b/src/SwaggerWcf/SwaggerWcf.nuspec
@@ -10,7 +10,7 @@
  <projectUrl>https://github.com/abelsilva/swaggerwcf</projectUrl>
  <requireLicenseAcceptance>false</requireLicenseAcceptance>
  <description>$description$</description>
- <releaseNotes>added support for overriding parameter types #78</releaseNotes>
+ <releaseNotes>added support for overriding parameter types #80</releaseNotes>
  <copyright>Copyright 2015</copyright>
  <tags>swagger wcf .net c#</tags>
  </metadata>