Adds the experimentalapi client class to the docs #228
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
sunildkumar
reviewed
Jul 20, 2024
| @@ -81,6 +106,11 @@ class ActionRequest(BaseModel): | |||
|
|
|||
|
|
|||
| class AllNotes(BaseModel): | |||
| """ | |||
| Serializes all notes for a given detector, grouped by type as listed in UserProfile.NoteCategoryChoices | |||
| The fields must match whats in USERPROFILE.NoteCategoryChoices | |||
There was a problem hiding this comment.
USERPROFILE
is all caps right?
There was a problem hiding this comment.
Well, no... In fact, SDK users don't have access to UserProfiles so we shouldn't even mention that here. But the source of truth for this docstring lives in the BE, so that will require a separate change
sunildkumar
reviewed
Jul 20, 2024
| @@ -22,7 +22,7 @@ generate: install-generator ## Generate the SDK from our public openapi spec | |||
| -o ./generated \ | |||
| --additional-properties=packageName=groundlight_openapi_client | |||
| # strict-nullable makes nullable fields Optional in the generated Pydantic classes: https://github.com/koxudaxi/datamodel-code-generator/issues/327 | |||
| poetry run datamodel-codegen --input spec/public-api.yaml --output generated/model.py --strict-nullable | |||
| poetry run datamodel-codegen --input spec/public-api.yaml --output generated/model.py --strict-nullable --use-schema-description | |||
There was a problem hiding this comment.
what does this new flag do?
There was a problem hiding this comment.
It uses the schema description to generate docstrings on the generated classes
sunildkumar
reviewed
Jul 20, 2024
sunildkumar
approved these changes
Jul 20, 2024
Co-authored-by: Sunil Kumar <[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.
This simply manually adds the experimental sections into the instructions for Sphinx. We haven't tightly integrated Sphinx yet, so in the future we should look into how to make this process more automatic