Discover collections in doc_maker.py #41
Merged
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
Remove hardcoding of "Collection" keyword for checking if a class is a collection. Check either using 'collection' property defined in 'EntryPoint' or 'manages' property defined in that class
chrizandr
added a commit
that referenced
this pull request
Aug 11, 2020
* add collections array to the entrypoint * add default manages block * allow configurable collection names * fix tests and pep8 format * add entrypoint property to the apidoc * add example of manages block in sample * fix id literal * fix id literal and generate sample doc * Add support for POST and DELETE on collection classes (#46) * Add support for POST and DELETE on collection classes As the collection will now be treated as a resource, we need to add support for POST and DELETE on collection/:uuid endpoint * Default readable and writable attributes of member property to True * Fix PEP8 errors * Discover collections in doc_maker.py (#41) * remove hardcoding of Collection keyword Remove hardcoding of "Collection" keyword for checking if a class is a collection. Check either using 'collection' property defined in 'EntryPoint' or 'manages' property defined in that class * Fix tests Use get_endpoint_and_path function instead of class_in_endpoint or collection_in_endpoint as they are changed to get_endpoint_and_path function * Remove dependency of class collection (#45) * add method for adding HydraCollection * Remove dependency of collection on classes 🎉 * Remove unnecessary comments * add missing context * Bring class uris to the apidoc url namespace * Give user option to chose the location of the apidoc * Make sure identifiers are inside the apidoc namespace * fix ids of supported Operations * Expansion of JSONLD and parsing of API DOC (#42) * [WIP] expand jsonld and use hydra namespace * Extract endpoint classes and collections * add comments * Store Link ids in the endpoints. * make HydraClass for classes endpoints * finish parsing of expanded apidoc 🎉 * Write new tests * resolve conflicts, make minor changes * add ids for base classes, * Add Docs (#47) * add docs with sphinx * add readthedocs yml and requirements.txt * change version * change sys.path * Bug Fixes (#48) * Add the namespace test and fix test due to adding of new manages block * Add base classes just once * place instantation at the right place * Case sensitive URLs * fix tests * avoid rewriting of the collections array * Parse HydraLinks in context * entrypoint uri correct Co-authored-by: Priyanshu Nayan <priyanshunayan456@gmail.com> Co-authored-by: Samesh Lakhotia <43701530+sameshl@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.
Related to #39
Checklist
Description
The
doc_makernow does not depend on hardcoded "Collection" keyword to identify if a givenclassdict is aclassor acollection.It finds all collections in two ways:
collectionproperty in theEntryPointof the given Hydra APIclassdict has amanagesblock(property).