Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug with API version #2586

Closed
swimmwatch opened this issue Jul 25, 2022 · 1 comment
Closed

Bug with API version #2586

swimmwatch opened this issue Jul 25, 2022 · 1 comment

Comments

@swimmwatch
Copy link

swimmwatch commented Jul 25, 2022

Hi! I have project - SDK that was generated by OpenAPI specification. There is workflow that checks diff every day at 0:00 AM (UTC). If API version was changed then SDK will be regenerated.

I found that API specification was changed but API version was not. I had compared two specifications (using openapi-diff): current (version 18.0.0) and 3 months old (version 18.0.0).

Output openapi-diff:

What's Changed


GET /players/{account_id}
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Deleted property tracked_until (string)

      tracked_until

    • Changed property profile (object)

      profile

      • Added property is_subscriber (boolean)

        Boolean indicating if the user subscribed to OpenDota

GET /players/{account_id}/recentMatches
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):
    > match

    • Added property average_rank (integer)

      Average rank of players with public match data

GET /players/{account_id}/matches
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):
    > Object containing information on the match

    • Added property average_rank (integer)

      Average rank of players with public match data

GET /players/{account_id}/peers
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    Changed items (object):

    • Added property is_subscriber (boolean)

      is_subscriber

GET /metadata
Return Type:

Changed response : 200 OK

Success

  • Changed content type : application/json

    • Deleted property cheese (object)

      cheese

GET /teams
Parameters:

Added: page in query

Page number, zero indexed. Each page returns up to 1000 entries.

Judging by the output the following changes are incompatible and version must be changed.

@howardchung
Copy link
Member

I will create a new version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants