Merge pull request #103 from apivideo/update-response-example

Add missing lines to response example
apivideo · Oct 30, 2024 · e23040b · e23040b
2 parents d9d843f + 2cad02f
commit e23040b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -614,6 +614,7 @@ paths:
                     title: Maths video
                     description: An amazing video explaining the string theory
                     language: en
+                    languageOrigin: api
                     public: false
                     panoramic: false
                     tags:
@@ -1131,6 +1132,7 @@ components:
           description: Returns the language of a video in [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag)
             format. You can set the language during video creation via the API, otherwise
             it is detected automatically.
+          example: en
           type: string
         languageOrigin:
           description: |-
@@ -1141,6 +1143,7 @@ components:
           enum:
           - api
           - auto
+          example: api
           nullable: true
           type: string
         tags:

diff --git a/src/main/java/video/api/uploader/api/models/Video.java b/src/main/java/video/api/uploader/api/models/Video.java
@@ -365,7 +365,7 @@ public Video language(String language) {
      * @return language
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "Returns the language of a video in [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. You can set the language during video creation via the API, otherwise it is detected automatically.")
+    @ApiModelProperty(example = "en", value = "Returns the language of a video in [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format. You can set the language during video creation via the API, otherwise it is detected automatically.")
 
     public String getLanguage() {
         return language;
@@ -388,7 +388,7 @@ public Video languageOrigin(LanguageOriginEnum languageOrigin) {
      * @return languageOrigin
      **/
     @javax.annotation.Nullable
-    @ApiModelProperty(value = "Returns the origin of the last update on the video's `language` attribute.  - `api` means that the last update was requested from the API. - `auto` means that the last update was done automatically by the API.")
+    @ApiModelProperty(example = "api", value = "Returns the origin of the last update on the video's `language` attribute.  - `api` means that the last update was requested from the API. - `auto` means that the last update was done automatically by the API.")
 
     public LanguageOriginEnum getLanguageOrigin() {
         return languageOrigin;