Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Mar 27, 2024
1 parent 5296d10 commit 7bce8a0
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions README.md
View file
Expand Up @@ -64,35 +64,35 @@ This system uses following environment variables to configure the server:

<a id="x-28-23A-28-2821-29-20BASE-CHAR-20-2E-20-2240ANTS-OPENRPC-2FCLIENT-22-29-20PACKAGE-29"></a>

##### [package](7084) `40ants-openrpc/client`
##### [package](2ee9) `40ants-openrpc/client`

<a id="x-2840ANTS-OPENRPC-DOCS-2FINDEX-3A-3A-7C-4040ANTS-OPENRPC-2FCLIENT-3FMacros-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

##### Macros

<a id="x-2840ANTS-OPENRPC-2FCLIENT-3AGENERATE-CLIENT-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29"></a>

###### [macro](bc6e) `40ants-openrpc/client:generate-client` name url
###### [macro](3f4a) `40ants-openrpc/client:generate-client` name url

<a id="x-2840ANTS-OPENRPC-DOCS-2FINDEX-3A-3A-4040ANTS-OPENRPC-2FJWT-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### 40ANTS-OPENRPC/JWT

<a id="x-28-23A-28-2818-29-20BASE-CHAR-20-2E-20-2240ANTS-OPENRPC-2FJWT-22-29-20PACKAGE-29"></a>

##### [package](f741) `40ants-openrpc/jwt`
##### [package](51b6) `40ants-openrpc/jwt`

<a id="x-2840ANTS-OPENRPC-DOCS-2FINDEX-3A-3A-7C-4040ANTS-OPENRPC-2FJWT-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

##### Functions

<a id="x-2840ANTS-OPENRPC-2FJWT-3ADECODE-20FUNCTION-29"></a>

###### [function](d5fa) `40ants-openrpc/jwt:decode` token
###### [function](158d) `40ants-openrpc/jwt:decode` token

<a id="x-2840ANTS-OPENRPC-2FJWT-3AISSUE-TOKEN-20FUNCTION-29"></a>

###### [function](a239) `40ants-openrpc/jwt:issue-token` payload &key ttl
###### [function](0c73) `40ants-openrpc/jwt:issue-token` payload &key ttl

Encodes payload into a `JWT` token.

Expand All @@ -104,27 +104,27 @@ If `TTL` argument is given, it should be specified in seconds. After this number

<a id="x-2840ANTS-OPENRPC-2FJWT-3AWITH-SESSION-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29"></a>

###### [macro](a462) `40ants-openrpc/jwt:with-session` ((&REST BINDINGS) &KEY (REQUIRE T) (PROCESSORS '(("roles" . ENSURE-LIST-OF-KEYWORDS)))) &BODY BODY
###### [macro](dce3) `40ants-openrpc/jwt:with-session` ((&REST BINDINGS) &KEY (REQUIRE T) (PROCESSORS '(("roles" . ENSURE-LIST-OF-KEYWORDS)))) &BODY BODY

<a id="x-2840ANTS-OPENRPC-2FJWT-3AWITH-TEST-TOKEN-20-2840ANTS-DOC-2FLOCATIVES-3AMACRO-29-29"></a>

###### [macro](ebcd) `40ants-openrpc/jwt:with-test-token` (token) &body body
###### [macro](3a89) `40ants-openrpc/jwt:with-test-token` (token) &body body

<a id="x-2840ANTS-OPENRPC-DOCS-2FINDEX-3A-3A-4040ANTS-OPENRPC-2FSERVER-3FPACKAGE-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

#### 40ANTS-OPENRPC/SERVER

<a id="x-28-23A-28-2821-29-20BASE-CHAR-20-2E-20-2240ANTS-OPENRPC-2FSERVER-22-29-20PACKAGE-29"></a>

##### [package](f63c) `40ants-openrpc/server`
##### [package](e3c5) `40ants-openrpc/server`

<a id="x-2840ANTS-OPENRPC-DOCS-2FINDEX-3A-3A-7C-4040ANTS-OPENRPC-2FSERVER-3FFunctions-SECTION-7C-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

##### Functions

<a id="x-2840ANTS-OPENRPC-2FSERVER-3ASTART-20FUNCTION-29"></a>

###### [function](953c) `40ants-openrpc/server:start` &key (port \*default-port\*) (api openrpc-server/api::default-api) (interface \*default-interface\*) (debug nil)
###### [function](29f1) `40ants-openrpc/server:start` &key (port \*default-port\*) (api openrpc-server/api::default-api) (interface \*default-interface\*) (debug nil)

Starts Open `RPC` `API` server on given `PORT` and `INTERFACE`.
Also it configures logging and Slynk.
Expand All @@ -134,14 +134,14 @@ You will find more details in the [`40ants-slynk`][04ac] system documentation.

<a id="x-2840ANTS-OPENRPC-2FSERVER-3ASTART-IN-PRODUCTION-20FUNCTION-29"></a>

###### [function](cfc7) `40ants-openrpc/server:start-in-production` &key (api openrpc-server/api::default-api)
###### [function](e6dd) `40ants-openrpc/server:start-in-production` &key (api openrpc-server/api::default-api)

Entry point for `API` webserver, started in the Docker or Kubernetes.
It works like a [`start`][999c] but blocks forever.

<a id="x-2840ANTS-OPENRPC-2FSERVER-3ASTOP-20FUNCTION-29"></a>

###### [function](e801) `40ants-openrpc/server:stop` &key (port \*default-port\*) (interface \*default-interface\*)
###### [function](0a77) `40ants-openrpc/server:stop` &key (port \*default-port\*) (interface \*default-interface\*)

Stops `API` server running on given `PORT` and `INTERFACE`.

Expand All @@ -153,17 +153,17 @@ Stops `API` server running on given `PORT` and `INTERFACE`.
[04ac]: https://40ants.com/slynk/#x-28-23A-28-2812-29-20BASE-CHAR-20-2E-20-2240ants-slynk-22-29-20ASDF-2FSYSTEM-3ASYSTEM-29
[8702]: https://github.com/40ants/40ants-openrpc
[bc95]: https://github.com/40ants/40ants-openrpc/actions
[7084]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/client.lisp#L1
[bc6e]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/client.lisp#L36
[f741]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/jwt.lisp#L1
[d5fa]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/jwt.lisp#L31
[a239]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/jwt.lisp#L35
[ebcd]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/jwt.lisp#L62
[a462]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/jwt.lisp#L83
[f63c]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/server.lisp#L1
[cfc7]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/server.lisp#L100
[953c]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/server.lisp#L45
[e801]: https://github.com/40ants/40ants-openrpc/blob/f4b538ba6a5767f0a42a5a412efd5bb646810336/src/server.lisp#L90
[2ee9]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/client.lisp#L1
[3f4a]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/client.lisp#L36
[51b6]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/jwt.lisp#L1
[158d]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/jwt.lisp#L31
[0c73]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/jwt.lisp#L35
[3a89]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/jwt.lisp#L59
[dce3]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/jwt.lisp#L80
[e3c5]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/server.lisp#L1
[e6dd]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/server.lisp#L100
[29f1]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/server.lisp#L45
[0a77]: https://github.com/40ants/40ants-openrpc/blob/5296d105262c9c580430cbcca603726cea8b29b6/src/server.lisp#L90
[a84b]: https://github.com/40ants/40ants-openrpc/issues
[422a]: https://quickdocs.org/40ants-logging
[2e1d]: https://quickdocs.org/40ants-slynk
Expand Down

0 comments on commit 7bce8a0

Please sign in to comment.