search

JetBrains / plugin-repository-rest-client

Apache License 2.0
21 stars 15 forks source link

New api for Marketplace repository #41

Closed AlexanderPrendota closed 4 years ago

kesarevs commented 4 years ago

Sometimes you're using @param, sometimes @return, sometimes there is only a description. Could you please unify this. Also there is no information about exceptions.

serejke commented 4 years ago

Avoid using @param <param name> - <description> syntax. Separator - is useless and treated by Markdown wrongly as a list of items. Replace - with a single space. Check rendering using Quick Doc in IDEA.

serejke commented 4 years ago

Do not separate json \ xml model:

model/
   json/
   xml/
      converters/

It is an implementation detail whether a bean class comes from json or xml. I suggest moving all classes to model package and implementing proper conversions on PluginRepositoryService level.

serejke commented 4 years ago

PluginBean and PluginXmlBean are hardly distinguishable.

serejke commented 4 years ago

PluginBean and PluginUpdateBean are hardly distinguishable as well

serejke commented 4 years ago

Please review nullable bean's parameters. It is unclear what val removalRequested: Boolean? when removalRequested = null means: is it true or false or unspecified. Anyway, Javadoc must clarify that.