fineract-provider/src/main/java/org/apache/fineract/infrastructure/dataqueries/api/ReportsApiResourceSwagger.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.fineract.infrastructure.dataqueries.api;

import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Collection;
import java.util.List;
import org.apache.fineract.infrastructure.dataqueries.data.ReportParameterData;

/**
 * Created by sanyam on 4/8/17.
 */
final class ReportsApiResourceSwagger {

    private ReportsApiResourceSwagger() {

    }

    @Schema(description = "GetReportsResponse")
    public static final class GetReportsResponse {

        private GetReportsResponse() {

        }

        @Schema(example = "1")
        public Long id;
        @Schema(example = "Client Listing")
        public String reportName;
        @Schema(example = "Table")
        public String reportType;
        public String reportSubType;
        @Schema(example = "Client")
        public String reportCategory;
        @Schema(example = "Individual Client Report Lists the small number of defined fields on the client table.  Would expect to copy this report and add any one to one additional data for specific tenant needs. Can be run for any size MFI but you expect it only to be run within a branch for larger ones.  Depending on how many columns are displayed, there is probably is a limit of about 20/50k clients returned for html display (export to excel doesnt have that client browser/memory impact).")
        public String description;
        @Schema(example = "")
        public String reportSql;
        @Schema(example = "true")
        public Boolean coreReport;
        @Schema(example = "true")
        public Boolean useReport;
        public Collection<ReportParameterData> reportParameters;

    }

    @Schema(description = "GetReportsTemplateResponse")
    public static final class GetReportsTemplateResponse {

        private GetReportsTemplateResponse() {

        }

        public List<String> allowedReportTypes;
        public List<String> allowedReportSubTypes;
        public Collection<ReportParameterData> allowedParameters;
    }

    @Schema(description = "PostRepostRequest")
    public static final class PostRepostRequest {

        private PostRepostRequest() {

        }

        @Schema(example = "Completely New Report")
        public String reportName;
        @Schema(example = "Table")
        public String reportType;
        @Schema(example = "")
        public String reportSubType;
        @Schema(example = "Loan")
        public String reportCategory;
        @Schema(example = "Just An Example")
        public String description;
        @Schema(example = "select 'very good sql' as AComment")
        public String reportSql;
        public Collection<ReportParameterData> reportParameters;
    }

    @Schema(description = "PostReportsResponse")
    public static final class PostReportsResponse {

        private PostReportsResponse() {

        }

        @Schema(example = "132")
        public long resourceId;
    }

    @Schema(description = "PutReportRequest")
    public static final class PutReportRequest {

        private PutReportRequest() {

        }

        @Schema(example = "Completely New Report")
        public String reportName;
        public Collection<ReportParameterData> reportParameters;

    }

    @Schema(description = "PutReportResponse")
    public static final class PutReportResponse {

        private PutReportResponse() {

        }

        static final class PutReportResponseChanges {

            private PutReportResponseChanges() {

            }

            @Schema(example = "Changed New Report")
            public String reportName;
            public Collection<ReportParameterData> reportParameters;
        }

        @Schema(example = "132")
        public long resourceId;
        public PutReportResponseChanges changes;
    }

    @Schema(description = "DeleteReportsResponse")
    public static final class DeleteReportsResponse {

        private DeleteReportsResponse() {

        }

        @Schema(example = "132")
        public long resourceId;
    }
}