#166: Add documentation to tapiro (closes #166) #167

calippo · 2020-02-27T15:58:38Z

Closes #2520694

⚠️ The line above was added during the automatic migration of all github project issues to Kaiten. The old GH issue link is kept here for reference (it is now deprecated, continue follow the original issue on Kaiten).

Closes #166

Test Plan

tests performed

A Test Plan is used to show what you tested to make sure your code works fine. You should write here all that you did to test, and provide some results of your testing.

These results can be screenshots, query results, or even just pointers to unit tests that successfully passed.

tests not performed (domain coverage)

At times not everything can be tested, and writing what hasn't been tested is just as important as writing what has been tested.

An example of partial test is a field displaying 4 possible values. If 3 values are tested, with screenshots, and 1 is not, then it should be mentioned here.

gabro

Nice, left some preliminary comments

docs/tapiro/installation.md

gabro · 2020-02-27T18:40:15Z

docs/tapiro/introduction.md

+- `CatsHttp4sEndpoints.scala` or `CatsAkkaHttpEndpoints.scala` depeneding on the HTTP server the user is using.
+
+The resulting routes can be simply used like this (http4s example):
+```scala


this block is not typechecked

☝️ farei un esempio più completo che effettivamente compili

Per avere esempio completo che compili servono dipendenze, per questo stavo rimandando la cosa. Faccio prima a farlo forse.

Aggiunto superesempione.

@gabro pingone

docs/tapiro/introduction.md

docs/tapiro/migrate.md

gabro · 2020-02-27T18:43:35Z

docs/tapiro/rpc.md

@@ -0,0 +1,6 @@
+---
+id: rpc


id: why

for consistency?

Link a blogpost è lì come tampone. Idea in un secondo momento era spiegare RPC, approccio etc, per questo l'ho chiamato così.

build.sbt

calippo · 2020-02-28T09:47:21Z

@gabro currently Http4s, Tapir and Http4s are not dependencies of tapiro. That's why http4s blocks are not typecheck and dependencies are not injected.

I think the right way to go is to open a new issue, where we add dependencies and unit tests to check the generated code compiles and works as expected. Documentation will be updated accordingly.

docs/tapiro/migrate.md

docs/tapiro/installation.md

docs/tapiro/migrate.md

docs/tapiro/installation.md

docs/tapiro/migrate.md

gabro · 2020-03-03T11:13:06Z

docs/tapiro/rpc.md

@@ -0,0 +1,6 @@
+---
+id: rpc


Co-Authored-By: Gabriele Petronella <[email protected]>

docs/tapiro/migrate.md

gabro · 2020-03-05T11:22:11Z

docs/tapiro/introduction.md

-    .as(ExitCode.Success)
+## Complete Example
+
+Here you have an example implementation of the `Cats` controller definied in the previous section:


Suggested change

Here you have an example implementation of the `Cats` controller definied in the previous section:

Here you have an example implementation of the `Cats` controller defined in the previous section:

docs/tapiro/introduction.md

gabro · 2020-03-05T11:25:26Z

docs/tapiro/introduction.md

+
+```
+
+Here you have the autogenerated magic fromo tapiro (This is the content of `CatsHttp4sEndpoints.scala` it will be autogenerated).


Suggested change

Here you have the autogenerated magic fromo tapiro (This is the content of `CatsHttp4sEndpoints.scala` it will be autogenerated).

Here you have the http4s endpoints auto-generated by tapiro (this would be the content of `CatsHttp4sEndpoints.scala`)

docs/tapiro/introduction.md

gabro · 2020-03-05T11:26:26Z

docs/tapiro/introduction.md

+
+```scala mdoc
+import org.http4s.server.blaze._
+import org.http4s.implicits._


serve questo import?

magari riprovo

confermo che serve per .orNotFound

🤦‍♂ ok

Co-Authored-By: Gabriele Petronella <[email protected]>

docs/tapiro/introduction.md

Co-Authored-By: Gabriele Petronella <[email protected]>

nemobot · 2020-03-05T12:14:08Z

calippo added 3 commits February 27, 2020 16:41

Add tapir dependency for documentation

db67642

Add tapiro to website

7484597

Add tapiro docs

6189df6

nemobot added the WIP label Feb 27, 2020

calippo requested a review from gabro February 27, 2020 15:58

nemobot added in review and removed WIP labels Feb 27, 2020

Use tapiro versions instead of sbt-buildo

c646a28

gabro requested changes Feb 27, 2020

View reviewed changes

nemobot added WIP and removed in review labels Feb 27, 2020

calippo added 5 commits February 28, 2020 15:28

Add tapir to docs dependencies

695d806

sbt-plugin/Sbt plugin

a01f2b2

Remove macro annotations doc

ae6cf8e

Acutal/actual

252e6f4

Add linguistic-generated explaination

453b21a

giuscri reviewed Mar 2, 2020

View reviewed changes

docs/tapiro/migrate.md Outdated Show resolved Hide resolved

giuscri reviewed Mar 2, 2020

View reviewed changes

docs/tapiro/installation.md Outdated Show resolved Hide resolved

giuscri reviewed Mar 2, 2020

View reviewed changes

docs/tapiro/installation.md Show resolved Hide resolved

giuscri reviewed Mar 2, 2020

View reviewed changes

docs/tapiro/migrate.md Outdated Show resolved Hide resolved

calippo added 3 commits March 3, 2020 11:55

Rephrase explaination about .gitattributes

bc03dcd

Add documentation about how to import tapiro Server object

1edc199

Use codeblocks where needed in linguist-generated explaination

73b0dd8

calippo commented Mar 3, 2020

View reviewed changes

docs/tapiro/installation.md Show resolved Hide resolved

gabro requested changes Mar 3, 2020

View reviewed changes

docs/tapiro/migrate.md Outdated Show resolved Hide resolved

docs/tapiro/rpc.md

@@ -0,0 +1,6 @@

---

id: rpc

Copy link

Member

gabro Mar 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

calippo and others added 3 commits March 3, 2020 16:09

Update docs/tapiro/migrate.md

f318e12

Co-Authored-By: Gabriele Petronella <[email protected]>

Add complete example

c1def6c

Remove whitespace

70dc3c2

giuscri reviewed Mar 3, 2020

View reviewed changes

docs/tapiro/migrate.md Outdated Show resolved Hide resolved

Add second type parameter to example

aebdf11

giuscri mentioned this pull request Mar 4, 2020

improve docs for tapiro #169

Closed

Inject dependencies versions

6da7938

gabro requested changes Mar 5, 2020

View reviewed changes

calippo and others added 2 commits March 5, 2020 12:50

Update docs/tapiro/introduction.md

a0bb44b

Co-Authored-By: Gabriele Petronella <[email protected]>

Update docs/tapiro/introduction.md

2c4aad5

Co-Authored-By: Gabriele Petronella <[email protected]>

gabro requested changes Mar 5, 2020

View reviewed changes

docs/tapiro/introduction.md Outdated Show resolved Hide resolved

Update docs/tapiro/introduction.md

a22e84f

Co-Authored-By: Gabriele Petronella <[email protected]>

gabro approved these changes Mar 5, 2020

View reviewed changes

nemobot added in review and removed WIP labels Mar 5, 2020

calippo merged commit f2f50e1 into master Mar 5, 2020

nemobot removed the in review label Mar 5, 2020

calippo deleted the 166-add_documentation_to_tapiro branch March 5, 2020 12:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#166: Add documentation to tapiro (closes #166) #167

#166: Add documentation to tapiro (closes #166) #167

calippo commented Feb 27, 2020 •

edited by kanbanbot

Loading

gabro left a comment

gabro Feb 27, 2020

gabro Mar 3, 2020

calippo Mar 3, 2020 •

edited

Loading

calippo Mar 3, 2020

calippo Mar 5, 2020

gabro Feb 27, 2020

calippo Feb 28, 2020

gabro Mar 3, 2020

calippo commented Feb 28, 2020 •

edited

Loading

gabro Mar 3, 2020

gabro Mar 5, 2020

gabro Mar 5, 2020

gabro Mar 5, 2020

calippo Mar 5, 2020

calippo Mar 5, 2020

calippo Mar 5, 2020

gabro Mar 5, 2020

nemobot commented Mar 5, 2020

	Here you have an example implementation of the `Cats` controller definied in the previous section:
	Here you have an example implementation of the `Cats` controller defined in the previous section:


		```

		Here you have the autogenerated magic fromo tapiro (This is the content of `CatsHttp4sEndpoints.scala` it will be autogenerated).

	Here you have the autogenerated magic fromo tapiro (This is the content of `CatsHttp4sEndpoints.scala` it will be autogenerated).
	Here you have the http4s endpoints auto-generated by tapiro (this would be the content of `CatsHttp4sEndpoints.scala`)

#166: Add documentation to tapiro (closes #166) #167

#166: Add documentation to tapiro (closes #166) #167

Conversation

calippo commented Feb 27, 2020 • edited by kanbanbot Loading

Test Plan

tests performed

tests not performed (domain coverage)

gabro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

calippo Mar 3, 2020 • 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

Choose a reason for hiding this comment

calippo commented Feb 28, 2020 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nemobot commented Mar 5, 2020

calippo commented Feb 27, 2020 •

edited by kanbanbot

Loading

calippo Mar 3, 2020 •

edited

Loading

calippo commented Feb 28, 2020 •

edited

Loading