Skip to content
Snippets Groups Projects
Commit c8b44f9e authored by Magali Ruffier's avatar Magali Ruffier
Browse files

ENSCORESW-707: documentation was wrong on parameter name

endpoint uses object_type to restrict the query, not object
parent 41c27672
No related branches found
No related tags found
No related merge requests found
......@@ -24,12 +24,12 @@
description=Registry group which we should limit our search to. Useful if a stable ID is not unique to a species
example=core
</db_type>
<object>
<object_type>
type=String
description=Object type to restrict searches to. Used when a stable ID is not unique to a single class. This is equivalent to the Perl API object classes
example=gene
example=transcript
</object>
</object_type>
<format>
type=Enum(full,condensed)
description=Specify the formats to emit from this endpoint
......
......@@ -20,12 +20,12 @@
example=__VAR(species_common)__
required=1
</species>
<object>
<object_type>
type=String
description=Object type to restrict searches to. Defaults to using all known main object types i.e. gene, transcript and translation
example=gene
example=transcript
</object>
</object_type>
<external_db>
type=String
description=Limit searches to a single database name
......@@ -83,12 +83,12 @@
example=__VAR(species)__
example=__VAR(species_common)__
</species>
<object>
<object_type>
type=String
description=Object type to restrict searches to. Used when a stable ID is not unique to a single class. This is equivalent to the Perl API object classes
example=gene
example=transcript
</object>
</object_type>
<all_levels>
type=Boolean
description=Descend down all available levels in the given stable id's object and return all cross references linked to its childern. Specifying this on a Gene will also return values from its transcripts and translations
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment