Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: schema fixes #2375

Merged
merged 12 commits into from
Apr 16, 2022
Merged

docs: schema fixes #2375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d5bc343
refactor: turn uiNodeType into enum
woylie Apr 7, 2022
a44c9c8
docs: add missing value
woylie Apr 7, 2022
d9ac27b
refactor: rename Type to NodeType
woylie Apr 7, 2022
98cdff4
docs(swagger): make uiNodeType and uiNodeGroup enums
zepatrik Apr 7, 2022
8d9e32a
docs(swagger): update discriminator to match node type values
woylie Apr 7, 2022
df4acc4
chore: add makefile tasks for API documentation preview
woylie Apr 7, 2022
268b5d6
docs(swagger): mark type as required for all flows
woylie Apr 7, 2022
14c9161
refactor: turn uiNodeType into enum
woylie Apr 7, 2022
1177d80
refactor: rename Type to NodeType
woylie Apr 7, 2022
976c565
docs(swagger): make uiNodeType and uiNodeGroup enums
zepatrik Apr 7, 2022
35b7d5d
refactor: rename Type to UiNodeType
woylie Apr 14, 2022
3ed9d35
refactor: rename Group to UiNodeGroup
woylie Apr 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .schema/openapi/patches/schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
mapping:
input: "#/components/schemas/uiNodeInputAttributes"
text: "#/components/schemas/uiNodeTextAttributes"
image: "#/components/schemas/uiNodeImageAttributes"
anchor: "#/components/schemas/uiNodeAnchorAttributes"
img: "#/components/schemas/uiNodeImageAttributes"
a: "#/components/schemas/uiNodeAnchorAttributes"
script: "#/components/schemas/uiNodeScriptAttributes"
- op: add
path: /components/schemas/uiNodeAttributes/oneOf
Expand Down
8 changes: 8 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ $(call make-lint-dependency)
docs/cli:
go run ./cmd/clidoc/. .

.PHONY: docs/api
docs/api:
npx @redocly/openapi-cli preview-docs spec/api.json

.PHONY: docs/swagger
docs/swagger:
npx @redocly/openapi-cli preview-docs spec/swagger.json
Comment on lines +42 to +48
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that's nice 👍


.bin/ory: Makefile
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b .bin ory v0.1.14
touch -a -m .bin/ory
Expand Down
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,3 +578,12 @@ To prepare documentation tests, run `npm i` to install

- test all documentation: <code type="make/command">make test-docs</code>
- test an individual file: <code type="npm/installed-executable">text-run</code>

#### Preview API documentation

- update the SDK including the OpenAPI specification:
<code type="make/command">make sdk</code>
- run preview server for API documentation: <code type="make/command">make
docs/api</code>
- run preview server for swagger documentation: <code type="make/command">make
docs/swagger</code>
126 changes: 94 additions & 32 deletions internal/httpclient/api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3461,8 +3461,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
- meta:
label:
context: '{}'
Expand All @@ -3478,8 +3478,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
method: method
action: action
messages:
Expand Down Expand Up @@ -3593,8 +3593,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
- meta:
label:
context: '{}'
Expand All @@ -3610,8 +3610,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
method: method
action: action
messages:
Expand Down Expand Up @@ -3670,6 +3670,7 @@ components:
- issued_at
- request_url
- state
- type
- ui
title: A Recovery Flow
type: object
Expand Down Expand Up @@ -3727,8 +3728,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
- meta:
label:
context: '{}'
Expand All @@ -3744,8 +3745,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
method: method
action: action
messages:
Expand Down Expand Up @@ -3797,6 +3798,7 @@ components:
- id
- issued_at
- request_url
- type
- ui
type: object
selfServiceSettingsFlow:
Expand Down Expand Up @@ -3824,8 +3826,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
- meta:
label:
context: '{}'
Expand All @@ -3841,8 +3843,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
method: method
action: action
messages:
Expand Down Expand Up @@ -3949,6 +3951,7 @@ components:
- issued_at
- request_url
- state
- type
- ui
title: Flow represents a Settings Flow
type: object
Expand Down Expand Up @@ -3988,8 +3991,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
- meta:
label:
context: '{}'
Expand All @@ -4005,8 +4008,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
method: method
action: action
messages:
Expand Down Expand Up @@ -4964,8 +4967,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
- meta:
label:
context: '{}'
Expand All @@ -4981,8 +4984,8 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
method: method
action: action
messages:
Expand Down Expand Up @@ -5035,12 +5038,23 @@ components:
id: 0
text: text
type: type
type: type
group: group
type: text
group: default
properties:
attributes:
$ref: '#/components/schemas/uiNodeAttributes'
group:
description: Group specifies which group (e.g. password authenticator) this
node belongs to.
enum:
- default
- password
- oidc
- profile
- link
- totp
- lookup_secret
- webauthn
type: string
messages:
items:
Expand All @@ -5049,6 +5063,13 @@ components:
meta:
$ref: '#/components/schemas/uiNodeMeta'
type:
description: The node's type
enum:
- text
- input
- img
- a
- script
type: string
required:
- attributes
Expand All @@ -5070,6 +5091,15 @@ components:
description: A unique identifier
type: string
node_type:
description: |-
NodeType represents this node's types. It is a mirror of `node.type` and
is primarily used to allow compatibility with OpenAPI 3.0.
enum:
- text
- input
- img
- a
- script
type: string
title:
$ref: '#/components/schemas/uiText'
Expand All @@ -5083,8 +5113,8 @@ components:
uiNodeAttributes:
discriminator:
mapping:
anchor: '#/components/schemas/uiNodeAnchorAttributes'
image: '#/components/schemas/uiNodeImageAttributes'
a: '#/components/schemas/uiNodeAnchorAttributes'
img: '#/components/schemas/uiNodeImageAttributes'
input: '#/components/schemas/uiNodeInputAttributes'
script: '#/components/schemas/uiNodeScriptAttributes'
text: '#/components/schemas/uiNodeTextAttributes'
Expand All @@ -5096,8 +5126,6 @@ components:
- $ref: '#/components/schemas/uiNodeAnchorAttributes'
- $ref: '#/components/schemas/uiNodeScriptAttributes'
title: Attributes represents a list of attributes (e.g. `href="foo"` for links).
uiNodeGroup:
type: string
uiNodeImageAttributes:
properties:
height:
Expand All @@ -5108,6 +5136,15 @@ components:
description: A unique identifier
type: string
node_type:
description: |-
NodeType represents this node's types. It is a mirror of `node.type` and
is primarily used to allow compatibility with OpenAPI 3.0.
enum:
- text
- input
- img
- a
- script
type: string
src:
description: |-
Expand Down Expand Up @@ -5141,6 +5178,15 @@ components:
description: The input's element name.
type: string
node_type:
description: |-
NodeType represents this node's types. It is a mirror of `node.type` and
is primarily used to allow compatibility with OpenAPI 3.0.
enum:
- text
- input
- img
- a
- script
type: string
onclick:
description: |-
Expand Down Expand Up @@ -5194,6 +5240,15 @@ components:
description: The script's integrity hash
type: string
node_type:
description: |-
NodeType represents this node's types. It is a mirror of `node.type` and
is primarily used to allow compatibility with OpenAPI 3.0.
enum:
- text
- input
- img
- a
- script
type: string
nonce:
description: |-
Expand Down Expand Up @@ -5230,6 +5285,15 @@ components:
description: A unique identifier
type: string
node_type:
description: |-
NodeType represents this node's types. It is a mirror of `node.type` and
is primarily used to allow compatibility with OpenAPI 3.0.
enum:
- text
- input
- img
- a
- script
type: string
text:
$ref: '#/components/schemas/uiText'
Expand All @@ -5239,8 +5303,6 @@ components:
- text
title: TextAttributes represents the attributes of a text node.
type: object
uiNodeType:
type: string
uiNodes:
items:
$ref: '#/components/schemas/uiNode'
Expand Down
9 changes: 2 additions & 7 deletions internal/httpclient/docs/SelfServiceRecoveryFlow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Name | Type | Description | Notes
**RequestUrl** | **string** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL&#39;s path or query for example. |
**ReturnTo** | Pointer to **string** | ReturnTo contains the requested return_to URL. | [optional]
**State** | [**SelfServiceRecoveryFlowState**](SelfServiceRecoveryFlowState.md) | |
**Type** | Pointer to **string** | The flow type can either be &#x60;api&#x60; or &#x60;browser&#x60;. | [optional]
**Type** | **string** | The flow type can either be &#x60;api&#x60; or &#x60;browser&#x60;. |
**Ui** | [**UiContainer**](UiContainer.md) | |

## Methods

### NewSelfServiceRecoveryFlow

`func NewSelfServiceRecoveryFlow(expiresAt time.Time, id string, issuedAt time.Time, requestUrl string, state SelfServiceRecoveryFlowState, ui UiContainer, ) *SelfServiceRecoveryFlow`
`func NewSelfServiceRecoveryFlow(expiresAt time.Time, id string, issuedAt time.Time, requestUrl string, state SelfServiceRecoveryFlowState, type_ string, ui UiContainer, ) *SelfServiceRecoveryFlow`

NewSelfServiceRecoveryFlow instantiates a new SelfServiceRecoveryFlow object
This constructor will assign default values to properties that have it defined,
Expand Down Expand Up @@ -202,11 +202,6 @@ and a boolean to check if the value has been set.

SetType sets Type field to given value.

### HasType

`func (o *SelfServiceRecoveryFlow) HasType() bool`

HasType returns a boolean if a field has been set.

### GetUi

Expand Down
Loading