summaryrefslogtreecommitdiff
path: root/vendor/github.com/google/jsonapi/constants.go
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-05-11 21:12:57 -0600
committermo khan <mo@mokhan.ca>2025-05-11 21:12:57 -0600
commit60440f90dca28e99a31dd328c5f6d5dc0f9b6a2e (patch)
tree2f54adf55086516f162f0a55a5347e6b25f7f176 /vendor/github.com/google/jsonapi/constants.go
parent05ca9b8d3a9c7203a3a3b590beaa400900bd9007 (diff)
chore: vendor go dependencies
Diffstat (limited to 'vendor/github.com/google/jsonapi/constants.go')
-rw-r--r--vendor/github.com/google/jsonapi/constants.go56
1 files changed, 56 insertions, 0 deletions
diff --git a/vendor/github.com/google/jsonapi/constants.go b/vendor/github.com/google/jsonapi/constants.go
new file mode 100644
index 0000000..35bbe05
--- /dev/null
+++ b/vendor/github.com/google/jsonapi/constants.go
@@ -0,0 +1,56 @@
+package jsonapi
+
+const (
+ // StructTag annotation strings
+ annotationJSONAPI = "jsonapi"
+ annotationPrimary = "primary"
+ annotationClientID = "client-id"
+ annotationAttribute = "attr"
+ annotationRelation = "relation"
+ annotationOmitEmpty = "omitempty"
+ annotationISO8601 = "iso8601"
+ annotationRFC3339 = "rfc3339"
+ annotationSeperator = ","
+
+ iso8601TimeFormat = "2006-01-02T15:04:05Z"
+
+ // MediaType is the identifier for the JSON API media type
+ //
+ // see http://jsonapi.org/format/#document-structure
+ MediaType = "application/vnd.api+json"
+
+ // Pagination Constants
+ //
+ // http://jsonapi.org/format/#fetching-pagination
+
+ // KeyFirstPage is the key to the links object whose value contains a link to
+ // the first page of data
+ KeyFirstPage = "first"
+ // KeyLastPage is the key to the links object whose value contains a link to
+ // the last page of data
+ KeyLastPage = "last"
+ // KeyPreviousPage is the key to the links object whose value contains a link
+ // to the previous page of data
+ KeyPreviousPage = "prev"
+ // KeyNextPage is the key to the links object whose value contains a link to
+ // the next page of data
+ KeyNextPage = "next"
+
+ // QueryParamPageNumber is a JSON API query parameter used in a page based
+ // pagination strategy in conjunction with QueryParamPageSize
+ QueryParamPageNumber = "page[number]"
+ // QueryParamPageSize is a JSON API query parameter used in a page based
+ // pagination strategy in conjunction with QueryParamPageNumber
+ QueryParamPageSize = "page[size]"
+
+ // QueryParamPageOffset is a JSON API query parameter used in an offset based
+ // pagination strategy in conjunction with QueryParamPageLimit
+ QueryParamPageOffset = "page[offset]"
+ // QueryParamPageLimit is a JSON API query parameter used in an offset based
+ // pagination strategy in conjunction with QueryParamPageOffset
+ QueryParamPageLimit = "page[limit]"
+
+ // QueryParamPageCursor is a JSON API query parameter used with a cursor-based
+ // strategy
+ QueryParamPageCursor = "page[cursor]"
+)