Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions internal/helpers/schema_date.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package helpers

import (
"reflect"

"github.com/google/jsonschema-go/jsonschema"
twapi "github.com/teamwork/twapi-go-sdk"
)

// WithDateTypeSchema registers a JSON-schema override for the twapi.Date type
// on the given generation options. twapi.Date is defined as `type Date
// time.Time`, so the reflection-based generator would otherwise emit a useless
// object schema for time.Time's unexported fields. This override forces it to a
// nullable, date-only string.
//
// Use it whenever generating an output schema from a response type that carries
// (or sideloads) twapi.Date fields:
//
// schema, err = jsonschema.For[Response](helpers.WithDateTypeSchema(&jsonschema.ForOptions{}))
//
// Any other options already set on opts (including pre-existing TypeSchemas
// entries) are preserved. The options value is modified in place and also
// returned for convenient chaining.
func WithDateTypeSchema(opts *jsonschema.ForOptions) *jsonschema.ForOptions {
if opts == nil {
opts = &jsonschema.ForOptions{}
}
if opts.TypeSchemas == nil {
opts.TypeSchemas = make(map[reflect.Type]*jsonschema.Schema)
}
opts.TypeSchemas[reflect.TypeFor[twapi.Date]()] = &jsonschema.Schema{
Types: []string{"null", "string"},
Format: "date",
Description: "Null or date-only date string",
}
return opts
}
4 changes: 3 additions & 1 deletion internal/twprojects/calendar_events.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ func init() {
var err error

// generate the output schema only once
calendarEventListOutputSchema, err = jsonschema.For[projects.CalendarEventListResponse](&jsonschema.ForOptions{})
calendarEventListOutputSchema, err = jsonschema.For[projects.CalendarEventListResponse](
helpers.WithDateTypeSchema(&jsonschema.ForOptions{}),
)
if err != nil {
panic(fmt.Sprintf("failed to generate JSON schema for CalendarEventListResponse: %v", err))
}
Expand Down
2 changes: 1 addition & 1 deletion internal/twprojects/search.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ var (
func init() {
var err error

searchOutputSchema, err = jsonschema.For[projects.SearchResponse](&jsonschema.ForOptions{})
searchOutputSchema, err = jsonschema.For[projects.SearchResponse](helpers.WithDateTypeSchema(&jsonschema.ForOptions{}))
if err != nil {
panic(fmt.Sprintf("failed to generate JSON schema for SearchResponse: %v", err))
}
Expand Down
4 changes: 2 additions & 2 deletions internal/twprojects/tasks.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ func init() {
var err error

// generate the output schemas only once
taskGetOutputSchema, err = jsonschema.For[projects.TaskGetResponse](&jsonschema.ForOptions{})
taskGetOutputSchema, err = jsonschema.For[projects.TaskGetResponse](helpers.WithDateTypeSchema(&jsonschema.ForOptions{}))
if err != nil {
panic(fmt.Sprintf("failed to generate JSON schema for TaskGetResponse: %v", err))
}
helpers.WithMetaWebLinkSchema(taskGetOutputSchema)
taskListOutputSchema, err = jsonschema.For[projects.TaskListResponse](&jsonschema.ForOptions{})
taskListOutputSchema, err = jsonschema.For[projects.TaskListResponse](helpers.WithDateTypeSchema(&jsonschema.ForOptions{}))
if err != nil {
panic(fmt.Sprintf("failed to generate JSON schema for TaskListResponse: %v", err))
}
Expand Down