mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-11-30 07:32:45 +00:00
fc3741365c
* Add Swagger spec test script * Fix Swagger spec errors not related to statuses with polls * Add API tests that post a status with a poll * Fix creating a status with a poll from form params * Fix Swagger spec errors related to statuses with polls (this is the last error) * Fix Swagger spec warnings not related to unused definitions * Suppress a duplicate list update params definition that was somehow causing wrong param names * Add Swagger test to CI - updates Drone config - vendorizes go-swagger - fixes a file extension issue that caused the test script to generate JSON instead of YAML with the vendorized version * Put `Sample: ` on its own line everywhere * Remove unused id param from emojiCategoriesGet * Add 5 more pairs of profile fields to account update API Swagger * Remove Swagger prefix from dummy fields It makes the generated code look weird * Manually annotate params for statusCreate operation * Fix all remaining Swagger spec warnings - Change some models into operation parameters - Ignore models that already correspond to manually documented operation parameters but can't be trivially changed (those with file fields) * Documented that creating a status with scheduled_at isn't implemented yet * sign drone.yml * Fix filter API Swagger errors * fixup! Fix filter API Swagger errors --------- Co-authored-by: tobi <tobi.smethurst@protonmail.com>
185 lines
4.6 KiB
Go
185 lines
4.6 KiB
Go
// Copyright 2015 go-swagger maintainers
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package spec
|
|
|
|
import (
|
|
"encoding/json"
|
|
"strconv"
|
|
"strings"
|
|
|
|
"github.com/go-openapi/jsonpointer"
|
|
"github.com/go-openapi/swag"
|
|
)
|
|
|
|
// Extensions vendor specific extensions
|
|
type Extensions map[string]interface{}
|
|
|
|
// Add adds a value to these extensions
|
|
func (e Extensions) Add(key string, value interface{}) {
|
|
realKey := strings.ToLower(key)
|
|
e[realKey] = value
|
|
}
|
|
|
|
// GetString gets a string value from the extensions
|
|
func (e Extensions) GetString(key string) (string, bool) {
|
|
if v, ok := e[strings.ToLower(key)]; ok {
|
|
str, ok := v.(string)
|
|
return str, ok
|
|
}
|
|
return "", false
|
|
}
|
|
|
|
// GetInt gets a int value from the extensions
|
|
func (e Extensions) GetInt(key string) (int, bool) {
|
|
realKey := strings.ToLower(key)
|
|
|
|
if v, ok := e.GetString(realKey); ok {
|
|
if r, err := strconv.Atoi(v); err == nil {
|
|
return r, true
|
|
}
|
|
}
|
|
|
|
if v, ok := e[realKey]; ok {
|
|
if r, rOk := v.(float64); rOk {
|
|
return int(r), true
|
|
}
|
|
}
|
|
return -1, false
|
|
}
|
|
|
|
// GetBool gets a string value from the extensions
|
|
func (e Extensions) GetBool(key string) (bool, bool) {
|
|
if v, ok := e[strings.ToLower(key)]; ok {
|
|
str, ok := v.(bool)
|
|
return str, ok
|
|
}
|
|
return false, false
|
|
}
|
|
|
|
// GetStringSlice gets a string value from the extensions
|
|
func (e Extensions) GetStringSlice(key string) ([]string, bool) {
|
|
if v, ok := e[strings.ToLower(key)]; ok {
|
|
arr, isSlice := v.([]interface{})
|
|
if !isSlice {
|
|
return nil, false
|
|
}
|
|
var strs []string
|
|
for _, iface := range arr {
|
|
str, isString := iface.(string)
|
|
if !isString {
|
|
return nil, false
|
|
}
|
|
strs = append(strs, str)
|
|
}
|
|
return strs, ok
|
|
}
|
|
return nil, false
|
|
}
|
|
|
|
// VendorExtensible composition block.
|
|
type VendorExtensible struct {
|
|
Extensions Extensions
|
|
}
|
|
|
|
// AddExtension adds an extension to this extensible object
|
|
func (v *VendorExtensible) AddExtension(key string, value interface{}) {
|
|
if value == nil {
|
|
return
|
|
}
|
|
if v.Extensions == nil {
|
|
v.Extensions = make(map[string]interface{})
|
|
}
|
|
v.Extensions.Add(key, value)
|
|
}
|
|
|
|
// MarshalJSON marshals the extensions to json
|
|
func (v VendorExtensible) MarshalJSON() ([]byte, error) {
|
|
toser := make(map[string]interface{})
|
|
for k, v := range v.Extensions {
|
|
lk := strings.ToLower(k)
|
|
if strings.HasPrefix(lk, "x-") {
|
|
toser[k] = v
|
|
}
|
|
}
|
|
return json.Marshal(toser)
|
|
}
|
|
|
|
// UnmarshalJSON for this extensible object
|
|
func (v *VendorExtensible) UnmarshalJSON(data []byte) error {
|
|
var d map[string]interface{}
|
|
if err := json.Unmarshal(data, &d); err != nil {
|
|
return err
|
|
}
|
|
for k, vv := range d {
|
|
lk := strings.ToLower(k)
|
|
if strings.HasPrefix(lk, "x-") {
|
|
if v.Extensions == nil {
|
|
v.Extensions = map[string]interface{}{}
|
|
}
|
|
v.Extensions[k] = vv
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// InfoProps the properties for an info definition
|
|
type InfoProps struct {
|
|
Description string `json:"description,omitempty"`
|
|
Title string `json:"title,omitempty"`
|
|
TermsOfService string `json:"termsOfService,omitempty"`
|
|
Contact *ContactInfo `json:"contact,omitempty"`
|
|
License *License `json:"license,omitempty"`
|
|
Version string `json:"version,omitempty"`
|
|
}
|
|
|
|
// Info object provides metadata about the API.
|
|
// The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
|
|
//
|
|
// For more information: http://goo.gl/8us55a#infoObject
|
|
type Info struct {
|
|
VendorExtensible
|
|
InfoProps
|
|
}
|
|
|
|
// JSONLookup look up a value by the json property name
|
|
func (i Info) JSONLookup(token string) (interface{}, error) {
|
|
if ex, ok := i.Extensions[token]; ok {
|
|
return &ex, nil
|
|
}
|
|
r, _, err := jsonpointer.GetForToken(i.InfoProps, token)
|
|
return r, err
|
|
}
|
|
|
|
// MarshalJSON marshal this to JSON
|
|
func (i Info) MarshalJSON() ([]byte, error) {
|
|
b1, err := json.Marshal(i.InfoProps)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
b2, err := json.Marshal(i.VendorExtensible)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return swag.ConcatJSON(b1, b2), nil
|
|
}
|
|
|
|
// UnmarshalJSON marshal this from JSON
|
|
func (i *Info) UnmarshalJSON(data []byte) error {
|
|
if err := json.Unmarshal(data, &i.InfoProps); err != nil {
|
|
return err
|
|
}
|
|
return json.Unmarshal(data, &i.VendorExtensible)
|
|
}
|