You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR adds the /references endpoint (as well as /info/references and /references/{entry_id}) to the server.
Additional changes
Changes made in order to ease the incorporation of references, and in the future, more entry endpoints:
The old StructureResponseMany and StructureResponseOne have been renamed to EntryResponseMany and EntryResponseOne. The resource model used is the EntryResource, so new entry resource models must subclass this resource.
NOTE: For the validator, it is imperative to keep the specific Validator*Response, where * is any entry resource, since the validator has to check whether an endpoint then also produces the correct resources. Therefore ValidatorReferenceResponseMany and ValidatorReferenceResponseOne have been added.
Update EntryCollection and MongoCollection to be mapper agnostic, i.e., pass a specific mapper class, when initializing a collection.
This makes these collection classes completely resource agnostic.
Create a base ResourceMapper that contains the generally used class methods. StructureMapper now subclasses this class.
Create the ReferenceMapper. As of now, it is basically a complete copy of StructureMapper, barring some structure-specific lines in StructureMapper.
Add test_references.json with a single reference. For now, this reference matches the example from the spec (see here).
Other "minor" changes:
Put all provider information into config.ini and load it into CONFIG.provider as a dictionary.
Update the existing provider information with the Example provider from providers.json in the OPTiMaDe repository (here)
Move all utility functions from main.py into utils.py and clean up main.py.
NOTE: The entry endpoints now use the same utility function to create their responses, only differentiated by passing the correct collection to the utility function.
The optimade_validator tool has had its verbosity set to a default of 1 (it was 0).
Moved all utility functions used by the server in main.py into utils.py.
Abstracted some things away to utility functions and BaseClassres, in
order to easier create new entry endpoints.
Added /references, /references/{entry_id}, and /info/references to the
validator.
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.
CasperWA
force-pushed
the
close_69_add_references_endpoint
branch
from
Closes #69
Closes #70
Short description
This PR adds the
/referencesendpoint (as well as/info/referencesand/references/{entry_id}) to the server.Additional changes
Changes made in order to ease the incorporation of
references, and in the future, more entry endpoints:StructureResponseManyandStructureResponseOnehave been renamed toEntryResponseManyandEntryResponseOne. The resource model used is theEntryResource, so new entry resource models must subclass this resource.Validator*Response, where * is any entry resource, since the validator has to check whether an endpoint then also produces the correct resources. ThereforeValidatorReferenceResponseManyandValidatorReferenceResponseOnehave been added.EntryCollectionandMongoCollectionto be mapper agnostic, i.e., pass a specific mapper class, when initializing a collection.ResourceMapperthat contains the generally used class methods.StructureMappernow subclasses this class.ReferenceMapper. As of now, it is basically a complete copy ofStructureMapper, barring some structure-specific lines inStructureMapper.test_references.jsonwith a single reference. For now, this reference matches the example from the spec (see here).Other "minor" changes:
CONFIG.provideras a dictionary.providers.jsonin the OPTiMaDe repository (here)main.pyintoutils.pyand clean upmain.py.optimade_validatortool has had its verbosity set to a default of 1 (it was 0).