Skip to content

Commit

Permalink
docs(admin-api): add filter chains to OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
flrgh authored and locao committed Aug 3, 2023
1 parent 073d2fd commit 6eee6b4
Showing 1 changed file with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions kong-admin-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,30 @@ paths:
/routes/{routes}/plugins/{plugins}:
patch:
description: This method is not available when using DB-less mode.
/filter-chains:
post:
description: This method is not available when using DB-less mode.
/filter-chains/{filter_chains}:
patch:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
/services/{services}/filter-chains:
post:
description: This method is not available when using DB-less mode.
/services/{services}/filter-chains/{filter_chains}:
patch:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
/routes/{routes}/filter-chains:
post:
description: This method is not available when using DB-less mode.
/routes/{routes}/filter-chains/{filter_chains}:
patch:
description: This method is not available when using DB-less mode.
delete:
description: This method is not available when using DB-less mode.
components:
schemas:
key_sets:
Expand Down Expand Up @@ -691,6 +715,49 @@ components:
type: integer
required:
- kid
filter_chains:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
enabled:
type: boolean
default: true
filters:
type: array
items:
$ref: '#/components/schemas/filters'
service:
nullable: true
$ref: '#/components/schemas/services'
default: ~
route:
nullable: true
$ref: '#/components/schemas/routes'
default: ~
tags:
type: array
created_at:
format: int32
type: integer
updated_at:
format: int32
type: integer
required: []
filters:
properties:
name:
type: string
config:
type: string
enabled:
type: boolean
default: true
required:
- name
servers:
- description: 8001 is the default port on which the Admin API listens.
url: http://localhost:8001
Expand Down

1 comment on commit 6eee6b4

@khcp-gha-bot
Copy link

Choose a reason for hiding this comment

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

Bazel Build

Docker image available kong/kong:6eee6b42942de4a4a97a815e33d2361b3da7a6b5
Artifacts available https://github.com/Kong/kong/actions/runs/5750514785

Please sign in to comment.