Replace swagger-based QA client with fetch calls #3312
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes #3262 This commit replaces the swagger-based QA client. Why? 1. the API specification is incomplete; 2. it's not clear there is a plan in place to keep the specification up to date; and 3. we only use a fraction of the QA API in the Sinopia editor In short, it's to pay down technical debt. This commit otherwise retains the same interface for interacting with the QA API, returning a promise that resolves to the HTTP response.
mjgiarlo
changed the title
|
I'm quite against the lack of a shared and validatable contract about this API that is maintained by two entities. I've recently worked with Lynette to get the API matching the swagger spec they are publishing. I think we should continue to use it. |
|
@jcoyne 💬
After chatting with @justinlittman this morning, it seems the fetch-based approach is preferred at this time. Maybe a stand-up discussion is warranted. |
justinlittman
approved these changes
Nov 9, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why was this change made?
Fixes #3262
This commit replaces the swagger-based QA client. Why?
In short, it's to pay down technical debt. This commit otherwise retains the same interface for interacting with the QA API, returning a promise that resolves to the HTTP response.
How was this change tested?
CI
Which documentation and/or configurations were updated?
None