Nilablity Update w/ Rules (#10)

prebid · Aug 17, 2023 · c35cfb2 · c35cfb2
1 parent 53ac1b9
commit c35cfb2
Show file tree

Hide file tree

Showing 45 changed files with 79 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# openrtb [![Go Reference](https://pkg.go.dev/badge/github.com/prebid/openrtb/v19.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v19) [![Test](https://github.com/prebid/openrtb/actions/workflows/test.yml/badge.svg)](https://github.com/prebid/openrtb/actions/workflows/test.yml)
+# openrtb [![Go Reference](https://pkg.go.dev/badge/github.com/prebid/openrtb/v20.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v20) [![Test](https://github.com/prebid/openrtb/actions/workflows/test.yml/badge.svg)](https://github.com/prebid/openrtb/actions/workflows/test.yml)
 
 [OpenRTB](https://iabtechlab.com/standards/openrtb/), [AdCOM](https://iabtechlab.com/standards/openmedia) and [OpenRTB Dynamic Native Ads](https://iabtechlab.com/standards/openrtb-native/) types for [Go programming language](https://golang.org/)
 
@@ -9,24 +9,24 @@
 
 **Requires Go 1.16+**
 
-This library uses [Go modules](https://golang.org/ref/mod) ([tl;dr](https://blog.golang.org/using-go-modules)) and requires Go [1.16](https://golang.org/doc/go1.16)+ to enable the ability to issue release retractions.
+This library uses [Go modules](https://golang.org/ref/mod) ([tl;dr](https://blog.golang.org/using-go-modules)) and requires Go [1.16](https://golang.org/doc/go1.16)+ for the ability to issue release retractions.
 
 # Using
 
 ```bash
-go get -u "github.com/prebid/openrtb/v19/..."
+go get -u "github.com/prebid/openrtb/v20/..."
 ```
 
 ```go
 import (
-	openrtb2 "github.com/prebid/openrtb/v19/openrtb2"
+	openrtb2 "github.com/prebid/openrtb/v20/openrtb2"
 
-	openrtb3 "github.com/prebid/openrtb/v19/openrtb3"
-	adcom1 "github.com/prebid/openrtb/v19/adcom1"
+	openrtb3 "github.com/prebid/openrtb/v20/openrtb3"
+	adcom1 "github.com/prebid/openrtb/v20/adcom1"
 
-	native1 "github.com/prebid/openrtb/v19/native1"
-	nreq "github.com/prebid/openrtb/v19/native1/request"
-	nres "github.com/prebid/openrtb/v19/native1/response"
+	native1 "github.com/prebid/openrtb/v20/native1"
+	nreq "github.com/prebid/openrtb/v20/native1/request"
+	nres "github.com/prebid/openrtb/v20/native1/response"
 )
 ```
 
@@ -51,19 +51,19 @@ The `main` branch always contains latest code, so better use some package manage
 	- all enums, described in section 5, must be typed with section name singularized (e.g., "5.2 Banner Ad Types" -> `type BannerAdType int8`)
 	- all typed enums must have constants for each element, prefixed with type name (e.g., "5.2 Banner Ad Types - XHTML Text Ad (usually mobile)" -> `const BannerAdTypeXHTMLTextAd BannerAdType = 1`)
 	- never use `iota` for enum constants
-	- OpenRTB (2.x) section "5.1 Content Categories" should remain untyped and have no constants
+	- OpenRTB (2.x) "content categories" should remain untyped and have no constants
 
 ## Pointers/omitempty
 Pointer | Omitempty | When to use                                                          | Example
 ------- | --------- | -------------------------------------------------------------------- | ---------------------------------
- no     | no        | _required_ in spec                                                   | `Audio.mimes`
- yes    | yes       | _required_ in spec, but is a part of mutually-exclusive group        | `Imp.{banner,video,audio,native}`
- no     | yes       | zero value (`""`, `0`) is useless / has no meaning                   | `Device.ua`
- yes    | yes       | zero value (`""`, `0`) or value absence (`null`) has special meaning | `Device.{dnt,lmt}`
+ no     | no        | _required_ in spec                                                   | `Audio.MIMEs`
+ yes    | yes       | _required_ in spec, but is a part of mutually-exclusive group        | `Imp.{Banner,Video,Audio,Native}`
+ no     | yes       | zero value (`""`, `0`) has no meaning, is defined in the spec as the default value, or represents time / duration                    | `Device.UA`
+ yes    | yes       | zero value (`""`, `0`) or value absence (`null`) has special meaning | `Device.{DNT,Lmt}`
 
 Using both pointer and `omitempty` is mostly just to save traffic / generate more "canonical" (strict) JSON.
 
-## Documentation ([pkg.go.dev](https://pkg.go.dev/github.com/prebid/openrtb/v19))
+## Documentation ([pkg.go.dev](https://pkg.go.dev/github.com/prebid/openrtb/v20))
 - [Godoc: documenting Go code](http://blog.golang.org/godoc-documenting-go-code)
 - Each entity (type, struct key or constant) should be documented
 - Ideally, copy-paste descriptions as-is, but feel free to omit section numbers, so just `<GoTypeName> defines <copy-pasted description from spec>`

diff --git a/adcom1/README.md b/adcom1/README.md
@@ -1,3 +1,3 @@
-# adcom1 [![GoDoc](https://godoc.org/github.com/prebid/openrtb/adcom1?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v19/adcom1)
+# adcom1 [![GoDoc](https://godoc.org/github.com/prebid/openrtb/adcom1?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v20/adcom1)
 
 [AdCOM](https://iabtechlab.com/standards/openmedia/) [1.0](https://github.com/InteractiveAdvertisingBureau/AdCOM) types for [Go programming language](https://golang.org/)
diff --git a/adcom1/adcom1_test.go b/adcom1/adcom1_test.go
@@ -8,7 +8,7 @@ import (
 	. "github.com/onsi/ginkgo/extensions/table"
 	. "github.com/onsi/gomega"
 
-	. "github.com/prebid/openrtb/v19/adcom1"
+	. "github.com/prebid/openrtb/v20/adcom1"
 )
 
 var _ = DescribeTable(

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/prebid/openrtb/v19
+module github.com/prebid/openrtb/v20
 
 go 1.16
 

diff --git a/native1/README.md b/native1/README.md
@@ -1,4 +1,4 @@
-# native1 [![GoDoc](https://godoc.org/github.com/prebid/openrtb/native1?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v19/native1)
+# native1 [![GoDoc](https://godoc.org/github.com/prebid/openrtb/native1?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v20/native1)
 
 [OpenRTB Dynamic Native Ads API](https://iabtechlab.com/standards/openrtb-native/) [1.2](https://iabtechlab.com/wp-content/uploads/2016/07/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) section "7 Reference Lists/Enumerations" types for [Go programming language](https://golang.org/)
 

diff --git a/native1/request/README.md b/native1/request/README.md
@@ -1,3 +1,3 @@
-# native1/request [![GoDoc](https://godoc.org/github.com/prebid/openrtb/native1/request?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v19/native1/request)
+# native1/request [![GoDoc](https://godoc.org/github.com/prebid/openrtb/native1/request?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v20/native1/request)
 
 [OpenRTB Dynamic Native Ads API](https://iabtechlab.com/standards/openrtb-native/) [1.2](https://iabtechlab.com/wp-content/uploads/2016/07/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) section "4 Native Ad Request Markup Details" types for [Go programming language](https://golang.org/)
diff --git a/native1/request/data.go b/native1/request/data.go
@@ -3,7 +3,7 @@ package request
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 4.6 Data Object

diff --git a/native1/request/event_tracker.go b/native1/request/event_tracker.go
@@ -3,7 +3,7 @@ package request
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 4.7 Event Trackers Request Object

diff --git a/native1/request/image.go b/native1/request/image.go
@@ -3,7 +3,7 @@ package request
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 4.4 Image Object

diff --git a/native1/request/request.go b/native1/request/request.go
@@ -8,7 +8,7 @@ package request
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 4.1 Native Markup Request Object

diff --git a/native1/request/request_test.go b/native1/request/request_test.go
@@ -5,7 +5,7 @@ import (
 	"io/ioutil"
 	"path/filepath"
 
-	. "github.com/prebid/openrtb/v19/native1/request"
+	. "github.com/prebid/openrtb/v20/native1/request"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/ginkgo/extensions/table"

diff --git a/native1/request/video.go b/native1/request/video.go
@@ -1,7 +1,7 @@
 package request
 
 import (
-	"github.com/prebid/openrtb/v19/openrtb2"
+	"github.com/prebid/openrtb/v20/openrtb2"
 )
 
 // 4.5 Video Object

diff --git a/native1/response/README.md b/native1/response/README.md
@@ -1,3 +1,3 @@
-# native1/response [![GoDoc](https://godoc.org/github.com/prebid/openrtb/native1/response?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v19/native1/response)
+# native1/response [![GoDoc](https://godoc.org/github.com/prebid/openrtb/native1/response?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v20/native1/response)
 
 [OpenRTB Dynamic Native Ads API](https://iabtechlab.com/standards/openrtb-native/) [1.2](https://iabtechlab.com/wp-content/uploads/2016/07/OpenRTB-Native-Ads-Specification-Final-1.2.pdf) section "5 Native Ad Response Markup Details" types for [Go programming language](https://golang.org/)
diff --git a/native1/response/data.go b/native1/response/data.go
@@ -3,7 +3,7 @@ package response
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 5.5 Object: Data

diff --git a/native1/response/event_tracker.go b/native1/response/event_tracker.go
@@ -3,7 +3,7 @@ package response
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 5.8 Event Tracker Response Object

diff --git a/native1/response/image.go b/native1/response/image.go
@@ -3,7 +3,7 @@ package response
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/native1"
+	"github.com/prebid/openrtb/v20/native1"
 )
 
 // 5.4 Object: Image

diff --git a/native1/response/response_test.go b/native1/response/response_test.go
@@ -5,7 +5,7 @@ import (
 	"io/ioutil"
 	"path/filepath"
 
-	. "github.com/prebid/openrtb/v19/native1/response"
+	. "github.com/prebid/openrtb/v20/native1/response"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/ginkgo/extensions/table"

diff --git a/openrtb2/README.md b/openrtb2/README.md
@@ -1,3 +1,3 @@
-# openrtb2 [![GoDoc](https://godoc.org/github.com/prebid/openrtb/openrtb2?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v19/openrtb2)
+# openrtb2 [![GoDoc](https://godoc.org/github.com/prebid/openrtb/openrtb2?status.svg)](https://pkg.go.dev/github.com/prebid/openrtb/v20/openrtb2)
 
 [OpenRTB](https://iabtechlab.com/standards/openrtb/) [2.6](https://iabtechlab.com/wp-content/uploads/2022/04/OpenRTB-2-6_FINAL.pdf) types for [Go programming language](https://golang.org/)
diff --git a/openrtb2/app.go b/openrtb2/app.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // Object: App
@@ -111,15 +111,15 @@ type App struct {
 	//   integer
 	// Description:
 	//   Indicates if the app has a privacy policy, where 0 = no, 1 = yes.
-	PrivacyPolicy int8 `json:"privacypolicy,omitempty"`
+	PrivacyPolicy *int8 `json:"privacypolicy,omitempty"`
 
 	// Attribute:
 	//   paid
 	// Type:
 	//   integer
 	// Description:
 	//   0 = app is free, 1 = the app is a paid version.
-	Paid int8 `json:"paid,omitempty"`
+	Paid *int8 `json:"paid,omitempty"`
 
 	// Attribute:
 	//   publisher

diff --git a/openrtb2/audio.go b/openrtb2/audio.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // 3.2.8 Object: Audio
@@ -170,15 +170,15 @@ type Audio struct {
 	// Type:
 	//   integer
 	// Description:
-	//   Minimum bit rate in Kbps.
+	//   Minimum bit rate in Kbps (kilobits per second).
 	MinBitrate int64 `json:"minbitrate,omitempty"`
 
 	// Attribute:
 	//   maxbitrate
 	// Type:
 	//   integer
 	// Description:
-	//   Maximum bit rate in Kbps.
+	//   Maximum bit rate in Kbps (kilobits per second).
 	MaxBitrate int64 `json:"maxbitrate,omitempty"`
 
 	// Attribute:
@@ -245,7 +245,7 @@ type Audio struct {
 	// Description:
 	//   Indicates if the ad is stitched with audio content or delivered
 	//   independently, where 0 = no, 1 = yes.
-	Stitched int8 `json:"stitched,omitempty"`
+	Stitched *int8 `json:"stitched,omitempty"`
 
 	// Attribute:
 	//   nvol

diff --git a/openrtb2/banner.go b/openrtb2/banner.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // 3.2.6 Object: Banner
@@ -170,7 +170,7 @@ type Banner struct {
 	//   (Section 3.2.7) in an array of companion ads. Indicates the
 	//   companion banner rendering mode relative to the associated
 	//   video, where 0 = concurrent, 1 = end-card.
-	VCm int8 `json:"vcm,omitempty"`
+	Vcm *int8 `json:"vcm,omitempty"`
 
 	// Attribute:
 	//   ext

diff --git a/openrtb2/bid.go b/openrtb2/bid.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // 4.3.3 Object: Bid

diff --git a/openrtb2/bid_request.go b/openrtb2/bid_request.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // 3.2.1 Object: BidRequest

diff --git a/openrtb2/bid_request_test.go b/openrtb2/bid_request_test.go
@@ -5,7 +5,7 @@ import (
 	"io/ioutil"
 	"path/filepath"
 
-	. "github.com/prebid/openrtb/v19/openrtb2"
+	. "github.com/prebid/openrtb/v20/openrtb2"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/ginkgo/extensions/table"

diff --git a/openrtb2/bid_response.go b/openrtb2/bid_response.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/openrtb3"
+	"github.com/prebid/openrtb/v20/openrtb3"
 )
 
 // 4.3.1 Object: BidResponse

diff --git a/openrtb2/bid_response_test.go b/openrtb2/bid_response_test.go
@@ -5,7 +5,7 @@ import (
 	"io/ioutil"
 	"path/filepath"
 
-	. "github.com/prebid/openrtb/v19/openrtb2"
+	. "github.com/prebid/openrtb/v20/openrtb2"
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/ginkgo/extensions/table"

diff --git a/openrtb2/content.go b/openrtb2/content.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // 3.2.16 Object: Content
@@ -205,15 +205,15 @@ type Content struct {
 	//   integer
 	// Description:
 	//   0 = not live, 1 = content is live (e.g., stream, live blog).
-	LiveStream int8 `json:"livestream,omitempty"`
+	LiveStream *int8 `json:"livestream,omitempty"`
 
 	// Attribute:
 	//   sourcerelationship
 	// Type:
 	//   integer
 	// Description:
 	//   0 = indirect, 1 = direct.
-	SourceRelationship int8 `json:"sourcerelationship,omitempty"`
+	SourceRelationship *int8 `json:"sourcerelationship,omitempty"`
 
 	// Attribute:
 	//   len
@@ -248,7 +248,7 @@ type Content struct {
 	// Description:
 	//   Indicator of whether or not the content is embeddable (e.g.,
 	//   an embeddable video player), where 0 = no, 1 = yes.
-	Embeddable int8 `json:"embeddable,omitempty"`
+	Embeddable *int8 `json:"embeddable,omitempty"`
 
 	// Attribute:
 	//   data

diff --git a/openrtb2/device.go b/openrtb2/device.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // 3.2.18 Object: Device
@@ -186,7 +186,7 @@ type Device struct {
 	//   integer
 	// Description:
 	//   Support for JavaScript, where 0 = no, 1 = yes.
-	JS int8 `json:"js,omitempty"`
+	JS *int8 `json:"js,omitempty"`
 
 	// Attribute:
 	//   geofetch
@@ -195,7 +195,7 @@ type Device struct {
 	// Description:
 	//   Indicates if the geolocation API will be available to JavaScript
 	//   code running in the banner, where 0 = no, 1 = yes.
-	GeoFetch int8 `json:"geofetch,omitempty"`
+	GeoFetch *int8 `json:"geofetch,omitempty"`
 
 	// Attribute:
 	//   flashver

diff --git a/openrtb2/dooh.go b/openrtb2/dooh.go
@@ -3,7 +3,7 @@ package openrtb2
 import (
 	"encoding/json"
 
-	"github.com/prebid/openrtb/v19/adcom1"
+	"github.com/prebid/openrtb/v20/adcom1"
 )
 
 // Object: DOOH