SDK Generation

README.md

@@ -1,30 +1,17 @@
-# Lattice SDK Go library
+# Lattice SDK Go Library
 
 ![](https://www.anduril.com/lattice-sdk/)
 
-The Lattice SDK Go library provides convenient access to the Lattice API from Go.
+
+The Lattice SDK Go library provides convenient access to the Lattice SDK APIs from Go.
 
 ## Documentation
 
 API reference documentation is available [here](https://developer.anduril.com/).
 
-## Requirements
-
-To use the SDK please ensure you have the following installed:
-
-* [Go](https://go.dev/doc/install)
-
-## Installation
-
-Install the Lattice SDK package with
-
-```
-go get github.com/anduril/lattice-sdk-go/v2
-```
-
-## Support
+## Reference
 
-For support with this library please reach out to your Anduril representative. 
+A full reference for this library is available [here](./reference.md).
 
 ## Usage
 
@@ -36,8 +23,8 @@ package example
 import (
     client "github.com/anduril/lattice-sdk-go/v2/client"
     option "github.com/anduril/lattice-sdk-go/v2/option"
-    context "context"
     Lattice "github.com/anduril/lattice-sdk-go/v2"
+    context "context"
 )
 
 func do() {
@@ -46,11 +33,12 @@ func do() {
             "<token>",
         ),
     )
+    request := &Lattice.EntityEventRequest{
+        SessionToken: "sessionToken",
+    }
     client.Entities.LongPollEntityEvents(
         context.TODO(),
-        &Lattice.EntityEventRequest{
-            SessionToken: "sessionToken",
-        },
+        request,
     )
 }
 ```
@@ -139,6 +127,9 @@ A request is deemed retryable when any of the following HTTP status codes is ret
 - [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
 - [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
 
+If the `Retry-After` header is present in the response, the SDK will prioritize respecting its value exactly
+over the default exponential backoff.
+
 Use the `option.WithMaxAttempts` option to configure this behavior for the entire client or an individual request:
 
 ```go
@@ -162,3 +153,25 @@ defer cancel()
 
 response, err := client.Entities.LongPollEntityEvents(ctx, ...)
 ```
+
+### Explicit Null
+
+If you want to send the explicit `null` JSON value through an optional parameter, you can use the setters\
+that come with every object. Calling a setter method for a property will flip a bit in the `explicitFields`
+bitfield for that setter's object; during serialization, any property with a flipped bit will have its
+omittable status stripped, so zero or `nil` values will be sent explicitly rather than omitted altogether:
+
+```go
+type ExampleRequest struct {
+    // An optional string parameter.
+    Name *string `json:"name,omitempty" url:"-"`
+
+    // Private bitmask of fields set to an explicit value and therefore not to be omitted
+    explicitFields *big.Int `json:"-" url:"-"`
+}
+
+request := &ExampleRequest{}
+request.SetName(nil)
+
+response, err := client.Entities.LongPollEntityEvents(ctx, request, ...)
+```