Merge pull request #101 from apivideo/add-summary-feature-docs

Add summary feature
apivideo · Oct 23, 2024 · 66b5434 · 66b5434
2 parents 7a847b8 + 7104c90
commit 66b5434
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 12 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -1023,12 +1023,16 @@ components:
     not-found:
       properties:
         type:
+          description: A link to the error documentation.
           type: string
         title:
+          description: A description of the error that occurred.
           type: string
         name:
+          description: The name of the parameter that caused the error.
           type: string
         status:
+          description: The HTTP status code.
           type: integer
       title: NotFound
       type: object

diff --git a/docs/NotFound.md b/docs/NotFound.md
@@ -6,10 +6,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** |  |  [optional]
-**title** | **String** |  |  [optional]
-**name** | **String** |  |  [optional]
-**status** | **Integer** |  |  [optional]
+**type** | **String** | A link to the error documentation. |  [optional]
+**title** | **String** | A description of the error that occurred. |  [optional]
+**name** | **String** | The name of the parameter that caused the error. |  [optional]
+**status** | **Integer** | The HTTP status code. |  [optional]
 
 
 ## Implemented Interfaces

diff --git a/src/main/java/video/api/uploader/api/models/NotFound.java b/src/main/java/video/api/uploader/api/models/NotFound.java
@@ -52,12 +52,12 @@ public NotFound type(String type) {
     }
 
     /**
-     * Get type
+     * A link to the error documentation.
      * 
      * @return type
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "")
+    @ApiModelProperty(value = "A link to the error documentation.")
 
     public String getType() {
         return type;
@@ -73,12 +73,12 @@ public NotFound title(String title) {
     }
 
     /**
-     * Get title
+     * A description of the error that occurred.
      * 
      * @return title
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "")
+    @ApiModelProperty(value = "A description of the error that occurred.")
 
     public String getTitle() {
         return title;
@@ -94,12 +94,12 @@ public NotFound name(String name) {
     }
 
     /**
-     * Get name
+     * The name of the parameter that caused the error.
      * 
      * @return name
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "")
+    @ApiModelProperty(value = "The name of the parameter that caused the error.")
 
     public String getName() {
         return name;
@@ -115,12 +115,12 @@ public NotFound status(Integer status) {
     }
 
     /**
-     * Get status
+     * The HTTP status code.
      * 
      * @return status
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "")
+    @ApiModelProperty(value = "The HTTP status code.")
 
     public Integer getStatus() {
         return status;