ProgrammingQuotesApi.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>ProgrammingQuotesApi</name>
    </assembly>
    <members>
        <member name="M:ProgrammingQuotesApi.Controllers.AuthorsController.GetAuthors">
            <summary>
            Returns a list of authors
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.AuthorsController.GetCount">
            <summary>
            Returns total number of authors
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.AuthorsController.GetAuthorDetails(System.String)">
            <summary>
            Returns author details
            </summary>
            <param name="authorName">The name of the author from Wikipedia. For example: Edsger W. Dijkstra</param>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetAll(System.Int32)">
            <summary>
            Returns a list of quotes
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Get(System.String)">
            <summary>
            Returns a quote for a given id
            </summary>
            <remarks>
            For example: 5a6ce86e2af929789500e7e4
            </remarks>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetRandom">
            <summary>
            Returns a random quote
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetCount">
            <summary>
            Returns total number of quotes
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Create(ProgrammingQuotesApi.Models.QuoteCreate)">
            <remarks>
            Don't send quote id, it will be auto-generated.
            </remarks>
            <summary>
            Create new quote
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.GetQuotesByAuthor(System.String)">
            <summary>
            Returns all quotes for a given author
            </summary>
            <param name="authorName">The name of the author from Wikipedia. For example: Edsger W. Dijkstra</param>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Update(ProgrammingQuotesApi.Models.Quote)">
            <summary>
            Replace an existing quote with a new one
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Patch(System.String,Microsoft.AspNetCore.JsonPatch.JsonPatchDocument{ProgrammingQuotesApi.Models.Quote})">
             <remarks>
             Sample request:
            
                 [
                   {
                      "path": "/author",
                      "op": "replace",
                      "value": "Anonymous"
                   }
                 ]
            
             You could use Id: 5a6ce86e2af929789500e7e4
             </remarks>
             <summary>
             Update certain properties of an existing quote
             </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.QuotesController.Delete(System.String)">
            <summary>
            Delete a quote by id
            </summary>
            <remarks>
            For example: 5a6ce86e2af929789500e7e4
            </remarks>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.Create(ProgrammingQuotesApi.Models.UserRegister)">
            <summary>
            Create a new user
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.Authenticate(ProgrammingQuotesApi.Models.UserAuthRequest)">
             <summary>
             Authenticates an existing user
             </summary>
             <remarks>
             Sample request:
            
                 {
                    "username": "admin",
                    "password": "admin"
                 }
            
             </remarks>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.GetAll">
            <summary>
            Returns all users
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.GetByUsername(System.String)">
            <summary>
            Returns a user data for a given username
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.Dashboard">
            <summary>
            Admin dashboard 🔒
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.GetMyUser">
            <summary>
            Returns my user details 🔒
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.Update(ProgrammingQuotesApi.Models.UserUpdate)">
            <summary>
            Replace my old user data with a new one 🔒
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.Patch(Microsoft.AspNetCore.JsonPatch.JsonPatchDocument{ProgrammingQuotesApi.Models.User})">
             <remarks>
             Sample request:
            
                 [
                   {
                      "path": "/firstName",
                      "op": "replace",
                      "value": "Master"
                   }
                 ]
            
             </remarks>
             <summary>
             Update certain properties of my user 🔒
             </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.Delete(System.Int32)">
            <summary>
            Delete a user by id 🔒
            </summary>
        </member>
        <member name="M:ProgrammingQuotesApi.Controllers.UsersController.addFavorite(System.String)">
            <summary>
            Add favorite quote 🔒
            </summary>
            <remarks>
            For example: "5a6ce86e2af929789500e7e4"
            </remarks>
        </member>
    </members>
</doc>