Ombi/Ombi.UI/Modules/ApiRequestMetadataModule.cs

#region Copyright
// /************************************************************************
//    Copyright (c) 2016 Jamie Rees
//    File: ApiRequestMetadataModule.cs
//    Created By: Jamie Rees
//   
//    Permission is hereby granted, free of charge, to any person obtaining
//    a copy of this software and associated documentation files (the
//    "Software"), to deal in the Software without restriction, including
//    without limitation the rights to use, copy, modify, merge, publish,
//    distribute, sublicense, and/or sell copies of the Software, and to
//    permit persons to whom the Software is furnished to do so, subject to
//    the following conditions:
//   
//    The above copyright notice and this permission notice shall be
//    included in all copies or substantial portions of the Software.
//   
//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
//    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
//    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
//    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
//    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//  ************************************************************************/
#endregion

using System.Collections.Generic;
using Nancy.Metadata.Modules;
using Nancy.Swagger;
using Ombi.Store;
using Ombi.UI.Models;
using Ombi.UI.Models.UserManagement;

namespace Ombi.UI.Modules
{
    public class ApiRequestMetadataModule: MetadataModule<SwaggerRouteData>
    {
        public ApiRequestMetadataModule()
        {
            Describe["GetRequests"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/requests");
                with.Summary("The list of requests");

                with.Notes("This returns a list of requests");
                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
                with.Model<ApiModel<List<RequestedModel>>>();
            });

            Describe["GetRequest"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/requests/{id}");
                with.Summary("Get's a single request");

                with.Notes("This returns a single request");
                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
                with.PathParam<int>("id");
                with.Model<ApiModel<List<RequestedModel>>>();
            });

            Describe["PostRequests"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/requests");
                with.Summary("Create a new request");
                with.Model<ApiModel<bool>>();
                with.BodyParam<RequestedModel>("The request", true);
                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
                with.Notes("Creates a new request");
            });

            Describe["PutRequests"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/requests");
                with.Summary("Updates an existing request");
                with.Model<ApiModel<bool>>();
                with.BodyParam<RequestedModel>("The request", true);
                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
                with.Notes("Updates an existing request e.g. Add a issue to the request");
            });

            Describe["DeleteRequests"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/requests/{id}");
                with.Summary("Deletes an existing request");
                with.Model<ApiModel<bool>>();
                with.PathParam<int>("id", required:true);
                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
                with.Notes("Deletes an existing request. If the request doesn't exist we will return an error.");
            });

            Describe["GetApiKey"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/apikey");
                with.Summary("Gets the Api Key for Ombi");
                with.Model<ApiModel<string>>();
                with.QueryParam<string>("username", required:true );
                with.QueryParam<string>("password", required: true );
                with.Notes("Get's the current api key for the application");
            });

            Describe["PutCredentials"] = description => description.AsSwagger(with =>
            {
                with.ResourcePath("/credentials/{username}");
                with.Summary("Sets a new password for the user");
                with.Model<ApiModel<string>>();
                with.PathParam<int>("username", required:true);
                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
                with.BodyParam<UserUpdateViewModel>("User update view model", true);
                with.Notes("Sets a new password for the user");
            });

        }
    }
}