Swagger api #140

catena2w · 2017-12-20T12:09:50Z

No description provided.

# Conflicts: # src/main/scala/scorex/core/api/http/PeersApiRoute.scala

# Conflicts: # src/main/resources/reference.conf # src/main/scala/scorex/core/api/http/NodeViewApiRoute.scala

…ger-api

coveralls · 2017-12-20T12:24:15Z

Changes Unknown when pulling 434275e on swagger-api into ** on master**.

coveralls · 2017-12-20T14:26:33Z

Changes Unknown when pulling 5059062 on swagger-api into ** on master**.

coveralls · 2017-12-20T14:49:09Z

Changes Unknown when pulling 1aa80b0 on swagger-api into ** on master**.

coveralls · 2017-12-20T15:40:59Z

Changes Unknown when pulling ec9a2e6 on swagger-api into ** on master**.

AxiomFlow · 2017-12-21T05:08:23Z

examples/src/main/resources/api/testApi.yaml

+
+  /peers/connect:
+    post:
+      summary: Get current size of the unconfirmed transactions pool


Is this summary correct?

AxiomFlow · 2017-12-21T05:10:37Z

lock.sbt

  "com.github.mpilquist" % "simulacrum_2.12" % "0.10.0",
-  "com.github.swagger-akka-http" % "swagger-akka-http_2.12" % "0.10.0",
-  "com.google.guava" % "guava" % "20.0",
+  "com.google.guava" % "guava" % "19.0",


Why go down from 20.0 to 19.0?

Library, that required guava 20 was removed, we now only have libraries that require guava 19 in dependencies

AxiomFlow · 2017-12-21T05:23:08Z

src/main/scala/scorex/core/api/http/ApiRoute.scala

@@ -15,25 +15,32 @@ trait ApiRoute extends Directives {
  val context: ActorRefFactory
  val route: Route

-  implicit val timeout = Timeout(settings.timeout)
+  implicit lazy val timeout: Timeout = Timeout(settings.timeout)


Is this timeout still used? Maybe this line could be removed?

Or is it required as an implicit argument somewhere?

It is required in a lot of API routes as a timeout for requests to actors. Check ApiRouteWithFullView for example

coveralls · 2017-12-21T10:01:10Z

Changes Unknown when pulling 3b60395 on swagger-api into ** on master**.

coveralls · 2017-12-21T14:01:35Z

Changes Unknown when pulling 5379653 on swagger-api into ** on master**.

coveralls · 2017-12-21T14:26:02Z

Changes Unknown when pulling 29d8205 on swagger-api into ** on master**.

# Conflicts: # src/main/scala/scorex/core/api/http/PeersApiRoute.scala # src/main/scala/scorex/core/api/http/swagger/SwaggerDocService.scala

ceilican · 2017-12-26T10:14:28Z

@Tolsi , the CI build is failing.

ceilican

I noticed that all @Path, @ApiOperation and @ApiImplicitParams annotations were removed.

Do I understand correctly that goal is to document the API in "yaml" files (e.g. examples/src/main/resources/api/testApi.yaml) from now on, to conform with newer openapi conventions?

Some of the information that we had in annotations has not been added to any yaml file (yet). The examples/src/main/resources/api/testApi.yaml, for instance, contains documentation only for a few paths. Many paths that were documented with annotations before would have no documentation if this PR were accepted in its current state. There would be a loss of documentation coverage. Would that be ok? Shouldn't we try to maintain and increase our documentation coverage level?

ceilican · 2017-12-26T10:20:01Z

examples/src/main/resources/api/testApi.yaml

+
+  /peers/connect:
+    post:
+      summary: Get current size of the unconfirmed transactions pool


Is this the correct summary for this path?

@ceilican I think nope. I fixed this one here https://github.com/ergoplatform/ergo/pull/108/files#diff-f11bc37099101a6156775fbde1871902R712

Your fix seems good to me.

@ceilican But it was done in ergo repository =)

Yes, I know. I think it should be done here (in Scorex, in this PR) too.

And I wonder if it would be possible/desirable, in the future (in another PR), to reduce code and documentation duplication at the api level between scorex('s example) and ergo. It seems to me that right now duplication is only avoided at the network layer. All other layers remain completely abstract in Scorex's core and need to be (re-)implemented, possibly in similar ways, by every blockchain system built with Scorex. Perhaps, in the future, Scorex could provide some standard api routes/paths already pre-implemented.

@Daron666, is ergo's api significantly different from the api of scorex's example?

@kushti, should we include the api into the scope of that architecture review that we have discussed?

@ceilican Ergo's api is a superset over scorex api.

coveralls · 2017-12-27T10:04:13Z

Coverage remained the same at 45.681% when pulling 8fc4d79 on swagger-api into b0b0d64 on master.

…ger-api Conflicts: examples/src/main/scala/examples/hybrid/api/http/StatsApiRoute.scala src/main/scala/scorex/core/api/http/PeersApiRoute.scala src/main/scala/scorex/core/api/http/UtilsApiRoute.scala

coveralls · 2018-01-06T10:39:24Z

Coverage decreased (-0.06%) to 45.62% when pulling 9c41b1f on swagger-api into 00794b6 on master.

coveralls · 2018-01-06T16:33:18Z

Coverage remained the same at 45.681% when pulling 674d12c on swagger-api into 00794b6 on master.

coveralls · 2018-01-08T09:10:44Z

Coverage remained the same at 45.681% when pulling 1244675 on swagger-api into 00794b6 on master.

coveralls · 2018-01-08T09:37:27Z

Coverage remained the same at 45.681% when pulling d1f0458 on swagger-api into 00794b6 on master.

catena2w · 2018-01-08T10:33:55Z

@ceilican review pleasse

coveralls · 2018-01-08T15:40:19Z

Coverage remained the same at 45.681% when pulling 2c3620d on swagger-api into 00794b6 on master.

coveralls · 2018-01-11T10:44:03Z

Coverage remained the same at 45.681% when pulling 93d4307 on swagger-api into fd58270 on master.

Tolsi and others added 15 commits November 24, 2017 16:57

update api like in swagger document

054b8fb

peers api like in swagger docs

024e4fa

compilation fix

713f848

correct http codes on errors

612b22f

codes moved to error objects

9fec150

missed type

d88812f

default apiKeyHash is empty

81cb8d4

Merge branch 'master' into swagger-api

05a1ccb

# Conflicts: # src/main/scala/scorex/core/api/http/PeersApiRoute.scala

Utils functions was updated

9cfafda

akka http circe dependency was added

04f2127

post request

3637fdb

Merge branch 'master' into swagger-api

8fdbab1

# Conflicts: # src/main/resources/reference.conf # src/main/scala/scorex/core/api/http/NodeViewApiRoute.scala

compilation fix

df9f3db

npe fix

ba3e3f6

Merge branch 'master' of github.com:ScorexFoundation/Scorex into swag…

434275e

…ger-api

catena2w added the wip label Dec 20, 2017

catena2w added 2 commits December 20, 2017 16:53

Provide locally created yaml file for swagger

5aa0444

Correct yaml for HybridApp

5059062

swaggerYaml => swaggerConfig

1aa80b0

catena2w added 2 commits December 20, 2017 18:06

Remove annotations

603e4f1

New swagger

ec9a2e6

AxiomFlow reviewed Dec 21, 2017

View reviewed changes

Remove servers from swagger config

3b60395

catena2w added 2 commits December 21, 2017 16:32

SettingsReaders to read files as case classes

62b2a65

SettingsReaders in HybridSettings

5379653

Move take() from MemoryPool to MempoolReader

29d8205

Merge branch 'master' into swagger-api

28972ab

# Conflicts: # src/main/scala/scorex/core/api/http/PeersApiRoute.scala # src/main/scala/scorex/core/api/http/swagger/SwaggerDocService.scala

Tolsi requested review from ceilican and removed request for ceilican December 25, 2017 12:40

Tolsi removed the wip label Dec 25, 2017

ceilican reviewed Dec 26, 2017

View reviewed changes

fix failing build

8fc4d79

Merge branch 'master' of github.com:ScorexFoundation/Scorex into swag…

9c41b1f

…ger-api Conflicts: examples/src/main/scala/examples/hybrid/api/http/StatsApiRoute.scala src/main/scala/scorex/core/api/http/PeersApiRoute.scala src/main/scala/scorex/core/api/http/UtilsApiRoute.scala

Fix declared address comparison when it is None

674d12c

fix /peers/connect API

1244675

Add NodeView route to testApi.yaml

d1f0458

added tests for utils and peers routes

2c3620d

terjokhin mentioned this pull request Jan 9, 2018

Write PeersApiSpecs and UtilsApiSpecs. #142

Closed

Merge branch 'master' into swagger-api

93d4307

kushti approved these changes Jan 11, 2018

View reviewed changes

kushti merged commit a3a7522 into master Jan 11, 2018

Tolsi deleted the swagger-api branch January 11, 2018 10:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swagger api #140

Swagger api #140

catena2w commented Dec 20, 2017

coveralls commented Dec 20, 2017

coveralls commented Dec 20, 2017

coveralls commented Dec 20, 2017

coveralls commented Dec 20, 2017

AxiomFlow Dec 21, 2017

AxiomFlow Dec 21, 2017

catena2w Jan 11, 2018

AxiomFlow Dec 21, 2017

AxiomFlow Dec 21, 2017

catena2w Jan 11, 2018

coveralls commented Dec 21, 2017

coveralls commented Dec 21, 2017

coveralls commented Dec 21, 2017

ceilican commented Dec 26, 2017

ceilican left a comment

ceilican Dec 26, 2017

terjokhin Dec 26, 2017 •

edited

Loading

ceilican Dec 26, 2017

terjokhin Dec 26, 2017

ceilican Dec 26, 2017

terjokhin Dec 27, 2017

coveralls commented Dec 27, 2017

coveralls commented Jan 6, 2018

coveralls commented Jan 6, 2018

coveralls commented Jan 8, 2018

coveralls commented Jan 8, 2018

catena2w commented Jan 8, 2018

coveralls commented Jan 8, 2018

coveralls commented Jan 11, 2018

Swagger api #140

Swagger api #140

Conversation

catena2w commented Dec 20, 2017

coveralls commented Dec 20, 2017

coveralls commented Dec 20, 2017

coveralls commented Dec 20, 2017

coveralls commented Dec 20, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Dec 21, 2017

coveralls commented Dec 21, 2017

coveralls commented Dec 21, 2017

ceilican commented Dec 26, 2017

ceilican left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

terjokhin Dec 26, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Dec 27, 2017

coveralls commented Jan 6, 2018

coveralls commented Jan 6, 2018

coveralls commented Jan 8, 2018

coveralls commented Jan 8, 2018

catena2w commented Jan 8, 2018

coveralls commented Jan 8, 2018

coveralls commented Jan 11, 2018

terjokhin Dec 26, 2017 •

edited

Loading