Forum Discussion
HenrikHL
3 years agoFrequent Contributor
Thank you frankkilcommins - this is very helpful and for sure a valid way to do it.
I also investigated a little more - another way to do it would be to create an unused Definition - e.g. payload:
payload:
type: object
description: `payload` claims structure
allOf:
- type: object
properties:
name:
type: string
description: bla bla bla...
example: John Doe
- type: object
properties:
admin:
type: boolean
description: bla bla bla...
example: true
This definition should then somehow be referenced from the envelope description:
components:
schemas:
envelope:
type: string
maxLength: 1500
description: |
A JWT token. Please see [payload](#/payload)
example: 'xxxxx.yyyyy.zzzzz'
The above example is not possible since internal-page links is not possible (to my knowledge) 😞
Related Content
- 8 years ago
- 9 years ago
Recent Discussions
- 22 days ago
- 2 months ago