generated from Nlkomaru/PluginTemplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #30 from morinoparty/develop
Update docs
- Loading branch information
Showing
11 changed files
with
109 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
openapi: 3.1.0 | ||
info: | ||
title: "MineAuth" | ||
description: | | ||
This is the MineAuth API documentation.<br> | ||
This makes user access to self information on minecraft. | ||
license: | ||
name: CC0-1.0 | ||
url: "https://creativecommons.org/publicdomain/zero/1.0/" | ||
version: "1.0.0" | ||
|
||
servers: | ||
- url: "http://localhost:8080" | ||
description: "Local server" | ||
- url: "https://api.example.com" | ||
description: "Production server" | ||
|
||
components: | ||
securitySchemes: | ||
oauth2: | ||
type: oauth2 | ||
flows: | ||
authorizationCode: | ||
authorizationUrl: /oauth2/authorize | ||
tokenUrl: /oauth2/token | ||
refreshUrl: /oauth2/token | ||
scopes: | ||
profile: Grants read access for my profile | ||
all: Grants read access for my resources | ||
|
||
security: | ||
- oauth2: [ openid, profile, all ] | ||
|
||
paths: | ||
/oauth2/userinfo: | ||
get: | ||
summary: Get user information | ||
security: | ||
- oauth2: [ profile ] | ||
/oauth2/revoke: | ||
post: | ||
summary: Revoke access token | ||
security: | ||
- oauth2: [ all ] | ||
parameters: | ||
- name: token | ||
in: query | ||
required: true | ||
schema: | ||
type: string | ||
/oauth2/introspect: | ||
post: | ||
summary: Introspect access token | ||
parameters: | ||
- name: token | ||
in: query | ||
required: true | ||
schema: | ||
type: string |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Endpoints | ||
This is an endpoint list for OAuth2.0 and OpenID Connect (OIDC) for Moripa API. | ||
|
||
## Endpoints | ||
### OAuth2.0 | ||
|
||
- [x] Authorization | ||
endpoint `/oauth2/authorize` [RFC 6749 4.1.1](https://datatracker.ietf.org/doc/html/rfc6749.html#section-4.1.1) | ||
- [x] Token | ||
endpoint `/oauth2/token` [RFC 6749 4.1.3](https://datatracker.ietf.org/doc/html/rfc6749.html#section-4.1.3) | ||
- [ ] Introspection | ||
endpoint `/oauth2/introspect` [RFC 7662](https://datatracker.ietf.org/doc/html/rfc7662.html#section-2.1) | ||
- [ ] Revocation | ||
endpoint `/oauth2/revoke` [RFC 7009](https://datatracker.ietf.org/doc/html/rfc7009.html#section-2.1) | ||
|
||
|
||
### OpenID Connect (OIDC) | ||
|
||
- [ ] Discovery endpoint `/.well-known/openid-configuration` | ||
- [x] JWKs endpoint `/.well-known/jwks.json` | ||
- [x] UserInfo | ||
endpoint `/oauth2/userinfo` [OIDC Core 5.3](https://openid-foundation-japan.github.io/openid-connect-core-1_0.ja.html#UserInfo) | ||
|
||
### Plugin | ||
|
||
- Plugin endpoint `/api/v1/plugin/<pluginName>/*` |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,3 @@ | ||
# Welcome to Moripa-API Docs | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# OpenAPI | ||
|
||
!!swagger ../assets/documentation.yaml!! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters