Add Elastic-Api-Version and X-Request-Id headers in openapi spec (ela…

…stic#3044)

Add doc.go files for minimal information on generated client apis (what they are generated from).
Add missing headers to all req/resp in the openapi spec for the current implementation in `model/openapi.yml`.
Add an `openapi.yml` spec file for the `2023-06-01` based off commit 1d28f4c with the missing headers (and version defined in the spec). Correct the directory name for the versioned client.

changelog/fragments/1697650203-Add-missing-headers-to-openapi-spec.yaml

@@ -0,0 +1,32 @@
+# Kind can be one of:
+# - breaking-change: a change to previously-documented behavior
+# - deprecation: functionality that is being removed in a later release
+# - bug-fix: fixes a problem in a previous version
+# - enhancement: extends functionality but does not break or fix existing behavior
+# - feature: new functionality
+# - known-issue: problems that we are aware of in a given version
+# - security: impacts on the security of a product or a user’s deployment.
+# - upgrade: important information for someone upgrading from a prior version
+# - other: does not fit into any of the other categories
+kind: other
+
+# Change summary; a 80ish characters long description of the change.
+summary: Add missing headers to openapi spec
+
+# Long description; in case the summary is not enough to describe the change
+# this field accommodate a description without length limits.
+# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment.
+description: Add missing Elastic-Api-Version and X-Request-Id headers across all req/resp in the openapi spec and generated clients.
+
+# Affected component; a word indicating the component this changeset affects.
+component:
+
+# PR URL; optional; the PR number that added the changeset.
+# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
+# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
+# Please provide it if you are adding a fragment for a different PR.
+#pr: https://github.com/owner/repo/1234
+
+# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
+# If not present is automatically filled by the tooling with the issue linked to the PR number.
+#issue: https://github.com/owner/repo/1234

internal/pkg/api/api.go

@@ -130,7 +130,7 @@ func (a *apiServer) UploadChunk(w http.ResponseWriter, r *http.Request, id strin
 	}
 }
 
-func (a *apiServer) GetFile(w http.ResponseWriter, r *http.Request, id string) {
+func (a *apiServer) GetFile(w http.ResponseWriter, r *http.Request, id string, params GetFileParams) {
 	zlog := hlog.FromRequest(r).With().Logger()
 	if err := a.ft.handleSendFile(zlog, w, r, id); err != nil {
 		cntFileDeliv.IncError(err)
@@ -139,7 +139,7 @@ func (a *apiServer) GetFile(w http.ResponseWriter, r *http.Request, id string) {
 	}
 }
 
-func (a *apiServer) GetPGPKey(w http.ResponseWriter, r *http.Request, major, minor, patch int) {
+func (a *apiServer) GetPGPKey(w http.ResponseWriter, r *http.Request, major, minor, patch int, params GetPGPKeyParams) {
 	zlog := hlog.FromRequest(r).With().Logger()
 	if err := a.pt.handlePGPKey(zlog, w, r, major, minor, patch); err != nil {
 		cntGetPGP.IncError(err)

internal/pkg/api/apiVersion.go

@@ -62,6 +62,7 @@ func (a *apiVersion) middleware(next http.Handler) http.Handler {
 		if headerValue != "" {
 			err := a.validateVersionFormat(headerValue)
 			if err != nil {
+				w.Header().Add(ElasticAPIVersionHeader, a.defaultVersion)
 				ErrorResp(w, r, err)
 				return
 			}