Improve Forecasting Parameters Metadata for API & OpenAPI Docs #1824
+129
−17
Conversation
This file contains hidden or 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
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…Schema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…hema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…sSchema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…Schema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…lds in ForecasterParametersSchema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…hema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…Schema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…rsSchema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…dd field defaults Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the documentation of forecasting parameters in the ForecasterParametersSchema class by adding comprehensive metadata to each field, including descriptions, example values, and default values where applicable. This improves the auto-generated OpenAPI specification and makes the API more self-documenting for developers.
Key changes:
- Added detailed
metadatadictionaries to all schema fields with descriptions and examples - Documented default values for parameters throughout the schema
- Improved formatting and readability by expanding field definitions across multiple lines
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Documentation build overview
Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
|
Co-authored-by: Copilot <[email protected]> Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
…rParametersSchema Signed-off-by: Mohamed Belhsan Hmida <[email protected]>
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
This PR enhances the documentation of forecasting parameters by improving the metadata defined in
ForecasterParametersSchema. Each field now includes:This improves the generated OpenAPI specification, makes the API more self-documenting, and helps developers and users understand how each forecasting parameter behaves without referring to the CLI code
Related Items
closes #1815
Sign-off