Added an option to the /ids/globalIds endpoint to return the artifact type as a response header (#5471)

Author: EricWittmann

app/src/main/java/io/apicurio/registry/rest/v3/IdsResourceImpl.java

@@ -63,7 +63,8 @@ public Response getContentById(long contentId) {
      */
     @Override
     @Authorized(style = AuthorizedStyle.GlobalId, level = AuthorizedLevel.Read)
-    public Response getContentByGlobalId(long globalId, HandleReferencesType references) {
+    public Response getContentByGlobalId(long globalId, HandleReferencesType references,
+            Boolean returnArtifactType) {
         ArtifactVersionMetaDataDto metaData = storage.getArtifactVersionMetaData(globalId);
         if (VersionState.DISABLED.equals(metaData.getState())
                 || VersionState.DRAFT.equals(metaData.getState())) {
@@ -82,6 +83,9 @@ public Response getContentByGlobalId(long globalId, HandleReferencesType referen
 
         Response.ResponseBuilder builder = Response.ok(contentToReturn.getContent(),
                 contentToReturn.getContentType());
+        if (returnArtifactType != null && returnArtifactType) {
+            builder.header("X-Registry-ArtifactType", metaData.getArtifactType());
+        }
         checkIfDeprecated(metaData::getState, metaData.getArtifactId(), metaData.getVersion(), builder);
         return builder.build();
     }

app/src/test/java/io/apicurio/registry/noprofile/rest/v3/IdsResourceTest.java

@@ -8,6 +8,7 @@
 import io.apicurio.registry.utils.tests.TestUtils;
 import io.quarkus.test.junit.QuarkusTest;
 import org.apache.commons.codec.digest.DigestUtils;
+import org.hamcrest.Matchers;
 import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.Test;
 
@@ -110,8 +111,14 @@ public void testGetByGlobalId() throws Exception {
         // Get by globalId
         given().when().contentType(CT_JSON).pathParam("globalId", globalId)
                 .get("/registry/v3/ids/globalIds/{globalId}").then().statusCode(200)
-                .body("openapi", equalTo("3.0.2")).body("info.title", equalTo(title));
+                .header("X-Registry-ArtifactType", Matchers.nullValue()).body("openapi", equalTo("3.0.2"))
+                .body("info.title", equalTo(title));
 
+        // Get by globalId with artifactType
+        given().when().contentType(CT_JSON).pathParam("globalId", globalId)
+                .queryParam("returnArtifactType", true).get("/registry/v3/ids/globalIds/{globalId}").then()
+                .statusCode(200).header("X-Registry-ArtifactType", "OPENAPI")
+                .body("openapi", equalTo("3.0.2")).body("info.title", equalTo(title));
     }
 
     @Test
@@ -134,7 +141,6 @@ public void testGetByGlobalIdIssue1501() throws Exception {
         // Get by globalId should not fail
         clientV3.ids().globalIds().byGlobalId(globalId1).get();
         clientV3.ids().globalIds().byGlobalId(globalId2).get();
-
     }
 
     @Test

common/src/main/resources/META-INF/openapi.json

@@ -29,6 +29,14 @@
               "$ref": "#/components/schemas/HandleReferencesType"
             },
             "in": "query"
+          },
+          {
+            "name": "returnArtifactType",
+            "description": "When set to `true`, the HTTP response will include a header named `X-Registry-ArtifactType`\nthat contains the type of the artifact being returned.",
+            "schema": {
+              "type": "boolean"
+            },
+            "in": "query"
           }
         ],
         "responses": {
@@ -5439,6 +5447,13 @@
         "description": "Common response used when an input conflicts with existing data."
       },
       "ArtifactContent": {
+        "headers": {
+          "X-Registry-ArtifactType": {
+            "schema": {
+              "$ref": "#/components/schemas/ArtifactType"
+            }
+          }
+        },
         "content": {
           "*/*": {
             "schema": {

go-sdk/pkg/registryclient-v3/ids/global_ids_with_global_item_request_builder.go

@@ -18,6 +18,8 @@ type GlobalIdsWithGlobalItemRequestBuilderGetQueryParameters struct {
 	References *string `uriparametername:"references"`
 	// Allows the user to specify how references in the content should be treated.
 	ReferencesAsHandleReferencesType *i00eb2e63d156923d00d8e86fe16b5d74daf30e363c9f185a8165cb42aa2f2c71.HandleReferencesType `uriparametername:"references"`
+	// When set to `true`, the HTTP response will include a header named `X-Registry-ArtifactType`that contains the type of the artifact being returned.
+	ReturnArtifactType *bool `uriparametername:"returnArtifactType"`
 }
 
 // GlobalIdsWithGlobalItemRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.
@@ -33,7 +35,7 @@ type GlobalIdsWithGlobalItemRequestBuilderGetRequestConfiguration struct {
 // NewGlobalIdsWithGlobalItemRequestBuilderInternal instantiates a new GlobalIdsWithGlobalItemRequestBuilder and sets the default values.
 func NewGlobalIdsWithGlobalItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *GlobalIdsWithGlobalItemRequestBuilder {
 	m := &GlobalIdsWithGlobalItemRequestBuilder{
-		BaseRequestBuilder: *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.NewBaseRequestBuilder(requestAdapter, "{+baseurl}/ids/globalIds/{globalId}{?references*}", pathParameters),
+		BaseRequestBuilder: *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.NewBaseRequestBuilder(requestAdapter, "{+baseurl}/ids/globalIds/{globalId}{?references*,returnArtifactType*}", pathParameters),
 	}
 	return m
 }

go-sdk/pkg/registryclient-v3/kiota-lock.json

@@ -1,5 +1,5 @@
 {
-  "descriptionHash": "760E2C412DC1229895C64DE9E5C64E93739B4734CB2A4444323019D1A22B4C081479F739A9C7372E3E87D335E577DDE222B8DF9D48DF05ED285DEA1D2C7F2729",
+  "descriptionHash": "1494AA12BB8D5D92915A230B88E70766D0D39CD6DFFF99D36D62AED1CAE34F87673F1CB46CB5CB48DB3BC4A45C3B84CBE26F2EEEBC4FB567BD6F2E564B225FF4",
   "descriptionLocation": "../../v3.json",
   "lockFileVersion": "1.0.0",
   "kiotaVersion": "1.19.1",