Assets REST API specification error: /objectschema/{id}/objecttypes doesn't have "entries" in an object

XMLWordPrintable

    • Severity 3 - Minor
    • Unit testing, Integration testing, Mutation testing
    • S

      Issue Summary

      The OpenAPI specs for `api-objectschema-id-objecttypes-get` are wrong.

      Steps to Reproduce

      1. Provision a One Atlassian site.
      2. Create an OAuth 2.0 client id & secret.
      3. Execute the OAuth 2.0 client credential flow and obtain an access token.
      4. Use the token to obtain a workspaceId.
      5. Use an HTTP client to make an API request like: GET https://api.atlassian.com/ex/jira/89a6b224-3b44-4cef-8e4d-37aff29af277/jsm/assets/workspace/fb2728dc-83a6-4f9a-ac84-e5d03449f21d/v1/objectschema/2/objecttypes

      Expected Results

      Based on the documentation:
      https://developer.atlassian.com/cloud/assets/rest/api-group-objectschema/#api-objectschema-id-objecttypes-get

      When making a request to:
      GET {{/objectschema/

      {id}

      /objecttypes}}

      The response should correspond to this schema snippet:

      "schema": {
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ObjectType"
      }
    }
  }
}

      And an example response would look like:

      {
  "entries": [
    {
      "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
      "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:19",
      "id": "19",
      "name": "Employee",
      "icon": {
        "id": "131",
        "name": "Users",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/19/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/19/icon.png?size=48"
      },
      "position": 0,
      "created": "2021-02-16T18:32:38.173Z",
      "updated": "2021-02-16T19:37:07.179Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    }
  ]
}

      Actual Results

      The Object wrapper and "entries" attribute are missing.

      An actual API response looks like:

      [
  {
    "workspaceId": "fb2728dc-83a6-4f9a-ac84-e5d03449f21d",
    "globalId": "fb2728dc-83a6-4f9a-ac84-e5d03449f21d:5",
    "id": "5",
    "name": "Business Capability",
    "type": 0,
    "description": "",
    "icon": {
      "id": "7b5b9591-9f03-433c-baf5-f0fb43a930dd",
      "name": "Mind Map",
      "url16": "https://assets-media.atlassian.com/assets/icons/icons16/Mind%20Map.png",
      "url48": "https://assets-media.atlassian.com/assets/icons/icons48/Mind%20Map.png"
    },
    "position": 0,
    "created": "2026-02-17T08:36:02.196Z",
    "updated": "2026-02-17T08:36:02.196Z",
    "objectCount": 7,
    "objectSchemaId": "2",
    "inherited": false,
    "abstractObjectType": false,
    "parentObjectTypeInherited": false,
    "schemaLabel": "Application Portfolio"
  }
]

      Workaround

      Download the OpenAPI spec and patch it, before using any OpenAPI tools. In many cases, there may not be an opportunity to patch.

              Assignee:
              devpartisan
              Reporter:
              devpartisan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: