open-api icon indicating copy to clipboard operation
open-api copied to clipboard

[BUG]: Receipt Object - Status Enum

Open gordonturner opened this issue 3 years ago • 1 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Describe the bug

The List of Shop Receipt resources returned in the getShopReceipts has an inconsistency in the definition of the status object.

  • The definition of the status is:

status required string Enum: "paid" "completed" "open" "payment processing" "canceled" The current order status string. One of: Open, Paid, Completed, Payment Processing.

  • Reference:

https://developer.etsy.com/documentation/reference/#operation/getShopReceipts

The generated code (via the Open API generator) creates a Java enum of the lower case text.

The returned values (and the values in the documentation) are returned with leading capital letters.

Result in an exception b/c of mismatch in the text expected and value returned.

Steps to reproduce

Generated java code by running:

java -jar openapi-generator-cli.jar generate \
-i https://www.etsy.com/openapi/generated/oas/3.0.0.json \
-g java \
-o ./etsy-open-api-client \
--skip-validate-spec \
--group-id com.gordonturner.etsy \
--artifact-id etsy-open-api-client \
--artifact-version 1.1.0 \
--type-mappings=integer=Long,int=Long

Observe the enum created at:

org.openapitools.client.model.ShopReceipt.StatusEnum

    PAID("paid"),
    
    COMPLETED("completed"),
    
    OPEN("open"),
    
    PAYMENT_PROCESSING("payment processing"),
    
    CANCELED("canceled");

Expected behavior

Expected that the returned value from the API should be lower case (I think).

Additional context

No response

gordonturner avatar May 09 '22 13:05 gordonturner

Proposed label: OpenAPI

gordonturner avatar Sep 26 '22 19:09 gordonturner