Azure API Management importing openapi generating random names

Petula Lau 0

Hi, I have the following openapi.json, and when I import it into the azure api management portal it generates a long name like: RestApiAdminLocationSourcesGet200ApplicationJsonResponse for the definition for 200 status

How do I change it so its a specific name? I realize that the type=array is the problem

 "/rest/api/admin/locationSources": {
      "get": {
        "tags": [
          "Admin Location Source API"
        ],
        "summary": "Admin - Get all location sources",
        "description": "Get all location sources for the Admin Console",
        "operationId": "getAllLocationSources",
        "responses": {
          "200": {
            "description": "Location sources retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/LocationSourceResponse"
                  }
                }
              }
            }
          },

JananiRamesh-MSFT 27,826 Reputation points

2024-10-09T16:25:13.2966667+00:00

@Petula Lau Thanks for reaching out. could you please let me know where you are seeing this name RestApiAdminLocationSourcesGet200ApplicationJsonResponse is this a name of operation of an API? could you please share me the Openapi file to investigate further?
JananiRamesh-MSFT 27,826 Reputation points

2024-10-15T08:19:43.97+00:00

@Petula Lau Thanks for your patience! As you mentioned I do see random definition names getting automatically generated while importing the API's, i had a discussion internally and confirmed that its by design if you need to change the name you can edit it in the portal as shown below

do let me know incase of further queries i would be happy to assist you.
Petula Lau 0 Reputation points

2024-10-16T20:41:30.3266667+00:00

Thanks @JananiRamesh-MSFT so there is no way I can change this without having to manually edit it? I have 100s of APIs that are like this.

I dont understand why when the schema = array it does this? When it is just a normal object it doesnt generate the long name.
JananiRamesh-MSFT 27,826 Reputation points

2024-10-19T06:02:28.12+00:00

@Petula Lau Thanks for getting back, will check internally on this and will get back to you.

I appreciate your patience on this topic.
Petula Lau 0 Reputation points

2024-10-28T21:27:45.9733333+00:00

Any updates @JananiRamesh-MSFT ? Thanks so much for your help
JananiRamesh-MSFT 27,826 Reputation points

2024-10-30T13:25:59.1166667+00:00

@Petula Lau Thanks for your patience! I had a discussion internally and confirmed this is by design. Names are not random but correspond to the part of the openapi file from which schema was extract.

The name which you shared RestApiAdminLocationSourcesGet200ApplicationJsonResponse was extracted from

Response section

Path: /rest/api/admin/location/sources

Method: GET

Response code: 200

Response body type: application/json

You can modify the OpenAPI file to extract the whole schema to components or definition section, So instead of having the definition of schema define like below

"content": {

"application/json": {

"schema": {

"type": "array",

"items": {

"$ref": "#/components/schemas/LocationSourceResponse"

should have it define as below

//..."content":

{ "application/json": {

"schema": {

"$ref": "#/components/schemas/ListOfLocationSourceResponse"

} }}

//...

"components": {

"schemas": {

"ListOfLocationSourceResponse": {

"type": "array",

"items": {

"$ref": "#/components/schemas/LocationSourceResponse"

}

},

"LocationSourceResponse":

{ // Customer object definition

}

}

}

With the above the name should be equal to the name define in the $ref element.
please try and let me know incase of further queries, I would be happy to assist you.
Petula Lau 0 Reputation points

2024-10-30T20:58:16.71+00:00

Unfortunately this changes my return json in java - so this wont work for us either.

I guess its not possible to fix.

Thanks

Share via

Azure API Management importing openapi generating random names

Your answer