Skip to content

Commit

Permalink
fix(notification): Include notification details (#318)
Browse files Browse the repository at this point in the history
* build(deps): update to @redocly/cli

Update to @redocly/cli which replaces @redocly/openapi-cli.
https://www.npmjs.com/package/@redocly/openapi-cli

This is necessary to bring in fixes for the bundler not properly
including refs when adding extra schemas.

* fix(notifications): include the notification details schemas

Include the notification details schemas manually since they aren't
referenced directly anywhere else.

Fixes: #317

* lint: add ignore for unused component

Add ignore for unused component
  • Loading branch information
ttshivers authored Apr 24, 2024
1 parent bf97db1 commit 1b8686b
Show file tree
Hide file tree
Showing 6 changed files with 1,479 additions and 222 deletions.
20 changes: 11 additions & 9 deletions .redocly.yaml
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# See https://redoc.ly/docs/cli/configuration/ for more information.
apiDefinitions:
main: openapi/openapi.yaml
lint:
extends:
- recommended
plugins:
- './.github/redocly-plugins/remove-internal.js'
decorators:
remove-internal/remove-internal: error
extends:
- recommended

apis:
main:
root: openapi/openapi.yaml

plugins:
- './.github/redocly-plugins/remove-internal.js'
decorators:
remove-internal/remove-internal: error
6 changes: 6 additions & 0 deletions .spectral.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,9 @@ rules:
resolved: false
then:
function: undefined

overrides:
- files:
- "openapi/openapi.yaml#/components/schemas/$ref"
rules:
oas3-unused-component: "off"
10 changes: 10 additions & 0 deletions openapi/components/schemas/_index.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
NotificationDetailInvite:
$ref: ./NotificationDetailInvite.yaml
NotificationDetailInviteResponse:
$ref: ./NotificationDetailInviteResponse.yaml
NotificationDetailRequestInvite:
$ref: ./NotificationDetailRequestInvite.yaml
NotificationDetailRequestInviteResponse:
$ref: ./NotificationDetailRequestInviteResponse.yaml
NotificationDetailVoteToKick:
$ref: ./NotificationDetailVoteToKick.yaml
3 changes: 2 additions & 1 deletion openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ servers:
paths:
$ref: ./components/paths.yaml
components:
schemas: {}
schemas:
$ref: ./components/schemas/_index.yaml
securitySchemes:
$ref: ./components/securitySchemes.yaml
responses: {}
Expand Down
Loading

0 comments on commit 1b8686b

Please sign in to comment.