Skip to content

Catalog API's - GetCategoryTree Type - (pub/category/tree/{categoryLevels}) - MetaTagDescription not typesafe (Is Nullable) #1365

@devhmac

Description

@devhmac

Describe the bug
Current Catalog OpenAPI spec defines MetaTagDescription as a guaranteed String response, however it is nullable.
https://developers.vtex.com/api/openapi/catalog-api
https://github.com/vtex/openapi-schemas/blob/master/VTEX%20-%20Catalog%20API.json

Current documentation for endpoint also notes
MetaTagDescription* - String indicating it is required in the response, however in the demo request example to https://apiexamples.vtexcommercestable.com.br/api/catalog_system/pub/category/tree/{categoryLevels} it returns instances with MetaTagDescription = null

Expected behavior
Expect stated response specification to be accurate - either non-nullable String field (Probably hard) or mark MetaTagDescription as String or null in OpenAPI schema and documentaion

Screenshots
If applicable, add screenshots to help explain your problem.
image
Request to https://apiexamples.vtexcommercestable.com.br/api/catalog_system/pub/category/tree/{2}
image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions