Commit graph

432 commits

Author SHA1 Message Date
zengxinhui
f3a686026f
update r/routes output
`nil` should not be there.
2021-10-13 02:54:40 -04:00
zengxinhui
04225b0eff
update r/routes output
The `nil`s are not there and need to be removed.
2021-10-13 02:41:07 -04:00
mike
1737e19214
Fix typo in Swagger doc 2021-10-05 12:51:21 -05:00
Dennis Schridde
ef0aeaa7c4
Link to #134 from parameters-middleware refactoring note 2021-10-01 01:44:36 +02:00
Tommi Reiman
8694d312f8 0.5.15 2021-08-05 18:46:29 +03:00
Tommi Reiman
db84daca95 0.5.14 2021-08-03 13:41:27 +03:00
Phil Hofmann
478ee18a32 improve some docs 2021-07-27 18:33:17 +02:00
Timo Kramer
38ec679207 Extend the docs to mention the operationID 2021-05-29 11:48:57 +02:00
Ronny Løvtangen
1494641ab8
Update content_negotiation.md
Not 100% sure, but looks like it should be :date-format, not :data-format here, based on the example in the section above.
2021-04-24 22:20:16 +02:00
Miikka Koskinen
caa571cd66
Update development.md 2021-04-23 17:55:47 +03:00
Miikka Koskinen
2638041e0c
Update development.md 2021-04-23 17:53:53 +03:00
Miikka Koskinen
51a26ed052 Release 0.5.13 2021-04-23 17:41:40 +03:00
Zaymon
388f825d4d
Update README.md 2021-04-12 13:39:15 +10:00
Miikka Koskinen
d0e83fed41 Merge remote-tracking branch 'origin/master' into feature/update-static-handler-docs 2021-04-09 14:49:56 +03:00
Natxo Cabré
722bd8950f removed blank line 2021-03-12 13:33:47 +01:00
Natxo Cabré
1e76ea8114 fixed malli create example 2021-03-12 13:24:28 +01:00
Natxo Cabré
26c4ebc645 defined router var so the merged route tree example returns the commented data structure 2021-03-12 12:57:13 +01:00
Natxo Cabré
c5bb467402 fix route_conflicts link 2021-03-12 12:50:51 +01:00
Natxo Cabré
5831f2f4f6 fixed typo in explicitely 2021-03-12 12:45:55 +01:00
Miikka Koskinen
fb5eb1ff98
Update development.md 2021-03-05 20:45:28 +02:00
Miikka Koskinen
8567550ad9 Document serving static resources from the file system 2021-03-02 08:39:51 +02:00
Miikka Koskinen
b6d9707b53 Copy file & resource handler docstring update to docs 2021-03-02 08:28:36 +02:00
Kari Marttila
60fee31733 Missing curly brace in documentation - I noticed this while trying the example in REPL 2021-02-20 21:00:59 +02:00
Tommi Reiman
f43a8311fc 0.5.12 2021-02-04 20:40:25 +02:00
Tommi Reiman
0ecc2fb9a7
Merge pull request #456 from raphaelsaunier/fix/relative-urls-in-doc
Fix relative links in documentation
2021-01-10 18:10:53 +02:00
Tommi Reiman
b4099169be 0..5.11 with updated deps 2020-12-27 22:50:02 +02:00
Steven Deobald
7fb720ef36 Handle nil for lower-case
- when "_method" is actually empty, we need to avoid trying to
  do string manipulation on nil from params.
2020-12-15 19:29:50 -06:00
Steven Deobald
a3b251449b Downcase hidden methods in RESTful example
- this documentation is mildly confusing when combined with hiccup's
  `form-to` since hiccup forcibly transforms the method specified in
  its convenience syntax: `(form-to [:delete "/my-url"] ... )` into an
  upper-case string:
  80e48352dd/src/hiccup/form.clj (L130)

- it's also common to get an upper-case string from elsewhere so it
  seems best to wrap the hidden `_method` in `lower-case`.
2020-12-15 15:48:00 -06:00
Raphaël Saunier
c539c53ae2 Fix broken links in documentation 2020-12-01 10:00:20 +01:00
Teodor Heggelund
d1b8e1b98b Link to docs for Malli coercion 2020-11-01 16:49:03 +01:00
Tommi Reiman
0b2c4d0d8e 0.5.10 2020-10-22 00:10:52 +03:00
Tommi Reiman
dbf3751815 0.5.9 2020-10-19 10:46:38 +03:00
Tommi Reiman
ff647f3a2c 0.5.8 2020-10-19 08:31:29 +03:00
Tommi Reiman
8c3ad99276 0.5.7 2020-10-18 20:43:24 +03:00
Kimmo Koskinen
b51374fec2
Update example, :params -> :parameters 2020-10-14 10:08:20 +03:00
Tommi Reiman
5e290db106 0.5.6 2020-09-26 16:08:34 +03:00
Pertti Kellomäki
8ae0a4ccd4
Update basics.md
My pet peeve ;-)
Few = hardly any.
A few  = a couple
Some = a few or maybe more.
2020-09-04 21:49:56 +03:00
Kevin Liu
218cd4be69
Fix rfe/start! example arity
The second arg should be the on-navigate callback and the opts should be the third arg.
2020-08-16 19:54:20 -07:00
Miikka Koskinen
afd0af83be Point to cljdoc for documentation
Fixing all the links in CHANGELOG.md would have been too much work, so I
just left them as-is. I've converted the pages under
https://metosin.github.io/reitit/ to redirects, so the links should
work anyway.

Closes https://github.com/metosin/reitit/issues/426
2020-07-28 13:15:10 +03:00
Miikka Koskinen
aa833ac200
Merge pull request #418 from Koura/fix-docs-wording
Improve wording for interceptors documentation
2020-07-24 14:02:50 +03:00
Tommi Reiman
43e1a520d6 0.5.5 2020-07-15 11:28:11 +03:00
Tommi Reiman
274d527d2f 0.5.4 (with latest malli) 2020-07-13 11:08:19 +03:00
tjalkane
807b75f7c0 Improve wording for interceptors documentation 2020-07-10 15:46:28 +03:00
Tommi Reiman
56cbd67abd 0.5.3 2020-07-09 22:06:04 +03:00
J Hacksworth
bb4a7502fb Fix link in default_middleware.md
"Content Negotation" was moved to its own page. This commit adds a
section with a link to the new page, similar to the way the "Exception
Handling" section is presented.
2020-06-02 10:45:26 -04:00
Tommi Reiman
e30e739a15 0.5.2 2020-05-27 08:32:38 +03:00
Tommi Reiman
e649ed22b9 New options for malli coercion 2020-05-26 08:09:35 +03:00
Peter Nagy
efe07e3d5d
fix negation -> negotiation middleware
that was a funny typo!
2020-05-21 22:19:32 +02:00
Tommi Reiman
50f0120e8c 0.5.1 2020-05-18 15:00:28 +03:00
Tommi Reiman
500a4cc809 0.5.0 2020-05-17 18:42:33 +03:00
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