1 /*
2  *  Make.org Core API
3  *  Copyright (C) 2018 Make.org
4  *
5  * This program is free software: you can redistribute it and/or modify
6  *  it under the terms of the GNU Affero General Public License as
7  *  published by the Free Software Foundation, either version 3 of the
8  *  License, or (at your option) any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU Affero General Public License for more details.
14  *
15  *  You should have received a copy of the GNU Affero General Public License
16  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
17  *
18  */
19 
20 package org.make.core.keyword
21 
22 import eu.timepit.refined.types.numeric.NonNegInt
23 import io.circe.Codec
24 import io.circe.generic.semiauto.deriveCodec
25 import io.circe.refined._
26 import io.swagger.annotations.ApiModelProperty
27 import org.make.core.question.QuestionId
28 
29 import scala.annotation.meta.field
30 
31 final case class Keyword(
32   @(ApiModelProperty @field)(dataType = "string", example = "11111111-2222-3333-4444-555555555555", required = true)
33   questionId: QuestionId,
34   key: String,
35   label: String,
36   score: Float,
37   @(ApiModelProperty @field)(dataType = "int", required = true, allowableValues = "range[0, Infinity]")
38   count: NonNegInt,
39   topKeyword: Boolean
40 )
41 
42 object Keyword {
43   implicit val codec: Codec[Keyword] = deriveCodec
44 }