Skip to content

Commit cc25cfc

Browse files
authored
Added Library Manager API
1 parent 5745c64 commit cc25cfc

File tree

10 files changed

+1366
-206
lines changed

10 files changed

+1366
-206
lines changed

cmd/gendoc/docs.go

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -998,6 +998,75 @@ Contains a JSON object with the details of an error.
998998
{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
999999
},
10001000
},
1001+
{
1002+
OperationId: "appSketchAddLibrary",
1003+
Method: http.MethodPut,
1004+
Path: "/v1/apps/{appID}/sketch/libraries/{libRef}",
1005+
Parameters: (*struct {
1006+
ID string `path:"appID" description:"application identifier."`
1007+
LibRef string `path:"libRef" description:"library reference (\"LibraryName\" or \"LibraryName@Version\")."`
1008+
AddDependencies string `query:"add_deps" description:"if set to \"true\", the library's dependencies will be added as well."`
1009+
})(nil),
1010+
CustomSuccessResponse: &CustomResponseDef{
1011+
ContentType: "application/json",
1012+
DataStructure: handlers.SketchAddLibraryResponse{},
1013+
Description: "Successful response",
1014+
StatusCode: http.StatusOK,
1015+
},
1016+
Description: "Adds a library to the App' sketch. The library will be added to the sketch project file. The dependencies of the library may be optionally added as well.",
1017+
Summary: "Adds a library to the App' sketch.",
1018+
Tags: []Tag{ApplicationTag},
1019+
PossibleErrors: []ErrorResponse{
1020+
{StatusCode: http.StatusPreconditionFailed, Reference: "#/components/responses/PreconditionFailed"},
1021+
{StatusCode: http.StatusBadRequest, Reference: "#/components/responses/BadRequest"},
1022+
{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
1023+
},
1024+
},
1025+
{
1026+
OperationId: "appSketchRemoveLibrary",
1027+
Method: http.MethodDelete,
1028+
Path: "/v1/apps/{appID}/sketch/libraries/{libRef}",
1029+
Parameters: (*struct {
1030+
ID string `path:"appID" description:"application identifier."`
1031+
LibRef string `path:"libRef" description:"library reference (\"LibraryName\" or \"LibraryName@Version\")."`
1032+
})(nil),
1033+
CustomSuccessResponse: &CustomResponseDef{
1034+
ContentType: "application/json",
1035+
DataStructure: handlers.SketchRemoveLibraryResponse{},
1036+
Description: "Successful response",
1037+
StatusCode: http.StatusOK,
1038+
},
1039+
Description: "Removes a library from the App' sketch. The library will be removed from the sketch project file.",
1040+
Summary: "Removes a library from the App' sketch.",
1041+
Tags: []Tag{ApplicationTag},
1042+
PossibleErrors: []ErrorResponse{
1043+
{StatusCode: http.StatusPreconditionFailed, Reference: "#/components/responses/PreconditionFailed"},
1044+
{StatusCode: http.StatusBadRequest, Reference: "#/components/responses/BadRequest"},
1045+
{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
1046+
},
1047+
},
1048+
{
1049+
OperationId: "appSketchListLibraries",
1050+
Method: http.MethodGet,
1051+
Path: "/v1/apps/{appID}/sketch/libraries/",
1052+
Parameters: (*struct {
1053+
ID string `path:"appID" description:"application identifier."`
1054+
})(nil),
1055+
CustomSuccessResponse: &CustomResponseDef{
1056+
ContentType: "application/json",
1057+
DataStructure: handlers.SketchListLibraryResponse{},
1058+
Description: "Successful response",
1059+
StatusCode: http.StatusOK,
1060+
},
1061+
Description: "Lists the libraries used in the App' sketch.",
1062+
Summary: "Lists the libraries used in the App' sketch.",
1063+
Tags: []Tag{ApplicationTag},
1064+
PossibleErrors: []ErrorResponse{
1065+
{StatusCode: http.StatusPreconditionFailed, Reference: "#/components/responses/PreconditionFailed"},
1066+
{StatusCode: http.StatusBadRequest, Reference: "#/components/responses/BadRequest"},
1067+
{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
1068+
},
1069+
},
10011070
}
10021071

10031072
for _, op := range operations {

0 commit comments

Comments
 (0)