Add support for the Explorer API #1018
Open
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
Datadog ReportBranch report: ✅ 0 Failed, 1420 Passed, 154 Skipped, 14m 21.79s Total Time 🔻 Code Coverage Decreases vs Default Branch (1)
|
This commit adds support for the two generally available endpoints in the Explorer API: execute a query, export data to CSV. Since the jsonapi decoder does not support unmarshalling polymorphic slices, each view type has been assigned its own query function returning the appropriate data type.
sebasslash
force-pushed
the
sebasslash/add-explorer-api
branch
from
4716d65 to
2c834cb
Compare
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.
Description
Adds support for the two current GA endpoints of the Explorer API:
Testing plan
To run the tests, you will need an organization available with enough activity to test several different types of queries. The organization must be specified using the
EXPLORER_TEST_ORGANIZATIONenvironment variable; otherwise, the tests will be skipped. Test assertions rely on the current state of the specified organization, and failures may occur if the organization does not meet the required query conditions enumerated in the integration tests. For guidance on writing custom queries to smoke test on your own, refer to the code examples provided in the./examples/explorerdirectory.External links
Output from tests
Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.