Skip to content

Commit ad67b2e

Browse files
committed
Add description to openAPI spec
1 parent ec22242 commit ad67b2e

File tree

2 files changed

+69
-58
lines changed

2 files changed

+69
-58
lines changed

lib/oapi/oapi.go

Lines changed: 58 additions & 58 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -600,6 +600,7 @@ paths:
600600
required: true
601601
schema:
602602
type: string
603+
description: Instance ID or name
603604
responses:
604605
200:
605606
description: Instance details
@@ -630,6 +631,7 @@ paths:
630631
required: true
631632
schema:
632633
type: string
634+
description: Instance ID or name
633635
responses:
634636
204:
635637
description: Instance deleted
@@ -658,6 +660,7 @@ paths:
658660
required: true
659661
schema:
660662
type: string
663+
description: Instance ID or name
661664
responses:
662665
200:
663666
description: Instance in standby
@@ -696,6 +699,7 @@ paths:
696699
required: true
697700
schema:
698701
type: string
702+
description: Instance ID or name
699703
responses:
700704
200:
701705
description: Instance restored
@@ -738,6 +742,7 @@ paths:
738742
required: true
739743
schema:
740744
type: string
745+
description: Instance ID or name
741746
- name: tail
742747
in: query
743748
required: false
@@ -784,11 +789,13 @@ paths:
784789
required: true
785790
schema:
786791
type: string
792+
description: Instance ID or name
787793
- name: volumeId
788794
in: path
789795
required: true
790796
schema:
791797
type: string
798+
description: Volume ID or name
792799
requestBody:
793800
required: true
794801
content:
@@ -831,11 +838,13 @@ paths:
831838
required: true
832839
schema:
833840
type: string
841+
description: Instance ID or name
834842
- name: volumeId
835843
in: path
836844
required: true
837845
schema:
838846
type: string
847+
description: Volume ID or name
839848
responses:
840849
200:
841850
description: Volume detached
@@ -932,6 +941,7 @@ paths:
932941
required: true
933942
schema:
934943
type: string
944+
description: Volume ID or name
935945
responses:
936946
200:
937947
description: Volume details
@@ -962,6 +972,7 @@ paths:
962972
required: true
963973
schema:
964974
type: string
975+
description: Volume ID or name
965976
responses:
966977
204:
967978
description: Volume deleted

0 commit comments

Comments
 (0)