CatalogueOfLife / backend

Complete backend of COL ChecklistBank
Apache License 2.0
15 stars 11 forks source link

docs say that name/search issue is a string. #51

Open MortenHofft opened 6 years ago

MortenHofft commented 6 years ago

https://sp2000.github.io/colplus/api/api.html#resource-15 api says else

{
"code": 400,
"message": "query param issue must be one of [UNPARSABLE_NAME, PARTIALLY_PARSABLE_NAME, UNPARSABLE_AUTHORSHIP, DOUBTFUL_NAME, INCONSISTENT_AUTHORSHIP, INCONSISTENT_NAME, UNUSUAL_CHARACTERS, NULL_EPITHET, SUBSPECIES_ASSIGNED, LC_MONOMIAL, INDET_CULTIVAR, INDET_SPECIES, INDET_INFRASPECIES, HIGHER_RANK_BINOMIAL, QUESTION_MARKS_REMOVED, REPL_ENCLOSING_QUOTE, MISSING_GENUS, HTML_ENTITIES, XML_ENTITIES, NOMENCLATURAL_STATUS_INVALID, NOMENCLATURAL_CODE_INVALID, BASIONYM_AUTHOR_MISMATCH, BASIONYM_NOT_UNIQUE, BASIONYM_DERIVED, CONFLICTING_BASIONYM_COMBINATION, POTENTIAL_ORTHOGRAPHIC_VARIANT, HOMONYM, PUBLISHED_BEFORE_GENUS, REFERENCE_ID_INVALID, ID_NOT_UNIQUE, PARENT_ID_INVALID, ACCEPTED_ID_INVALID, BASIONYM_ID_INVALID, ACCEPTED_NAME_MISSING, RANK_INVALID, TAXONOMIC_STATUS_INVALID, LIFEZONE_INVALID, IS_FOSSIL_INVALID, IS_RECENT_INVALID, URL_INVALID, ACCORDING_TO_DATE_INVALID, CHAINED_SYNOYM, TAXONOMIC_STATUS_MISMATCH, PARENT_CYCLE, CLASSIFICATION_RANK_ORDER_INVALID, CLASSIFICATION_NOT_APPLIED, VERNACULAR_NAME_INVALID, VERNACULAR_NAME_TRANSLITERATED, DESCRIPTION_INVALID, DISTRIBUTION_INVALID, DISTRIBUTION_AREA_INVALID, DISTRIBUTION_COUNTRY_INVALID, DISTRIBUTION_STATUS_INVALID, DISTRIBUTION_GAZETEER_INVALID, SPECIES_PROFILE_INVALID, MULTIMEDIA_INVALID, BIB_REFERENCE_INVALID, ALT_IDENTIFIER_INVALID, BACKBONE_MATCH_NONE, BACKBONE_MATCH_FUZZY, NAME_NOT_UNIQUE, PARENT_NAME_NOT_UNIQUE, RELATIONSHIP_MISSING, NO_SPECIES, NAME_PARENT_MISMATCH, ORTHOGRAPHIC_VARIANT]"
}
mdoering commented 6 years ago

https://github.com/Sp2000/colplus-backend/commit/d7d89e57293ef6c7b7fb81805d412437bcfaeccf

mdoering commented 6 years ago

rather difficult to influence. This is the bean validator throwing and creating an automated response. The API accepts enum values case insensitively, so maybe this is not a big issue - although a little confusing

MortenHofft commented 6 years ago

I would say the docs should be changed to list the enums accepted just like you do for rank and other enums. The confussion in this issue arose because i implemented a free text search for issues because the docs said it was a string search (not enums)