Skip to content

Adding additional documentation related arttributes to endpoints in controllers. #150

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
merged 3 commits into from
Feb 5, 2020
Merged

Adding additional documentation related arttributes to endpoints in controllers. #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c13d455
Adding additional documentation related arttributes to endpoints in c…
Dec 20, 2019
4f5b9f7
Merge branch 'master' into ValidationAttributes
hippiehunter Jan 7, 2020
423c533
Merge branch 'master' into ValidationAttributes
hippiehunter Feb 5, 2020
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
286 changes: 143 additions & 143 deletions PostManTests.postman_collection.json
View file
Open in desktop

Large diffs are not rendered by default.

42 changes: 34 additions & 8 deletions Services.Controllers/CustomerNotesController.dbl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@
;; Any changes you make will be lost of the file is re-generated.
;;*****************************************************************************

import Microsoft.AspNetCore.Http
import Microsoft.OData
import Microsoft.AspNetCore.JsonPatch
import Microsoft.AspNetCore.Mvc
import Microsoft.AspNet.OData
import Microsoft.AspNet.OData.Routing
import Microsoft.EntityFrameworkCore
import Microsoft.EntityFrameworkCore.Infrastructure
import Microsoft.Extensions.Options
import System.Collections.Generic
import System.ComponentModel.DataAnnotations
import Harmony.Core.EF.Extensions
import Harmony.Core.Interface
Expand All @@ -28,6 +31,7 @@ import Services.Models
namespace Services.Controllers

{ApiVersion("1")}
{ODataRoutePrefix("CustomerNotes")}
;;; <summary>
;;; OData controller for CustomerNotes
;;; </summary>
Expand All @@ -54,7 +58,9 @@ namespace Services.Controllers
this._AppSettings = aAppSettings
endmethod

{ODataRoute("CustomerNotes")}
{ODataRoute}
{Produces("application/json")}
{ProducesResponseType(^typeof(ODataValue<IEnumerable<CustomerNote>>),StatusCodes.Status200OK)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get all CustomerNotes
Expand All @@ -65,7 +71,10 @@ namespace Services.Controllers
mreturn Ok(_DbContext.CustomerNotes.AsNoTracking())
endmethod

{ODataRoute("CustomerNotes(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{Produces("application/json")}
{ProducesResponseType(^typeof(CustomerNote),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get a single CustomerNote by primary key.
Expand All @@ -80,7 +89,9 @@ namespace Services.Controllers
endmethod


{ODataRoute("CustomerNotes({key})/NoteNumber")}
{ODataRoute("({key})/NoteNumber")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the NoteNumber property of a single CustomerNote, by primary key.
;;; </summary>
Expand All @@ -98,7 +109,9 @@ namespace Services.Controllers
mreturn OK(result.NoteNumber)
endmethod

{ODataRoute("CustomerNotes({key})/NoteText")}
{ODataRoute("({key})/NoteText")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the NoteText property of a single CustomerNote, by primary key.
;;; </summary>
Expand All @@ -116,7 +129,10 @@ namespace Services.Controllers
mreturn OK(result.NoteText)
endmethod

{ODataRoute("CustomerNotes")}
{ODataRoute}
{Produces("application/json")}
{ProducesResponseType(^typeof(CustomerNote),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status400BadRequest)}
;;; <summary>
;;; Create a new customerNote (automatically assigned primary key).
;;; </summary>
Expand Down Expand Up @@ -153,7 +169,11 @@ namespace Services.Controllers

endmethod

{ODataRoute("CustomerNotes(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{Produces("application/json")}
{ProducesResponseType(StatusCodes.Status201Created)}
{ProducesResponseType(StatusCodes.Status400BadRequest)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Create (with a client-supplied primary key) or replace a customerNote.
;;; </summary>
Expand Down Expand Up @@ -202,7 +222,11 @@ namespace Services.Controllers

endmethod

{ODataRoute("CustomerNotes(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{Produces("application/json")}
{ProducesResponseType(StatusCodes.Status204NoContent)}
{ProducesResponseType(StatusCodes.Status400BadRequest)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Patch (partial update) a customerNote.
;;; </summary>
Expand Down Expand Up @@ -253,7 +277,9 @@ namespace Services.Controllers

endmethod

{ODataRoute("CustomerNotes(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{ProducesResponseType(StatusCodes.Status204NoContent)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Delete a customerNote.
;;; </summary>
Expand Down
97 changes: 76 additions & 21 deletions Services.Controllers/CustomersController.dbl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@
;; Any changes you make will be lost of the file is re-generated.
;;*****************************************************************************

import Microsoft.AspNetCore.Http
import Microsoft.OData
import Microsoft.AspNetCore.JsonPatch
import Microsoft.AspNetCore.Mvc
import Microsoft.AspNet.OData
import Microsoft.AspNet.OData.Routing
import Microsoft.EntityFrameworkCore
import Microsoft.EntityFrameworkCore.Infrastructure
import Microsoft.Extensions.Options
import System.Collections.Generic
import System.ComponentModel.DataAnnotations
import Harmony.Core.EF.Extensions
import Harmony.Core.Interface
Expand All @@ -28,6 +31,7 @@ import Services.Models
namespace Services.Controllers

{ApiVersion("1")}
{ODataRoutePrefix("Customers")}
;;; <summary>
;;; OData controller for Customers
;;; </summary>
Expand All @@ -54,7 +58,9 @@ namespace Services.Controllers
this._AppSettings = aAppSettings
endmethod

{ODataRoute("Customers")}
{ODataRoute}
{Produces("application/json")}
{ProducesResponseType(^typeof(ODataValue<IEnumerable<Customer>>),StatusCodes.Status200OK)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get all Customers
Expand All @@ -65,7 +71,10 @@ namespace Services.Controllers
mreturn Ok(_DbContext.Customers.AsNoTracking())
endmethod

{ODataRoute("Customers(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{Produces("application/json")}
{ProducesResponseType(^typeof(Customer),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get a single Customer by primary key.
Expand All @@ -79,7 +88,10 @@ namespace Services.Controllers
mreturn new SingleResult<Customer>(_DbContext.Customers.AsNoTracking().FindQuery<Customer>(_DbContext, aCustomerNumber))
endmethod

{ODataRoute("Customers(State={aState})")}
{ODataRoute("(State={aState})")}
{Produces("application/json")}
{ProducesResponseType(^typeof(ODataValue<IEnumerable<Customer>>),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get customers by alternate key key State.
Expand All @@ -96,7 +108,10 @@ namespace Services.Controllers
mreturn Ok(result)
endmethod

{ODataRoute("Customers(ZipCode={aZipCode})")}
{ODataRoute("(ZipCode={aZipCode})")}
{Produces("application/json")}
{ProducesResponseType(^typeof(ODataValue<IEnumerable<Customer>>),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get customers by alternate key key Zip.
Expand All @@ -113,7 +128,10 @@ namespace Services.Controllers
mreturn Ok(result)
endmethod

{ODataRoute("Customers(PaymentTermsCode={aPaymentTermsCode})")}
{ODataRoute("(PaymentTermsCode={aPaymentTermsCode})")}
{Produces("application/json")}
{ProducesResponseType(^typeof(ODataValue<IEnumerable<Customer>>),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
{EnableQuery(MaxExpansionDepth=4)}
;;; <summary>
;;; Get customers by alternate key key PaymentTerms.
Expand All @@ -131,7 +149,9 @@ namespace Services.Controllers
endmethod


{ODataRoute("Customers({key})/Name")}
{ODataRoute("({key})/Name")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the Name property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -149,7 +169,9 @@ namespace Services.Controllers
mreturn OK(result.Name)
endmethod

{ODataRoute("Customers({key})/Street")}
{ODataRoute("({key})/Street")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the Street property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -167,7 +189,9 @@ namespace Services.Controllers
mreturn OK(result.Street)
endmethod

{ODataRoute("Customers({key})/City")}
{ODataRoute("({key})/City")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the City property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -185,7 +209,9 @@ namespace Services.Controllers
mreturn OK(result.City)
endmethod

{ODataRoute("Customers({key})/State")}
{ODataRoute("({key})/State")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the State property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -203,7 +229,9 @@ namespace Services.Controllers
mreturn OK(result.State)
endmethod

{ODataRoute("Customers({key})/ZipCode")}
{ODataRoute("({key})/ZipCode")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the ZipCode property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -221,7 +249,9 @@ namespace Services.Controllers
mreturn OK(result.ZipCode)
endmethod

{ODataRoute("Customers({key})/Contact")}
{ODataRoute("({key})/Contact")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the Contact property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -239,7 +269,9 @@ namespace Services.Controllers
mreturn OK(result.Contact)
endmethod

{ODataRoute("Customers({key})/Phone")}
{ODataRoute("({key})/Phone")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the Phone property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -257,7 +289,9 @@ namespace Services.Controllers
mreturn OK(result.Phone)
endmethod

{ODataRoute("Customers({key})/Fax")}
{ODataRoute("({key})/Fax")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the Fax property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -275,7 +309,9 @@ namespace Services.Controllers
mreturn OK(result.Fax)
endmethod

{ODataRoute("Customers({key})/FavoriteItem")}
{ODataRoute("({key})/FavoriteItem")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the FavoriteItem property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -293,7 +329,9 @@ namespace Services.Controllers
mreturn OK(result.FavoriteItem)
endmethod

{ODataRoute("Customers({key})/PaymentTermsCode")}
{ODataRoute("({key})/PaymentTermsCode")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the PaymentTermsCode property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -311,7 +349,9 @@ namespace Services.Controllers
mreturn OK(result.PaymentTermsCode)
endmethod

{ODataRoute("Customers({key})/TaxId")}
{ODataRoute("({key})/TaxId")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the TaxId property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -329,7 +369,9 @@ namespace Services.Controllers
mreturn OK(result.TaxId)
endmethod

{ODataRoute("Customers({key})/CreditLimit")}
{ODataRoute("({key})/CreditLimit")}
{ProducesResponseType(StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Get the CreditLimit property of a single Customer, by primary key.
;;; </summary>
Expand All @@ -347,7 +389,10 @@ namespace Services.Controllers
mreturn OK(result.CreditLimit)
endmethod

{ODataRoute("Customers")}
{ODataRoute}
{Produces("application/json")}
{ProducesResponseType(^typeof(Customer),StatusCodes.Status200OK)}
{ProducesResponseType(StatusCodes.Status400BadRequest)}
;;; <summary>
;;; Create a new customer (automatically assigned primary key).
;;; </summary>
Expand Down Expand Up @@ -384,7 +429,11 @@ namespace Services.Controllers

endmethod

{ODataRoute("Customers(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{Produces("application/json")}
{ProducesResponseType(StatusCodes.Status201Created)}
{ProducesResponseType(StatusCodes.Status400BadRequest)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Create (with a client-supplied primary key) or replace a customer.
;;; </summary>
Expand Down Expand Up @@ -433,7 +482,11 @@ namespace Services.Controllers

endmethod

{ODataRoute("Customers(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{Produces("application/json")}
{ProducesResponseType(StatusCodes.Status204NoContent)}
{ProducesResponseType(StatusCodes.Status400BadRequest)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Patch (partial update) a customer.
;;; </summary>
Expand Down Expand Up @@ -484,7 +537,9 @@ namespace Services.Controllers

endmethod

{ODataRoute("Customers(CustomerNumber={aCustomerNumber})")}
{ODataRoute("(CustomerNumber={aCustomerNumber})")}
{ProducesResponseType(StatusCodes.Status204NoContent)}
{ProducesResponseType(StatusCodes.Status404NotFound)}
;;; <summary>
;;; Delete a customer.
;;; </summary>
Expand Down
Loading