1// Copyright 2015 go-swagger maintainers
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//    http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package spec
16
17import (
18	"encoding/json"
19	"strings"
20
21	"github.com/go-openapi/jsonpointer"
22	"github.com/go-openapi/swag"
23)
24
25const (
26	jsonArray = "array"
27)
28
29// HeaderProps describes a response header
30type HeaderProps struct {
31	Description string `json:"description,omitempty"`
32}
33
34// Header describes a header for a response of the API
35//
36// For more information: http://goo.gl/8us55a#headerObject
37type Header struct {
38	CommonValidations
39	SimpleSchema
40	VendorExtensible
41	HeaderProps
42}
43
44// ResponseHeader creates a new header instance for use in a response
45func ResponseHeader() *Header {
46	return new(Header)
47}
48
49// WithDescription sets the description on this response, allows for chaining
50func (h *Header) WithDescription(description string) *Header {
51	h.Description = description
52	return h
53}
54
55// Typed a fluent builder method for the type of parameter
56func (h *Header) Typed(tpe, format string) *Header {
57	h.Type = tpe
58	h.Format = format
59	return h
60}
61
62// CollectionOf a fluent builder method for an array item
63func (h *Header) CollectionOf(items *Items, format string) *Header {
64	h.Type = jsonArray
65	h.Items = items
66	h.CollectionFormat = format
67	return h
68}
69
70// WithDefault sets the default value on this item
71func (h *Header) WithDefault(defaultValue interface{}) *Header {
72	h.Default = defaultValue
73	return h
74}
75
76// WithMaxLength sets a max length value
77func (h *Header) WithMaxLength(max int64) *Header {
78	h.MaxLength = &max
79	return h
80}
81
82// WithMinLength sets a min length value
83func (h *Header) WithMinLength(min int64) *Header {
84	h.MinLength = &min
85	return h
86}
87
88// WithPattern sets a pattern value
89func (h *Header) WithPattern(pattern string) *Header {
90	h.Pattern = pattern
91	return h
92}
93
94// WithMultipleOf sets a multiple of value
95func (h *Header) WithMultipleOf(number float64) *Header {
96	h.MultipleOf = &number
97	return h
98}
99
100// WithMaximum sets a maximum number value
101func (h *Header) WithMaximum(max float64, exclusive bool) *Header {
102	h.Maximum = &max
103	h.ExclusiveMaximum = exclusive
104	return h
105}
106
107// WithMinimum sets a minimum number value
108func (h *Header) WithMinimum(min float64, exclusive bool) *Header {
109	h.Minimum = &min
110	h.ExclusiveMinimum = exclusive
111	return h
112}
113
114// WithEnum sets a the enum values (replace)
115func (h *Header) WithEnum(values ...interface{}) *Header {
116	h.Enum = append([]interface{}{}, values...)
117	return h
118}
119
120// WithMaxItems sets the max items
121func (h *Header) WithMaxItems(size int64) *Header {
122	h.MaxItems = &size
123	return h
124}
125
126// WithMinItems sets the min items
127func (h *Header) WithMinItems(size int64) *Header {
128	h.MinItems = &size
129	return h
130}
131
132// UniqueValues dictates that this array can only have unique items
133func (h *Header) UniqueValues() *Header {
134	h.UniqueItems = true
135	return h
136}
137
138// AllowDuplicates this array can have duplicates
139func (h *Header) AllowDuplicates() *Header {
140	h.UniqueItems = false
141	return h
142}
143
144// MarshalJSON marshal this to JSON
145func (h Header) MarshalJSON() ([]byte, error) {
146	b1, err := json.Marshal(h.CommonValidations)
147	if err != nil {
148		return nil, err
149	}
150	b2, err := json.Marshal(h.SimpleSchema)
151	if err != nil {
152		return nil, err
153	}
154	b3, err := json.Marshal(h.HeaderProps)
155	if err != nil {
156		return nil, err
157	}
158	return swag.ConcatJSON(b1, b2, b3), nil
159}
160
161// UnmarshalJSON unmarshals this header from JSON
162func (h *Header) UnmarshalJSON(data []byte) error {
163	if err := json.Unmarshal(data, &h.CommonValidations); err != nil {
164		return err
165	}
166	if err := json.Unmarshal(data, &h.SimpleSchema); err != nil {
167		return err
168	}
169	if err := json.Unmarshal(data, &h.VendorExtensible); err != nil {
170		return err
171	}
172	return json.Unmarshal(data, &h.HeaderProps)
173}
174
175// JSONLookup look up a value by the json property name
176func (h Header) JSONLookup(token string) (interface{}, error) {
177	if ex, ok := h.Extensions[token]; ok {
178		return &ex, nil
179	}
180
181	r, _, err := jsonpointer.GetForToken(h.CommonValidations, token)
182	if err != nil && !strings.HasPrefix(err.Error(), "object has no field") {
183		return nil, err
184	}
185	if r != nil {
186		return r, nil
187	}
188	r, _, err = jsonpointer.GetForToken(h.SimpleSchema, token)
189	if err != nil && !strings.HasPrefix(err.Error(), "object has no field") {
190		return nil, err
191	}
192	if r != nil {
193		return r, nil
194	}
195	r, _, err = jsonpointer.GetForToken(h.HeaderProps, token)
196	return r, err
197}
198