Skip to content

Commit 66b5434

Browse files
Merge pull request #101 from apivideo/add-summary-feature-docs
Add summary feature
2 parents 7a847b8 + 7104c90 commit 66b5434

File tree

3 files changed

+16
-12
lines changed

3 files changed

+16
-12
lines changed

api/openapi.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,12 +1023,16 @@ components:
10231023
not-found:
10241024
properties:
10251025
type:
1026+
description: A link to the error documentation.
10261027
type: string
10271028
title:
1029+
description: A description of the error that occurred.
10281030
type: string
10291031
name:
1032+
description: The name of the parameter that caused the error.
10301033
type: string
10311034
status:
1035+
description: The HTTP status code.
10321036
type: integer
10331037
title: NotFound
10341038
type: object

docs/NotFound.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
Name | Type | Description | Notes
88
------------ | ------------- | ------------- | -------------
9-
**type** | **String** | | [optional]
10-
**title** | **String** | | [optional]
11-
**name** | **String** | | [optional]
12-
**status** | **Integer** | | [optional]
9+
**type** | **String** | A link to the error documentation. | [optional]
10+
**title** | **String** | A description of the error that occurred. | [optional]
11+
**name** | **String** | The name of the parameter that caused the error. | [optional]
12+
**status** | **Integer** | The HTTP status code. | [optional]
1313

1414

1515
## Implemented Interfaces

src/main/java/video/api/uploader/api/models/NotFound.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,12 @@ public NotFound type(String type) {
5252
}
5353

5454
/**
55-
* Get type
55+
* A link to the error documentation.
5656
*
5757
* @return type
5858
**/
5959
@javax.annotation.Nullable
60-
@ApiModelProperty(value = "")
60+
@ApiModelProperty(value = "A link to the error documentation.")
6161

6262
public String getType() {
6363
return type;
@@ -73,12 +73,12 @@ public NotFound title(String title) {
7373
}
7474

7575
/**
76-
* Get title
76+
* A description of the error that occurred.
7777
*
7878
* @return title
7979
**/
8080
@javax.annotation.Nullable
81-
@ApiModelProperty(value = "")
81+
@ApiModelProperty(value = "A description of the error that occurred.")
8282

8383
public String getTitle() {
8484
return title;
@@ -94,12 +94,12 @@ public NotFound name(String name) {
9494
}
9595

9696
/**
97-
* Get name
97+
* The name of the parameter that caused the error.
9898
*
9999
* @return name
100100
**/
101101
@javax.annotation.Nullable
102-
@ApiModelProperty(value = "")
102+
@ApiModelProperty(value = "The name of the parameter that caused the error.")
103103

104104
public String getName() {
105105
return name;
@@ -115,12 +115,12 @@ public NotFound status(Integer status) {
115115
}
116116

117117
/**
118-
* Get status
118+
* The HTTP status code.
119119
*
120120
* @return status
121121
**/
122122
@javax.annotation.Nullable
123-
@ApiModelProperty(value = "")
123+
@ApiModelProperty(value = "The HTTP status code.")
124124

125125
public Integer getStatus() {
126126
return status;

0 commit comments

Comments
 (0)