Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@aeneasr
aeneasr committed Jun 18, 2020
1 parent 831eba5 commit 577cb54
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 24 deletions.
26 changes: 14 additions & 12 deletions docs/docs/reference/api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1092,12 +1092,12 @@ Control Policy (OACP) by using the Role ID as subject in the OACP.

Status Code **200**

| Name | Type | Required | Restrictions | Description |
| --------------- | ----------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _anonymous_ | [[oryAccessControlPolicyRole](#schemaoryaccesscontrolpolicyrole)] | false | none | [oryAccessControlPolicyRole represents a group of users that share the same role. A role could be an administrator, a moderator, a regular user or some other sort of role.] |
| » id | string | false | none | ID is the role's unique id. |
| » description | string | false | none | Description is the description of the role |
| » members | [string] | false | none | Members is who belongs to the role. |
| Name | Type | Required | Restrictions | Description |
| ------------- | ----------------------------------------------------------------- | -------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| _anonymous_ | [[oryAccessControlPolicyRole](#schemaoryaccesscontrolpolicyrole)] | false | none | [oryAccessControlPolicyRole represents a group of users that share the same role. A role could be an administrator, a moderator, a regular user or some other sort of role.] |
| » description | string | false | none | Description is the description of the role. |
| » id | string | false | none | ID is the role's unique id. |
| » members | [string] | false | none | Members is who belongs to the role. |

Status Code **500**

Expand All @@ -1117,6 +1117,7 @@ Status Code **500**
```json
[
{
"description": "string",
"id": "string",
"members": ["string"]
}
Expand Down Expand Up @@ -1267,8 +1268,8 @@ Control Policy (OACP) by using the Role ID as subject in the OACP.

```json
{
"id": "string",
"description": "string",
"id": "string",
"members": ["string"]
}
```
Expand Down Expand Up @@ -1313,8 +1314,8 @@ Status Code **500**

```json
{
"id": "string",
"description": "string",
"id": "string",
"members": ["string"]
}
```
Expand Down Expand Up @@ -1368,6 +1369,7 @@ func main() {
```javascript
const fetch = require('node-fetch');
const input = '{
"description": "string",
"id": "string",
"members": [
"string"
Expand Down Expand Up @@ -1519,8 +1521,8 @@ Status Code **500**

```json
{
"id": "string",
"description": "string",
"id": "string",
"members": ["string"]
}
```
Expand Down Expand Up @@ -1902,8 +1904,8 @@ Status Code **500**

```json
{
"id": "string",
"description": "string",
"id": "string",
"members": ["string"]
}
```
Expand Down Expand Up @@ -2895,8 +2897,8 @@ _Input for checking if a request is allowed or not._

```json
{
"id": "string",
"description": "string",
"id": "string",
"members": ["string"]
}
```
Expand All @@ -2909,8 +2911,8 @@ other sort of role._

| Name | Type | Required | Restrictions | Description |
| ----------- | -------- | -------- | ------------ | ------------------------------------------- |
| id | string | false | none | ID is the role's unique id. |
| description | string | false | none | Description is the description of the role. |
| id | string | false | none | ID is the role's unique id. |
| members | [string] | false | none | Members is who belongs to the role. |

<a id="tocSversion">version</a>
Expand Down
32 changes: 20 additions & 12 deletions docs/docs/reference/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_HOST=<value>
#
host: 127.0.0.1
host: ''

## Cross Origin Resource Sharing (CORS) ##
#
Expand All @@ -97,7 +97,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_ENABLED=<value>
#
enabled: false
enabled: true

## Allowed Origins ##
#
Expand All @@ -117,7 +117,9 @@ serve:
# > set SERVE_CORS_ALLOWED_ORIGINS=<value>
#
allowed_origins:
- '*'
- https://example.com
- https://*.example.com
- https://*.foo.example.com

## Allowed HTTP Methods ##
#
Expand All @@ -132,8 +134,11 @@ serve:
# > set SERVE_CORS_ALLOWED_METHODS=<value>
#
allowed_methods:
- CONNECT
- PUT
- GET
- TRACE
- POST
- HEAD

## Allowed Request HTTP Headers ##
#
Expand All @@ -148,7 +153,10 @@ serve:
# > set SERVE_CORS_ALLOWED_HEADERS=<value>
#
allowed_headers:
- dolor mollit ipsum
- sit do
- dolor consequat exercitation
- do
- laborum aliqua in ullamco elit

## Allowed Response HTTP Headers ##
#
Expand All @@ -163,7 +171,7 @@ serve:
# > set SERVE_CORS_EXPOSED_HEADERS=<value>
#
exposed_headers:
- cupidatat
- id commodo ut Duis voluptate

## Allow HTTP Credentials ##
#
Expand All @@ -177,7 +185,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_ALLOW_CREDENTIALS=<value>
#
allow_credentials: true
allow_credentials: false

## Maximum Age ##
#
Expand All @@ -189,7 +197,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_MAX_AGE=<value>
#
max_age: -57745217
max_age: 34098146

## Enable Debugging ##
#
Expand All @@ -203,7 +211,7 @@ serve:
# - Windows Command Line (CMD):
# > set SERVE_CORS_DEBUG=<value>
#
debug: false
debug: true

## HTTPS ##
#
Expand Down Expand Up @@ -266,7 +274,7 @@ serve:
# - Windows Command Line (CMD):
# > set PROFILING=<value>
#
profiling: mem
profiling: ''

## Log ##
#
Expand All @@ -285,7 +293,7 @@ log:
# - Windows Command Line (CMD):
# > set LOG_LEVEL=<value>
#
level: debug
level: panic

## Format ##
#
Expand All @@ -299,7 +307,7 @@ log:
# - Windows Command Line (CMD):
# > set LOG_FORMAT=<value>
#
format: json
format: text

## tracing ##
#
Expand Down

0 comments on commit 577cb54

Please sign in to comment.