github.com/josephspurrier/go-swagger@v0.2.1-0.20221129144919-1f672a142a00/fixtures/goparsing/classification/operations/responses.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 operations

import (
	"github.com/go-openapi/strfmt"
	"github.com/go-swagger/go-swagger/fixtures/goparsing/classification/transitive/mods"
)

// A GenericError is an error that is used when no other error is appropriate
// swagger:response genericError
type GenericError struct {
	// The error message
	// in: body
	Body struct {
		Message string
	}
}

// MyOwnFunc contains a response inside it.
func MyOwnFunc() {
	// SimpleOnesFunc is a collection of SimpleOne
	// swagger:response simpleOnesFunc
	type SimpleOnesFunc struct {
		Ones []*SimpleOne `json:"ones"`
	}
}

// A ValidationError is an error that is used when the required input fails validation.
// swagger:response validationError
type ValidationError struct {
	// in: header
	// enum: foo,bar
	// default: 400
	Code int `json:"code"`

	// The error message
	// in: body
	Body struct {
		// The validation message
		Message string
		// An optional field name to which this validation applies
		FieldName string
	}
}

// A SimpleOne is a model with a few simple fields
type SimpleOne struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
	Age  int32  `json:"age"`
}

// SimpleOnes is a collection of SimpleOne
// swagger:response simpleOnes
type SimpleOnes struct {
	Ones []*SimpleOne `json:"ones"`
}

// A ComplexerOne is composed of a SimpleOne and some extra fields.
// swagger:response complexerOne
type ComplexerOne struct {
	SimpleOne
	mods.NotSelected
	mods.Notable
	CreatedAt strfmt.DateTime `json:"createdAt"`
	NoTagName string          `json:",omitempty"`
}

// A ComplexerPointerOne is composed of a *SimpleOne and some extra fields.
// swagger:response complexerPointerOne
type ComplexerPointerOne struct {
	*SimpleOne
	Extra int64 `json:"extra"`
}

// A SomeResponse is a dummy response object to test parsing.
//
// The properties are the same as the other structs used to test parsing.
//
// swagger:response someResponse
type SomeResponse struct {
	// ID of this some response instance.
	// ids in this application start at 11 and are smaller than 1000
	//
	// minimum: > 10
	// maximum: < 1000
	// default: 11
	ID int64 `json:"id"`

	// The Score of this model
	//
	// minimum: 3
	// maximum: 45
	// multiple of: 3
	// example: 27
	Score int32 `json:"score"`

	// Active state of the record
	//
	// default: true
	Active bool `json:"active"`

	// Name of this some response instance
	//
	// min length: 4
	// max length: 50
	// pattern: [A-Za-z0-9-.]*
	Name string `json:"x-hdr-name"`

	// Created holds the time when this entry was created
	Created strfmt.DateTime `json:"created"`

	// a FooSlice has foos which are strings
	//
	// min items: 3
	// max items: 10
	// unique: true
	// items.minLength: 3
	// items.maxLength: 10
	// items.pattern: \w+
	// items.example: foo
	// collection format: pipe
	FooSlice []string `json:"foo_slice"`

	// a BarSlice has bars which are strings
	//
	// min items: 3
	// max items: 10
	// unique: true
	// items.minItems: 4
	// items.maxItems: 9
	// items.items.minItems: 5
	// items.items.maxItems: 8
	// items.items.items.minLength: 3
	// items.items.items.maxLength: 10
	// items.items.items.pattern: \w+
	// collection format: pipe
	BarSlice [][][]string `json:"bar_slice"`

	// the items for this order
	//
	// in: body
	Items []struct {
		// ID of this some response instance.
		// ids in this application start at 11 and are smaller than 1000
		//
		// required: true
		// minimum: > 10
		// maximum: < 1000
		ID int32 `json:"id"`

		// The Pet to add to this NoModel items bucket.
		// Pets can appear more than once in the bucket
		//
		// required: true
		Pet *mods.Pet `json:"pet"`

		// The amount of pets to add to this bucket.
		//
		// required: true
		// minimum: 1
		// maximum: 10
		Quantity int16 `json:"quantity"`

		// Notes to add to this item.
		// This can be used to add special instructions.
		//
		// required: false
		Notes string `json:"notes"`
	} `json:"items"`
}

type user struct {
	// ID of this some response instance.
	// ids in this application start at 11 and are smaller than 1000
	//
	// required: true
	UserName string `json:"id"`
}

// Resp a response for testing
//
// swagger:response resp
type Resp struct {
	// in: body
	Body *user `json:"user"`

	// swagger:strfmt uuid
	UUID string
}

// File response
//
// swagger:response fileResponse
type FileResponse struct {
	// swagger:file
	// in:  body
	File []byte
}

// Success
// swagger:response GetConfiguration
type GetConfiguration struct {
	// in:body
	Value map[string]string
}

// swagger:response
type NumPlatesResp struct {
	// in: body
	NumPlates interface{} `json:"num_plates"`
}