Drop application/yaml content type (sigstore#933)

* Drop application/yaml content type This is a breaking change for any clients that are currently requesting application/yaml. This is the simplest fix to sigstore#593, as openapi randomly switches between json and yaml responses when no content type is provided. Fixes sigstore#593 Signed-off-by: Hayden Blauzvern <[email protected]> * remove default-consumes from Makefile Signed-off-by: Hayden Blauzvern <[email protected]> * Fix comment generation Signed-off-by: Hayden Blauzvern <[email protected]>
bobcallaway · Aug 3, 2022 · d3fa7da · d3fa7da
1 parent ebf0a56
commit d3fa7da
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 105 deletions.
diff --git a/Makefile b/Makefile
@@ -48,7 +48,7 @@ SERVER_LDFLAGS=$(REKOR_LDFLAGS)
 
 Makefile.swagger: $(SWAGGER) $(OPENAPIDEPS)
 	$(SWAGGER) validate openapi.yaml
-	$(SWAGGER) generate client -f openapi.yaml -q -r COPYRIGHT.txt -t pkg/generated --default-consumes application/json\;q=1 --additional-initialism=TUF
+	$(SWAGGER) generate client -f openapi.yaml -q -r COPYRIGHT.txt -t pkg/generated --additional-initialism=TUF
 	$(SWAGGER) generate server -f openapi.yaml -q -r COPYRIGHT.txt -t pkg/generated --exclude-main -A rekor_server --flag-strategy=pflag --default-produces application/json --additional-initialism=TUF
 	@echo "# This file is generated after swagger runs as part of the build; do not edit!" > Makefile.swagger
 	@echo "SWAGGER_GEN=`find pkg/generated/client pkg/generated/models/ pkg/generated/restapi/ -iname '*.go' | grep -v 'configure_rekor_server' | sort -d | tr '\n' ' ' | sed 's/ $$//'`" >> Makefile.swagger;

diff --git a/openapi.yaml b/openapi.yaml
@@ -25,10 +25,8 @@ schemes:
 
 consumes:
   - application/json
-  - application/yaml
 produces:
-  - application/json;q=1
-  - application/yaml
+  - application/json
 
 paths:
   /api/v1/version:

diff --git a/pkg/client/rekor_client.go b/pkg/client/rekor_client.go
@@ -33,10 +33,10 @@ func GetRekorClient(rekorServerURL string, opts ...Option) (*client.Rekor, error
 	o := makeOptions(opts...)
 
 	rt := httptransport.New(url.Host, client.DefaultBasePath, []string{url.Scheme})
-	rt.Consumers["application/yaml"] = YamlConsumer()
+	rt.Consumers["application/json"] = runtime.JSONConsumer()
 	rt.Consumers["application/x-pem-file"] = runtime.TextConsumer()
 	rt.Consumers["application/pem-certificate-chain"] = runtime.TextConsumer()
-	rt.Producers["application/yaml"] = YamlProducer()
+	rt.Producers["application/json"] = runtime.JSONProducer()
 	rt.Producers["application/timestamp-query"] = runtime.ByteStreamProducer()
 	rt.Consumers["application/timestamp-reply"] = runtime.ByteStreamConsumer()
 

diff --git a/pkg/client/yaml.go b/pkg/client/yaml.go
diff --git a/pkg/generated/client/entries/entries_client.go b/pkg/generated/client/entries/entries_client.go
diff --git a/pkg/generated/client/index/index_client.go b/pkg/generated/client/index/index_client.go
diff --git a/pkg/generated/client/pubkey/pubkey_client.go b/pkg/generated/client/pubkey/pubkey_client.go
diff --git a/pkg/generated/client/server/server_client.go b/pkg/generated/client/server/server_client.go
diff --git a/pkg/generated/client/tlog/tlog_client.go b/pkg/generated/client/tlog/tlog_client.go
diff --git a/pkg/generated/restapi/configure_rekor_server.go b/pkg/generated/restapi/configure_rekor_server.go
@@ -34,7 +34,6 @@ import (
 	"github.com/spf13/viper"
 
 	pkgapi "github.com/sigstore/rekor/pkg/api"
-	"github.com/sigstore/rekor/pkg/client"
 	"github.com/sigstore/rekor/pkg/generated/restapi/operations"
 	"github.com/sigstore/rekor/pkg/generated/restapi/operations/entries"
 	"github.com/sigstore/rekor/pkg/generated/restapi/operations/index"
@@ -71,9 +70,6 @@ func configureAPI(api *operations.RekorServerAPI) http.Handler {
 	api.JSONConsumer = runtime.JSONConsumer()
 	api.JSONProducer = runtime.JSONProducer()
 
-	api.YamlConsumer = client.YamlConsumer()
-	api.YamlProducer = client.YamlProducer()
-
 	api.ApplicationXPemFileProducer = runtime.TextProducer()
 
 	api.EntriesCreateLogEntryHandler = entries.CreateLogEntryHandlerFunc(pkgapi.CreateLogEntryHandler)

diff --git a/pkg/generated/restapi/doc.go b/pkg/generated/restapi/doc.go
diff --git a/pkg/generated/restapi/embedded_spec.go b/pkg/generated/restapi/embedded_spec.go
diff --git a/pkg/generated/restapi/operations/rekor_server_api.go b/pkg/generated/restapi/operations/rekor_server_api.go
diff --git a/pkg/sharding/ranges.go b/pkg/sharding/ranges.go
@@ -38,9 +38,9 @@ type LogRanges struct {
 type Ranges []LogRange
 
 type LogRange struct {
-	TreeID           int64  `yaml:"treeID"`
-	TreeLength       int64  `yaml:"treeLength"`
-	EncodedPublicKey string `yaml:"encodedPublicKey"`
+	TreeID           int64  `json:"treeID"`
+	TreeLength       int64  `json:"treeLength"`
+	EncodedPublicKey string `json:"encodedPublicKey"`
 	decodedPublicKey string
 }