Generate & include the OpenAPI docs into the mkdocs site #158
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
ThomasLaPiana
approved these changes
Oct 12, 2021
NevilleS
commented
Oct 12, 2021
|
OK, pushed one more little finishing touch: Go ahead and merge if you approve my Makefile change 👯 |
ThomasLaPiana
pushed a commit
that referenced
this pull request
Aug 17, 2022
* replace field str with tuple-based field key * replace field str with tuple-based field key * replace field name with field key object * savepoint * pylint/mypy fixes * fixing type errors in query config * type fixes * type error fixes * query config passing * savepoint * basic tests passing * dont set testing to true * pylint/mypy fixes * row by field path * savepoint * pylint fixes * fix 1 query config test * Get remaining tests passing - - Lots of updates in query config to transform FieldPath to a string - Make CollectionAddress.field_dict a property so it is not built just on instantiation * Clean up pass: - Rename the tuple that contains the nested path to be "levels" instead of overloaded "keys" - Revert some of the accidental find and replace of "names" to "keys" - Remove committed logging of exceptions - Restore/refactor deleted tests - Rename FieldPath's "value" attribute to be "string_path" for easier traceability * Cleanup around variable names, unused imports, Snowflake: - Remove unused getChild - Fix some uncaught type mismatches - Remove some lambda usages - Remove some instances of unpacking dictionaries to one letter variables - Fix some snowflake-related field path items * Update FieldAddress.field attribute to be named FieldAddress.field_path instead for clarity, since it returns a FieldPath object. * Add docstrings/tests around graph config changes. - Update CollectionAddress.field_address to take in one variable called "field_path" instead of "field." - Flesh out missing config tests for CollectionAddress, FieldAddress, Collection, and Field objects - Add test for ObjectField.collect_matching - Add dataset test where one collection references a field in a nested collection, and that the edges are built properly * Fix parsing yaml when a collection has a reference to a deeply nested field "photos.thumbnail.camera_used", for example. * Allow Node.contains_field to return True if condition satisfied on field or subfield. - Remove unncessary override of BidirectionalEdge.contains - Remove unused Edge.reverse method - Make Edge.delete_edges and Edge.create_edge class methods - Turn private _collect_matching to recursively_collect_matches because this is useful in multiple places. * Expand TraversalNode.add_child tests and fix FieldPath reference in test. * Update old field_key references to be field_path and fix some types in QueryConfig not caught by mypy. - Add some tests for base QueryConfig methods around nested fields. * Clarify graph task variable names related to field paths and remove unused attribute. * Correct typo in doc string and use self.field_map which has already been defined on the class. Co-authored-by: Steven Benjamin <steven@ethyca.com> Co-authored-by: Dawn Pattison <pattisdr@users.noreply.github.com>
ThomasLaPiana
pushed a commit
that referenced
this pull request
Sep 26, 2022
* replace field str with tuple-based field key * replace field str with tuple-based field key * replace field name with field key object * savepoint * pylint/mypy fixes * fixing type errors in query config * type fixes * type error fixes * query config passing * savepoint * basic tests passing * dont set testing to true * pylint/mypy fixes * row by field path * savepoint * pylint fixes * fix 1 query config test * Get remaining tests passing - - Lots of updates in query config to transform FieldPath to a string - Make CollectionAddress.field_dict a property so it is not built just on instantiation * Clean up pass: - Rename the tuple that contains the nested path to be "levels" instead of overloaded "keys" - Revert some of the accidental find and replace of "names" to "keys" - Remove committed logging of exceptions - Restore/refactor deleted tests - Rename FieldPath's "value" attribute to be "string_path" for easier traceability * Cleanup around variable names, unused imports, Snowflake: - Remove unused getChild - Fix some uncaught type mismatches - Remove some lambda usages - Remove some instances of unpacking dictionaries to one letter variables - Fix some snowflake-related field path items * Update FieldAddress.field attribute to be named FieldAddress.field_path instead for clarity, since it returns a FieldPath object. * Add docstrings/tests around graph config changes. - Update CollectionAddress.field_address to take in one variable called "field_path" instead of "field." - Flesh out missing config tests for CollectionAddress, FieldAddress, Collection, and Field objects - Add test for ObjectField.collect_matching - Add dataset test where one collection references a field in a nested collection, and that the edges are built properly * Fix parsing yaml when a collection has a reference to a deeply nested field "photos.thumbnail.camera_used", for example. * Allow Node.contains_field to return True if condition satisfied on field or subfield. - Remove unncessary override of BidirectionalEdge.contains - Remove unused Edge.reverse method - Make Edge.delete_edges and Edge.create_edge class methods - Turn private _collect_matching to recursively_collect_matches because this is useful in multiple places. * Expand TraversalNode.add_child tests and fix FieldPath reference in test. * Update old field_key references to be field_path and fix some types in QueryConfig not caught by mypy. - Add some tests for base QueryConfig methods around nested fields. * Clarify graph task variable names related to field paths and remove unused attribute. * Correct typo in doc string and use self.field_map which has already been defined on the class. Co-authored-by: Steven Benjamin <steven@ethyca.com> Co-authored-by: Dawn Pattison <pattisdr@users.noreply.github.com>
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.
Closes #91
Code Changes
maketargetsSteps to Confirm
make docs-serverlocallyPre-Merge Checklist
Description Of Changes
This is a quick implementation that gets us to here:
I'm not sure about the script file and it might create some untidy repo files, but this seems promising...