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

Patch swagger.json to represent '/v1/personalities' correctly #36

Merged
merged 1 commit into from
Mar 7, 2024

Conversation

spacegospod
Copy link
Contributor

Summary of Pull Request

The swagger.json file has an incorrect entry for the "/v1/personalities" endpoint.
The service returns a page object and the actual payload is under a key called "elements". This is a common pattern across the VCF APIs. In our version of the API spec however the endpoint response is listed as an array which result in a failure to unmarshal the response body when attempting to use the bindings.

I am patching the bindings so that they match the implementation.
Verified that this solution works by calling the API via the bindings on a live environment

Type of Pull Request

  • This is a bug fix.
  • This is an enhancement or feature.
  • This is a code style/formatting update.
  • This is a documentation update.
  • This is a refactoring update.
  • This is a chore update
  • This is something else.
    Please describe:

Related to Existing Issues

Issue Number: N/A

Test and Documentation Coverage

For bug fixes or features:

  • Tests have been completed.
  • Documentation has been added/updated.

Breaking Changes?

  • Yes, there are breaking changes.
  • No, there are no breaking changes.

@spacegospod spacegospod self-assigned this Mar 7, 2024
@github-actions github-actions bot added needs-review Needs Review sdk SDK labels Mar 7, 2024
@tenthirtyam tenthirtyam added bug Bug and removed needs-review Needs Review labels Mar 7, 2024
@tenthirtyam tenthirtyam merged commit 6fe31d2 into main Mar 7, 2024
1 check passed
@spacegospod spacegospod mentioned this pull request Mar 11, 2024
11 tasks
Copy link

github-actions bot commented Apr 7, 2024

I'm going to lock this pull request because it has been closed for 30 days. This helps our maintainers find and focus on the active issues.

If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Bug sdk SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants