docs: add concepts for production order, production run and product #10
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
denizs
requested changes
Jul 20, 2023
Co-authored-by: Deniz Saner <deniz.saner@rwth-aachen.de>
daniel-k
commented
Jul 21, 2023
denizs
reviewed
Jul 21, 2023
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
this was causing spell and link checks to fail
☝️ This PR is the first in a row in an effort to expose production runs via the ENLYZE SDK. At the moment, we only expose time series data via the SDK and interaction with the timeseries service is contained in the `TimeseriesApiClient`. However, the new production runs API introduces a different pagination pattern, which makes it inconvenient to generalize the `TimeseriesApiClient` to a `EnlyzePlatformApiClient` ™️. Thus, this and subsequent PRs are building on top of the assumption that we will have separate API Clients for the timeseries and production runs API. This first PR introduces an `ApiBaseClient` class, which implement generalized `get` and `get_paginated` methods. The latter calls two abstract methods, `_has_more` and `_next_page_call_args` that must be implemented by API clients deriving from this class. --------- Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
Building up on #14 , this PR introduces the `ProductionRunsApiClient`, which instruments the Production Runs API. A subsequent PR will then expose a `ProductionRun` user model via the `EnlyzeClient`. --------- Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
…)" This reverts commit af984ab.
…ics" This reverts commit a6d15f5.
denizs
changed the base branch from
draft/production-run-models
to
feature/production-runs
Coverage resultsUpdate on 2023-10-10 15:37:48.812257285 +0000 This is the coverage report for commit 77a0a4e |
Merged
daniel-k
commented
Oct 10, 2023
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
Co-authored-by: Daniel Krebs <daniel-k@users.noreply.github.com>
|
Good to go from my side 👍 |
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.
No description provided.