feat: update DC api and readme (#3)

delta · Dec 30, 2022 · 475fb37 · 475fb37
1 parent 9cd40cc
commit 475fb37
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,14 @@
 <h1 align="center">CodeCharacter Server 2023</h1>
 
 <p align="center">
-  <a href="https://github.com/delta/codecharacter-server-2022/actions/workflows/ci.yml">
-    <img src="https://github.com/delta/codecharacter-server-2022/actions/workflows/ci.yml/badge.svg"/>
+  <a href="https://github.com/delta/codecharacter-server-2023/actions/workflows/ci.yml">
+    <img src="https://github.com/delta/codecharacter-server-2023/actions/workflows/ci.yml/badge.svg"/>
   </a>
-  <a href="https://github.com/delta/codecharacter-server-2022/actions/workflows/docs.yml">
-    <img src="https://github.com/delta/codecharacter-server-2022/actions/workflows/docs.yml/badge.svg"/>
+  <a href="https://github.com/delta/codecharacter-server-2023/actions/workflows/docs.yml">
+    <img src="https://github.com/delta/codecharacter-server-2023/actions/workflows/docs.yml/badge.svg"/>
   </a>
-  <a href="https://codecov.io/gh/delta/codecharacter-server-2022">
-    <img src="https://codecov.io/gh/delta/codecharacter-server-2022/branch/main/graph/badge.svg?token=DW315MJFHY"/>
+  <a href="https://codecov.io/gh/delta/codecharacter-server-2023">
+    <img src="https://codecov.io/gh/delta/codecharacter-server-2023/branch/main/graph/badge.svg"/>
   </a>
 </p>
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-# CodeCharacter Server 2022
+# CodeCharacter Server 2023
 
 ### Code Generation Process
 

diff --git a/docs/spec/CodeCharacter-API.yml b/docs/spec/CodeCharacter-API.yml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: CodeCharacter API
-  version: 2022.0.1
+  version: 2023.0.1
   contact:
     name: CodeCharacter Authors
     url: 'https://delta.nitt.edu'
@@ -1808,11 +1808,18 @@ components:
         challName:
           type: string
           example: Daily Challenge 1
+        description:
+          type: string
+          example: Daily Challenge description
         chall:
           type: string
           example: 'print("hello world");'
         challType:
           $ref: '#/components/schemas/ChallengeType'
+        completionStatus:
+          type: boolean
+          example: true
+
       required:
         - challName
         - chall

diff --git a/docs/spec/generator-config.yml b/docs/spec/generator-config.yml
@@ -1,6 +1,6 @@
 apiPackage: delta.codecharacter.core
 artifactId: codecharacter-core
-artifactVersion: 2022.0.1
+artifactVersion: 2023.0.1
 basePackage: delta.codecharacter
 delegatePattern: false
 enumPropertyNaming: UPPERCASE

diff --git a/library/build.gradle.kts b/library/build.gradle.kts
@@ -1,7 +1,7 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 group = "delta.codecharacter"
-version = "2022.0.1"
+version = "2023.0.1"
 
 repositories {
     mavenCentral()

diff --git a/library/src/main/kotlin/delta/codecharacter/SpringDocConfiguration.kt b/library/src/main/kotlin/delta/codecharacter/SpringDocConfiguration.kt
@@ -31,7 +31,7 @@ class SpringDocConfiguration {
                         License()
                             .name("MIT")
                                                 )
-                    .version("2022.0.1")
+                    .version("2023.0.1")
             )
             .components(
                 Components()

diff --git a/library/src/main/kotlin/delta/codecharacter/core/CodeApi.kt b/library/src/main/kotlin/delta/codecharacter/core/CodeApi.kt
@@ -16,9 +16,14 @@ import io.swagger.v3.oas.annotations.media.*
 import io.swagger.v3.oas.annotations.responses.*
 import io.swagger.v3.oas.annotations.security.*
 import org.springframework.http.HttpStatus
+import org.springframework.http.MediaType
 import org.springframework.http.ResponseEntity
+
 import org.springframework.web.bind.annotation.*
 import org.springframework.validation.annotation.Validated
+import org.springframework.web.context.request.NativeWebRequest
+import org.springframework.beans.factory.annotation.Autowired
+
 import jakarta.validation.Valid
 import jakarta.validation.constraints.DecimalMax
 import jakarta.validation.constraints.DecimalMin
@@ -28,7 +33,9 @@ import jakarta.validation.constraints.Min
 import jakarta.validation.constraints.NotNull
 import jakarta.validation.constraints.Pattern
 import jakarta.validation.constraints.Size
+
 import kotlin.collections.List
+import kotlin.collections.Map
 
 @Validated
 @RequestMapping("\${api.base-path:}")

diff --git a/library/src/main/kotlin/delta/codecharacter/dtos/DailyChallengeGetRequestDto.kt b/library/src/main/kotlin/delta/codecharacter/dtos/DailyChallengeGetRequestDto.kt
@@ -19,6 +19,8 @@ import io.swagger.v3.oas.annotations.media.Schema
  * @param challName
  * @param chall
  * @param challType
+ * @param description
+ * @param completionStatus
  */
 data class DailyChallengeGetRequestDto(
 
@@ -30,7 +32,13 @@ data class DailyChallengeGetRequestDto(
 
     @field:Valid
     @Schema(example = "null", required = true, description = "")
-    @field:JsonProperty("challType", required = true) val challType: ChallengeTypeDto
+    @field:JsonProperty("challType", required = true) val challType: ChallengeTypeDto,
+
+    @Schema(example = "Daily Challenge description", description = "")
+    @field:JsonProperty("description") val description: kotlin.String? = null,
+
+    @Schema(example = "true", description = "")
+    @field:JsonProperty("completionStatus") val completionStatus: kotlin.Boolean? = null
 ) {
 
 }