mirror of
https://github.com/harness/drone.git
synced 2025-05-03 22:23:12 +00:00
116 lines
3.0 KiB
Go
116 lines
3.0 KiB
Go
// Copyright 2021 Harness Inc. All rights reserved.
|
|
// Use of this source code is governed by the Polyform Free Trial License
|
|
// that can be found in the LICENSE.md file for this repository.
|
|
|
|
package openapi
|
|
|
|
import (
|
|
"github.com/harness/gitness/version"
|
|
|
|
"github.com/swaggest/openapi-go/openapi3"
|
|
)
|
|
|
|
type (
|
|
// base request
|
|
baseRequest struct {
|
|
Account string `query:"accountIdentifier"`
|
|
Organization string `query:"orgIdentifier"`
|
|
Project string `query:"projectIdentifier"`
|
|
Routing string `query:"routingId"`
|
|
}
|
|
|
|
// base request for pagination
|
|
paginationRequest struct {
|
|
Page int `query:"page" default:"1"`
|
|
Size int `query:"per_page" default:"100"`
|
|
}
|
|
|
|
// TODO: base response for pagination
|
|
//paginationResponse struct {
|
|
// Total int `header:"x-total"`
|
|
// Pagelen int `header:"x-total-pages"`
|
|
// Page int `header:"x-page"`
|
|
// Size int `header:"x-per-page"`
|
|
// Next int `header:"x-next"`
|
|
// Prev int `header:"x-prev"`
|
|
// Link []string `header:"Link"`
|
|
//}
|
|
)
|
|
|
|
// Handler returns an http.HandlerFunc that writes the openapi v3
|
|
// specification file to the http.Response body.
|
|
// TODO: unused function
|
|
//func Handler() http.HandlerFunc {
|
|
// spec := Generate()
|
|
// yaml, _ := spec.MarshalYAML()
|
|
// json, _ := spec.MarshalJSON()
|
|
//
|
|
// yaml = normalize(yaml)
|
|
// json = normalize(json)
|
|
//
|
|
// return func(w http.ResponseWriter, r *http.Request) {
|
|
// switch {
|
|
// case strings.HasSuffix(r.URL.Path, ".json"):
|
|
// w.Write(json)
|
|
// default:
|
|
// w.Write(yaml)
|
|
// }
|
|
// }
|
|
//}
|
|
|
|
// Generate is a helper function that constructs the
|
|
// openapi specification object, which can be marshaled
|
|
// to json or yaml, as needed.
|
|
func Generate() *openapi3.Spec {
|
|
reflector := openapi3.Reflector{}
|
|
reflector.Spec = &openapi3.Spec{Openapi: "3.0.0"}
|
|
reflector.Spec.Info.
|
|
WithTitle("API Specification").
|
|
WithVersion(version.Version.String())
|
|
|
|
//
|
|
// register endpoints
|
|
//
|
|
|
|
buildAccount(&reflector)
|
|
buildUser(&reflector)
|
|
buildUsers(&reflector)
|
|
|
|
//
|
|
// define security scheme
|
|
//
|
|
|
|
scheme := openapi3.SecuritySchemeOrRef{
|
|
SecurityScheme: &openapi3.SecurityScheme{
|
|
HTTPSecurityScheme: &openapi3.HTTPSecurityScheme{
|
|
Scheme: "bearerAuth",
|
|
Bearer: &openapi3.Bearer{},
|
|
},
|
|
},
|
|
}
|
|
security := openapi3.ComponentsSecuritySchemes{}
|
|
security.WithMapOfSecuritySchemeOrRefValuesItem("bearerAuth", scheme)
|
|
reflector.Spec.Components.WithSecuritySchemes(security)
|
|
|
|
//
|
|
// enforce security scheme globally
|
|
//
|
|
|
|
reflector.Spec.WithSecurity(map[string][]string{
|
|
"bearerAuth": {},
|
|
})
|
|
|
|
return reflector.Spec
|
|
}
|
|
|
|
// helper function normalizes the output to ensure
|
|
// automatically-generated names are more user friendly.
|
|
// TODO: unused function
|
|
//func normalize(data []byte) []byte {
|
|
// data = bytes.ReplaceAll(data, []byte("Types"), []byte(""))
|
|
// data = bytes.ReplaceAll(data, []byte("Openapi"), []byte(""))
|
|
// data = bytes.ReplaceAll(data, []byte("FormData"), []byte(""))
|
|
// data = bytes.ReplaceAll(data, []byte("RenderError"), []byte("Error"))
|
|
// return data
|
|
//}
|