Commit graph

432 commits

Author SHA1 Message Date
Tommi Reiman
d36c47d7b1 :reitit.ring/default-options-endpoint & :reitit.http/default-options-endpoint 2020-05-12 21:21:39 +03:00
Jacek Schæ
3766a5929e
Fix reference -- from r to router 2020-05-09 18:11:50 +02:00
Jaime Sangcap
cedd701631 add optional key example for clojure spec 2020-04-24 14:40:56 +04:00
William Seiti Mizuta
c56cd4c03e
Fix router documentation
Just a small fix on the router documentation.
2020-04-18 19:15:16 -03:00
Juho Teperi
f538208fd0 Add note about Swagger-UI 3.x :responses 2020-03-24 12:28:22 +02:00
Juho Teperi
be23cd169e Fix swagger :tags docstring 2020-03-24 11:19:00 +02:00
Juho Teperi
886d5b722e Fix documentation indeces 2020-03-10 17:00:42 +02:00
Tommi Reiman
c7b67f3366
Merge pull request #350 from rbb-data/feature/swagger-ui-v3
Update to latest ring-swagger-ui
2020-03-04 20:54:42 +02:00
Samuel J McHugh
6c458e26d0
Update dynamic_extensions.md
I find the clarity of this example important because the implementation of (ring/get-match) c23f591283/modules/reitit-ring/src/reitit/ring.cljc (L309) doesn't explain what's going on here.

I find the destructing of the qualified keyword `::roles` unnecessary to the example. To this end I propose using an unqualified keyword.

Additionally there is a collision between the name of the required rolls to access the route and the name of the roles held by the user making the request. To this end I propose having the roles held by the user named `:my-roles`
2020-02-28 14:44:05 +01:00
JC
8338015355
docs: fix grammar 2020-02-17 05:48:57 -08:00
Jon McDuffie
32bab40c71
Fix typo 2020-02-12 08:22:19 -05:00
heyarne
9de2254e01 Update docs with instructions on how to use swagger-ui 2.x 2020-02-10 15:38:29 +01:00
David Harrigan
e91d1dc957 Fix link to Exceptions Handling in Ring 2020-02-02 16:23:09 +00:00
Tommi Reiman
3ca0492244 0.4.2 2020-01-17 18:39:07 +02:00
Wanderson Ferreira
fbe2f62576 split default_middleware and merge more options to content negotiation 2020-01-16 22:50:27 -03:00
Wanderson Ferreira
45f4f2cf40 format negotiation documentation to reitit 2020-01-15 13:08:07 -03:00
Tommi Reiman
945fec23a9 0.4.1 2020-01-14 21:42:47 +02:00
Miikka Koskinen
1ad0141792 Release 0.4.0 2020-01-14 15:49:13 +02:00
Tommi Reiman
699a8c7cd3 docs 2019-12-29 11:17:20 +02:00
Ilmo Raunio
8a86701902 Allow path conflict resolution with :conflicting 2019-11-13 22:49:21 +02:00
Andrey Krasnov
bd5c67e75c Add grammar and style fixes
A couple of grammatical and stylistic changes that I think should make reading this doc a bit nicer.
2019-10-23 22:38:38 +03:00
Cody Canning
8cd314bd3f Update compiling_middleware.md regarding specs 2019-10-22 07:18:38 +03:00
Miikka Koskinen
f91638d2e4
Update doc/faq.md 2019-10-08 22:36:27 +03:00
Miikka Koskinen
5ab5e5c761
How do you pronounce "reitit"?
This truly is a frequently asked question.
2019-10-08 22:32:35 +03:00
Tommi Reiman
c23f591283 0.3.10 2019-10-08 10:28:25 +03:00
Tommi Reiman
248d6087bc
Update performance.md 2019-10-08 10:26:06 +03:00
Tommi Reiman
02ba8712a1 perf image 2019-10-08 10:20:03 +03:00
Juho Teperi
500d5d6540
Merge pull request #259 from metosin/ignore-anchor-click-fn
Ignore anchor click fn
2019-09-20 10:34:15 +03:00
Oleg
15395f8239 Fix documentation about identity
Updated the order of identity resolving according to current source.
2019-08-24 10:10:18 +03:00
Oleg
42e5746c2f Update docs for controller and identity
Fixed typos in a sentence about `start`. Also updated the information about `stop` call, looks like it will be called with last controller identity value, not return value of params
2019-08-24 10:10:18 +03:00
Juho Teperi
802c9b04c4
Merge branch 'master' into ignore-anchor-click-fn 2019-08-21 13:43:01 +03:00
Alexander Kiel
a19849fe58 Make Map Destructuring of Namespaced Keys more Beautiful
It's possible to put the :keys keyword in the namespace of the keys one likes to
destructure. With that one can use symbols in the vector again. One advantage of
having symbols is, that Cursive grays them out if not used. I found two
occurrences of unused destructured keys.
2019-07-13 17:02:41 +03:00
Greg Rynkowski
f8b5e5dccf Correct doc (obsolete example of middleware/create)
reitit.middleware/create has been removed at 927d4d43.
It seems reitit.middleware/map->Middleware is the right approach
instead.

More:
https://clojurians.slack.com/archives/C7YF1SBT3/p1561635497233300
2019-06-27 13:16:12 +01:00
Tommi Reiman
2e85f44a7e 0.3.9 2019-06-16 20:20:49 +03:00
Tommi Reiman
dd7a01b1bc 0.3.8 2019-06-15 11:49:45 +03:00
Tommi Reiman
47906df7b9 Update deps & docs 2019-06-15 11:49:11 +03:00
Tommi Reiman
46897f3927 Update docs 2019-06-09 20:46:20 +03:00
Tommi Reiman
12543b1c30 0.3.7 2019-05-25 16:00:45 +03:00
Tommi Reiman
83a0264698 Exceptions docs 2019-05-25 15:57:34 +03:00
Tommi Reiman
a314e06887 0.3.6 2019-05-23 14:37:58 +03:00
Tommi Reiman
5efdc67954
Merge pull request #281 from malesch/feature/fix-typos
Fix a bunch of typos
2019-05-22 21:47:36 +03:00
Tommi Reiman
568dbad3a3 0.3.5 2019-05-22 21:25:56 +03:00
Marcus Spiegel
8dcebcf49f Fix typos 2019-05-22 19:17:10 +02:00
Tommi Reiman
3381fe34e5 0.3.4 2019-05-20 20:14:14 +03:00
Tommi Reiman
5754974e76 Promote Error Messages on READMEs 2019-05-16 07:13:46 +03:00
Tommi Reiman
d74bcbeb71 Fix module list 2019-05-16 07:11:23 +03:00
Tommi Reiman
32fced15e8 Release 0.3.3 2019-05-16 07:03:17 +03:00
Christian Egli
b3f60abe2d
Fix a small typo 2019-05-14 11:42:00 +02:00
Tommi Reiman
16903ebe58 Update cljdoc.edn 2019-05-13 19:12:50 +03:00
Tommi Reiman
2e7729349e 0.3.2 2019-05-13 17:06:37 +03:00
Tommi Reiman
55097654dc Return of the :cljdoc.doc/tree! 2019-05-12 21:44:28 +03:00
Tommi Reiman
13c5ea7779 Don't hand-craft cljdoc tree 2019-05-12 21:16:32 +03:00
Tommi Reiman
4f4b493d30 Error docs 2019-05-12 21:16:01 +03:00
Tommi Reiman
419dd24316 Route-data validation docs 2019-05-11 22:31:58 +03:00
Dillon Redding
d8afe1b8c3
Fixing status reason phrase 2019-05-08 17:51:01 -05:00
Miikka Koskinen
f8f44b9ea6
Update doc/frontend/browser.md
Co-Authored-By: Deraen <juho.teperi@iki.fi>
2019-05-02 11:52:13 +03:00
Tommi Reiman
8c9a7a42cb Update CHANGELOG for middleware chain inspection 2019-05-01 22:24:32 +03:00
Juho Teperi
51c5aad492 Refactor ignore-anchor-click check to predicate function 2019-04-29 10:18:41 +03:00
Juho Teperi
5ffb9fc59f Add ignore-anchor-click function 2019-04-29 10:15:49 +03:00
Aaron Groom
ffc4d8e5c6
Remove extraneous word 2019-04-02 15:45:13 -04:00
Aaron Groom
aeab44e6e5
Add missing word to sentence 2019-04-02 15:44:24 -04:00
Aaron Groom
75149b595f
Remove unneeded comma 2019-04-02 15:43:57 -04:00
Juho Teperi
4cd63a4e62 Mention browser history stack manipulation in docs 2019-03-22 08:42:28 +02:00
Tommi Reiman
ed7b580c9a Bracket-syntax is available since 0.3.0 2019-03-19 13:23:04 +02:00
Tommi Reiman
a0d833e645 0.3.1 2019-03-18 08:27:25 +02:00
Tommi Reiman
d21dd03dfa 0.3.0 2019-03-17 14:22:15 +02:00
Miikka Koskinen
d0e43c17a2 Announce that we use Break Versioning 2019-03-14 09:50:21 +02:00
Tommi Reiman
ec4a22a539 added :basePath example, relates to #233 2019-03-08 08:48:37 +02:00
Alex King
3f05328a68
Update shared routes doc
Added missing require.
Removed use of `or` and added the else branch to the `if` statement.
2019-03-05 12:00:29 +01:00
Tommi Reiman
a2843dd097 New reitit-dev module for pretty errors 2019-03-03 20:54:21 +02:00
Tommi Reiman
778a8b97b9 Review small fixes 2019-02-28 12:12:28 +02:00
Miikka Koskinen
358f6d8932 Update doc/basics/route_syntax.md
Co-Authored-By: ikitommi <tommi@iki.fi>
2019-02-28 12:12:28 +02:00
Tommi Reiman
885ca8813c Update docs, including brackets 2019-02-28 12:12:28 +02:00
Tommi Reiman
dc2519238a More perf tests 2019-02-28 12:12:28 +02:00
Tommi Reiman
9422cd28c1 create empty path-parameters at creation time, 266ns->251ns (-6%) 2019-02-28 12:12:28 +02:00
Tommi Reiman
c87bc099b0 char-array is faster, re-run tests 2019-02-28 12:10:01 +02:00
Tommi Reiman
ce80f83319 :segment-router -> :trie-router 2019-02-28 12:10:01 +02:00
Tommi Reiman
25287e0df7 One more time for the... 2019-02-20 09:04:54 +02:00
Tommi Reiman
dcd96c3dae Deeply nested coercion docs 2019-02-20 08:50:34 +02:00
Tommi Reiman
50ae7b3bc0 Even better docs! 2019-02-20 08:45:24 +02:00
Tommi Reiman
319c768b35 Example of deeply-nested spec 2019-02-20 08:28:26 +02:00
Tommi Reiman
325b77c56d Better ring coercion docs 2019-02-20 08:04:03 +02:00
Juho Teperi
bcfa7878ea Tune wording 2019-02-08 10:23:31 +02:00
Juho Teperi
9e30836839 Update controller docs 2019-02-08 10:22:29 +02:00
Juho Teperi
5abdb74424 Improved frontend docs 2019-02-08 10:21:19 +02:00
Tommi Reiman
6dd1d862b8 one more time for the... 2019-01-30 16:33:30 +02:00
Tommi Reiman
ccb68ed4bd gitbook entry too, grnblah. 2019-01-30 16:31:19 +02:00
Tommi Reiman
91af1e1a91 update cljdoc entry 2019-01-30 16:28:46 +02:00
Tormod Mathiesen
091f9002fc
Create RESTful_form_methods.md
After a short conversation on the clojurians slack, this is an example of how to do the "RESTful form method" pattern with reitit.
2019-01-30 14:45:02 +01:00
tjalkane
0db25a305c Fix: typos in documentation 2019-01-27 22:15:03 +02:00
Tommi Reiman
d2d5019d0f 0.2.13 2019-01-26 16:20:19 +02:00
Tommi Reiman
7ec5c79cad Release 0.2.12 2019-01-18 08:56:23 +02:00
Tommi Reiman
d203832667 0.2.11 2019-01-17 19:43:45 +02:00
Tommi Reiman
0bde5cffff Move pretty printing docs to right place 2019-01-17 19:40:32 +02:00
Tommi Reiman
d1d02b232d
Merge pull request #204 from kalekale/spec-coercion-error-docs
Add something to the docs about printing readable spec coercion errors
2019-01-17 19:31:10 +02:00
Tommi Reiman
5bd933a10c docs 2019-01-15 22:04:50 +02:00
kalekale
ffecaabb8d Add something to the docs about printing readable spec coercion errors 2019-01-15 10:14:04 +02:00
Tommi Reiman
e7bf1000b9 More perf docs 2019-01-14 21:53:37 +02:00
Tommi Reiman
4c722d628e Calfpath-data 2019-01-14 17:27:16 +02:00
Tommi Reiman
408b30eaba Release 0.2.10 2018-12-30 17:48:27 +02:00
Tommi Reiman
4a986afe74 Link sample apps 2018-12-30 17:42:36 +02:00
Tommi Reiman
dece45f036 Update docs 2018-12-30 17:32:05 +02:00
Tommi Reiman
2ec29b8f9d Polish docs 2018-12-30 16:53:15 +02:00
Tommi Reiman
8081fe1a49 0.2.10-alpha1 2018-12-27 16:45:33 +02:00
Tommi Reiman
998656a9ac Enchance docs 2018-12-27 16:01:31 +02:00
Tommi Reiman
f524459768
Merge pull request #197 from metosin/reitit-pedestal
Reitit pedestal
2018-12-26 15:48:43 +02:00
Tommi Reiman
8e0aaf7ae8 Reitit-pedestal 2018-12-26 15:43:26 +02:00
Tommi Reiman
48961c9ed4 quarantine-router 2018-12-22 10:37:18 +02:00
Tommi Reiman
147034d914 Update swagger-guide, fixes #180 2018-12-09 20:16:32 +02:00
Miikka Koskinen
adb27f445d Some documentation for controllers 2018-11-30 18:07:41 +02:00
Miikka Koskinen
d827f05a6a Docs: Add a note about Swagger needing Muuntaja 2018-11-22 09:23:13 +02:00
Tommi Reiman
0e73b883ed 0.2.9 2018-11-21 16:03:09 +02:00
Tommi Reiman
dd6b07aa0f Release 0.2.8 2018-11-18 22:31:13 +02:00
Tommi Reiman
a205d14afc Update to 0.2.7 with new spec-tools 2018-11-11 22:03:16 +02:00
Tommi Reiman
69592c0f68 Bump up top 0.2.6 2018-11-09 15:41:13 +02:00
Shaun Mahood
4016acb8ea
Update docs for slash-handler
Composing routes isn't explained until later, so anyone reading the docs from start to finish would not know how to use the default-handler and slash-handler together until they read the resource-handler section. Took me a bit of time to realize this so hopefully something like this would save a bit of work for other new users.
2018-11-05 14:24:17 -07:00
Tommi Reiman
2c58205e85 Better Exception docs 2018-10-31 19:25:21 +02:00
Tommi Reiman
fdbab455bd 0.2.5 2018-10-30 20:25:14 +02:00
Tommi Reiman
2b0700f887 Update Gitbook docs 2018-10-30 19:53:48 +02:00
Unknown
1fc4fc7f60 Add docs 2018-10-31 00:10:04 +09:00
Tommi Reiman
69aeb9adcc Release 0.2.4 2018-10-21 20:37:35 +03:00
Tommi Reiman
cb14cf017a Update to spec-tools 0.8.0-SNAPSHOT 2018-10-21 20:06:28 +03:00
Tommi Reiman
ea6682b385 Update CHANGELOG & Docs 2018-10-16 20:32:40 +03:00
Laura Macchini
49cbb33aa4
fix typo 2018-10-15 10:59:13 +02:00
Hannu Hartikainen
9e05d58880
Fix reader conditional example
The previous example only worked by accident (because there was an even number of map keys with conditional values).

{:get #?(:clj 1), :post #?(:clj 2)} gets read as {:get :post} in a non-clj context. The splicing reader conditional or a :cljs (or :default) value is needed to have the code work as intended. Here we change the docs to use the splicing version, as that is (imho) more beautiful than adding another branch.
2018-10-05 13:27:56 +03:00
Tommi Reiman
31d2bc5832 fix doc 2018-10-03 08:36:59 +03:00
Tommi Reiman
f5ee149929 Release 0.2.3 2018-09-24 20:51:43 +03:00
Tommi Reiman
f14c982202 Fix docs based on Miikka's comments 2018-09-24 19:21:19 +03:00
Tommi Reiman
da1cbf7121 Generate options-endpoints for ring by default 2018-09-23 10:52:17 +03:00
Tommi Reiman
0de842585f add docs 2018-09-22 21:42:01 +03:00
Tommi Reiman
d81f20ae79 0.2.2 2018-09-09 22:29:00 +03:00
Tommi Reiman
f930a76e97 docs 2018-09-09 21:53:10 +03:00
Tommi Reiman
b50c03a0b9 better docs 2018-09-09 21:50:23 +03:00
Tommi Reiman
5698c8861b doc the new module 2018-09-08 10:57:32 +03:00
Tommi Reiman
165b8e117c Interceptor docs 2018-09-08 10:42:01 +03:00
Tommi Reiman
d3baab9476 no wip 2018-09-08 00:05:59 +03:00
Tommi Reiman
015eccd115 default interceptor docs 2018-09-08 00:05:55 +03:00
Tommi Reiman
d44911a4c4 doxument parameters-middleware 2018-09-07 23:46:26 +03:00
Tommi Reiman
713dce4333 don't use wrap-params 2018-09-07 23:39:55 +03:00
Tommi Reiman
5cc3486506
Merge pull request #121 from KingMob/feature/encode-routes
URL-encode supplied routes?
2018-09-06 08:35:13 +03:00
Matthew Davidson
656b01752a Add note about not encoding paths to docs 2018-09-05 19:39:36 -04:00
Tommi Reiman
4506284054 spec warning 2018-09-05 22:18:32 +03:00
Tommi Reiman
fa90d12eb8 0.2.1 with updated deps 2018-09-04 18:15:23 +03:00
Tommi Reiman
7345908102 empty attrs 2018-09-04 18:05:18 +03:00
Tommi Reiman
be328f5e9c fix cljdoc 2018-09-04 17:58:12 +03:00
Tommi Reiman
1324fb3540 polish 2018-09-04 17:47:52 +03:00
Tommi Reiman
ac86d550b5 0.2.0 2018-09-03 19:44:59 +03:00
Tommi Reiman
dda76fc7f1 cleanup version 2018-09-03 19:07:44 +03:00
Tommi Reiman
b3a24f2908 http 2018-09-02 19:40:25 +03:00
Tommi Reiman
c487b27288 initial rework 2018-09-02 19:23:18 +03:00
Tommi Reiman
2c51f051de 0.2.0-alpha1 2018-09-02 17:52:19 +03:00
Tommi Reiman
1a9792fd93 redoc 2018-08-31 10:48:13 +03:00
Tommi Reiman
f9e2331539 docs 2018-08-25 15:29:45 +03:00
Tommi Reiman
c1a747857f reitit-sieppari & small fixes 2018-08-25 13:30:54 +03:00
Tommi Reiman
8603224546 docs 2018-08-25 13:28:44 +03:00
Tommi Reiman
31116504c8 docs++ 2018-08-24 18:37:32 +03:00
Juho Teperi
0591635b7b Typo 2018-08-23 10:42:43 +03:00
Juho Teperi
6dbd864468 Add some frontend docs 2018-08-23 10:41:13 +03:00
Tommi Reiman
e04d73eff7 . 2018-08-22 22:56:39 +03:00
Tommi Reiman
e2da118de7 docs 2018-08-22 22:45:13 +03:00
Tommi Reiman
e19c54ee92 links to docs 2018-08-22 21:58:20 +03:00
Tommi Reiman
c3c4f12e9a docs 2018-08-22 21:55:03 +03:00
Tommi Reiman
7b3aa5e631 better docs 2018-08-22 21:51:02 +03:00
Tommi Reiman
cef7de58d3 Interceptor docs 2018-08-22 20:24:17 +03:00
Tommi Reiman
a78f70345b better docs 2018-08-22 20:06:09 +03:00
Tommi Reiman
0d165e799f fix docs 2018-08-03 13:31:21 +03:00
Tommi Reiman
ad0ef978fb middleware docs 2018-08-02 16:20:39 +03:00
Tommi Reiman
cc00ddb97c exception mw docs 2018-08-02 16:12:32 +03:00
Tommi Reiman
82fac3ee9c docs 2018-08-02 16:12:32 +03:00
Tommi Reiman
bb4f861f00 0.2.0-SNAPSHOT 2018-07-28 12:07:16 +03:00
Tommi Reiman
8321589f04 Polish docs 2018-07-28 12:01:12 +03:00
Tommi Reiman
e879e66f26 Update guide 2018-07-26 16:25:07 +03:00
Tommi Reiman
ef7a91697f polish 2018-07-25 11:17:05 +03:00
Tommi Reiman
6aa86cd055 typo 2018-07-25 11:08:11 +03:00
Tommi Reiman
04bb5cd2f0 fix example 2018-07-25 10:57:53 +03:00
Tommi Reiman
3b9130e640 composing routers 2018-07-25 10:55:33 +03:00
Tommi Reiman
48509fefbd fix routes 2018-07-21 10:02:08 +03:00
Tommi Reiman
16856749b1 handle name conflicts in router 2018-07-21 09:48:07 +03:00
Tommi Reiman
8b6bc9bb80 [:swagger :id] defaults to :reitit.swagger/default 2018-07-21 09:38:44 +03:00
Tommi Reiman
7fcefdd428 typo 2018-07-18 13:20:39 +03:00
Tommi Reiman
ffe1009a18 docs 2018-07-18 13:11:51 +03:00
Tommi Reiman
9c573823b2 Fix fronend doc links 2018-07-18 12:24:41 +03:00
Tommi Reiman
346fbad775 Fix #109 2018-07-16 09:34:52 +03:00
Juho Teperi
73b1efd5b3 Initialize empty frontend docs 2018-07-12 12:49:14 +03:00
Juho Teperi
264981fd3d Start version 0.1.4 2018-07-12 12:49:14 +03:00
Tommi Reiman
79d8e1bb91 0.1.3 2018-06-25 17:50:36 +03:00
Tommi Reiman
cb0297ac85 reverse-routing docs 2018-06-25 10:33:27 +03:00
Tommi Reiman
18bd2e684f bump up version (all but docs) 2018-06-24 22:32:23 +03:00
Tommi Reiman
d4700016e7 reaped’ 2018-06-14 13:30:17 +03:00
Tommi Reiman
6a89437b35 Reverse-routing docs 2018-06-14 13:28:08 +03:00
Miikka Koskinen
c58afb560f
Merge pull request #99 from kanwei/patch-1
Typos
2018-06-13 09:27:05 +03:00
Kanwei Li
352c5b7185
Typos 2018-06-10 00:45:23 -04:00
Kanwei Li
da03f29bcb
Typos 2018-06-07 18:17:33 -04:00
Tommi Reiman
6b95fab88c 0.1.2 2018-06-06 10:43:59 +03:00
Tommi Reiman
8d58cbc71f Fix example 2018-06-06 10:34:23 +03:00
Tharaka Manawardhana
4d2114856f
Update static.md 2018-06-05 22:21:19 +10:00
Tommi Reiman
578cad797e helping cljdoc 2018-05-29 23:18:06 +03:00
Tommi Reiman
7acf3f3357
Update configuring_routers.md 2018-05-29 16:03:25 +03:00
Tommi Reiman
91abf8db51 close markdown row 2018-05-22 11:53:31 +03:00
Tommi Reiman
fc71947bbb 0.1.1 2018-05-20 21:55:46 +03:00