📖 Update OpenAPI spec w/ Assessment changes (konveyor#520)

`ArchivedIssue` in the API package being an alias to another type confuses the swag tool. To mitigate this, I had to overwrite the swagger type of that field on the Analysis resource with `object`. This means that the api documentation for that field will be unhelpfully vague, but it allows the documentation to build. Signed-off-by: Sam Lucidi <[email protected]>
aufi · Oct 30, 2023 · d4b1822 · d4b1822
1 parent 71b7379
commit d4b1822
Show file tree

Hide file tree

Showing 6 changed files with 2,761 additions and 310 deletions.
diff --git a/api/analysis.go b/api/analysis.go
@@ -1811,7 +1811,7 @@ type Analysis struct {
 	Archived     bool             `json:"archived,omitempty" yaml:",omitempty"`
 	Issues       []Issue          `json:"issues,omitempty" yaml:",omitempty"`
 	Dependencies []TechDependency `json:"dependencies,omitempty" yaml:",omitempty"`
-	Summary      []ArchivedIssue  `json:"summary,omitempty" yaml:",omitempty"`
+	Summary      []ArchivedIssue  `json:"summary,omitempty" yaml:",omitempty" swaggertype:"object"`
 }
 
 //

diff --git a/api/archetype.go b/api/archetype.go
@@ -45,7 +45,7 @@ func (h ArchetypeHandler) AddRoutes(e *gin.Engine) {
 // @description Get an archetype by ID.
 // @tags archetypes
 // @produce json
-// @success 200 {object} api.Archetypes
+// @success 200 {object} api.Archetype
 // @router /archetypes/{id} [get]
 // @param id path string true "Archetype ID"
 func (h ArchetypeHandler) Get(ctx *gin.Context) {