Skip to content

Commit a26afe7

Browse files
committed
Fix typos an add API section to README
1 parent c1edac3 commit a26afe7

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ build dependencies which are furthermore also assumed to be in your $PATH.
5151

5252
To build Lico, a `Makefile` is provided, which requires [make](https://www.gnu.org/software/make/manual/make.html).
5353

54-
When building, third party dependencies will tried to be fetched from the Internet
54+
When building, third party dependencies will be fetched from the Internet
5555
if not there already.
5656

5757
## Building from source
@@ -99,7 +99,7 @@ this, Lico will generate a random key on startup.
9999
To run a functional OpenID Connect provider, an issuer identifier is required.
100100
The `iss` is a full qualified https:// URI pointing to the web server which
101101
serves the requests to Lico (example: https://example.com). Provide the
102-
Issuer Identifier with the `--iss` parametter when starting Lico.
102+
Issuer Identifier with the `--iss` parameter when starting Lico.
103103

104104
Furthermore to allow clients to utilize the Lico services, clients need to
105105
be known/registered. For now Lico uses a static configuration file which
@@ -149,6 +149,10 @@ The base URL of the frontend proxy is what will become the value of the `--iss`
149149
parameter when starting up Lico. OIDC requires the Issuer Identifier to be
150150
secure (https:// required).
151151

152+
## API Documentation
153+
154+
The complete API specification is available in OpenAPI 3.0 format at [`docs/libregraph-connect-api-v1.yaml`](docs/libregraph-connect-api-v1.yaml), covering all OIDC, OAuth2, authentication, and SAML2 endpoints with detailed schemas and examples.
155+
152156
### LibreGraph backend
153157

154158
Generic backend support is available through the LibreGraph API. Any service can

0 commit comments

Comments
 (0)