Documentation ¶
Overview ¶
Copyright 2017 Northern.tech AS
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.
Copyright 2017 Northern.tech AS
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.
Copyright 2017 Northern.tech AS
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.
Index ¶
- Constants
- Variables
- func BuildURL(r *rest.Request, template string, params map[string]string) *url.URL
- func ContainsString(val string, vals []string) bool
- func IsUsageError(e error) bool
- func MakeLink(link_type string, resource string, query url.Values, page, per_page uint64) string
- func MakePageLinkHdrs(r *rest.Request, page, per_page uint64, has_next bool) []string
- func MsgQueryParmInvalid(name string) string
- func MsgQueryParmLimit(name string) string
- func MsgQueryParmMissing(name string) string
- func MsgQueryParmOneOf(name string, allowed []string) string
- func NewUsageError(msg string) error
- func ParsePagination(r *rest.Request) (uint64, uint64, error)
- func ParseQueryParmStr(r *rest.Request, name string, required bool, allowed []string) (string, error)
- func ParseQueryParmUInt(r *rest.Request, name string, required bool, min, max, def uint64) (uint64, error)
- type UsageError
Constants ¶
View Source
const ( PageName = "page" PerPageName = "per_page" PageMin = 1 PageDefault = 1 PerPageMin = 1 PerPageMax = 500 PerPageDefault = 20 LinkHdr = "Link" LinkTmpl = "<%s?%s>; rel=\"%s\"" LinkPrev = "prev" LinkNext = "next" LinkFirst = "first" DefaultScheme = "http" )
pagination constants
View Source
const ( StatusName = "status" StatusPending = "pending" StatusRejected = "rejected" StatusAccepted = "accepted" )
dev status constants
Variables ¶
View Source
var DevStatuses = []string{StatusPending, StatusRejected, StatusAccepted}
Functions ¶
func BuildURL ¶
build URL using request 'r' and template, replace path params with elements from 'params' using lexical match as in strings.Replace()
func ContainsString ¶
Check if string is presnt in an array. Would use interface{} but whatever.
func IsUsageError ¶
func MakePageLinkHdrs ¶
func MsgQueryParmLimit ¶
func MsgQueryParmMissing ¶
func MsgQueryParmOneOf ¶
func NewUsageError ¶
func ParsePagination ¶
pagination helpers
func ParseQueryParmStr ¶
Types ¶
type UsageError ¶
type UsageError struct {
UserMsg string
}
func (*UsageError) Error ¶
func (e *UsageError) Error() string
Click to show internal directories.
Click to hide internal directories.