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.

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

Minor: Update schema-registry-api-spec.yaml #2587

Draft
wants to merge 1 commit into
base: 7.4.x
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
172 changes: 171 additions & 1 deletion core/generated/swagger-ui/schema-registry-api-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1906,7 +1906,7 @@ paths:
summary: Get schema string by version
description: Retrieves the schema for the specified version of this subject.
Only the unescaped schema string is returned.
operationId: getSchemaOnly_2
operationId: getSchemaOnly
parameters:
- name: subject
in: path
Expand Down Expand Up @@ -2071,6 +2071,56 @@ paths:
"500":
description: |
Error code 50001 -- Error in the backend data store
/subjects/{subject}/metadata:
get:
summary: Retrieve the latest version with the given metadata.
description: Retrieve the latest version with the given metadata.
operationId: getLatestWithMetadata
parameters:
- name: subject
in: path
description: Subject under which the schema will be registered
required: true
schema:
type: string
- name: key
in: query
description: The metadata key
schema:
type: array
items:
type: string
- name: value
in: query
description: The metadata value
schema:
type: array
items:
type: string
- name: deleted
in: query
description: Whether to lookup deleted schemas
schema:
type: boolean
responses:
"200":
description: The schema
content:
application/vnd.schemaregistry.v1+json:
schema:
$ref: '#/components/schemas/Schema'
application/vnd.schemaregistry+json; qs=0.9:
schema:
$ref: '#/components/schemas/Schema'
application/json; qs=0.5:
schema:
$ref: '#/components/schemas/Schema'
"404":
description: |-
Error code 40401 -- Subject not found
Error code 40403 -- Schema not found
"500":
description: Internal server error
components:
schemas:
CompatibilityCheckResponse:
Expand Down Expand Up @@ -2107,6 +2157,10 @@ components:
description: References to other schemas
items:
$ref: '#/components/schemas/SchemaReference'
metadata:
$ref: '#/components/schemas/Metadata'
ruleSet:
$ref: '#/components/schemas/RuleSet'
schema:
type: string
description: Schema definition string
Expand Down Expand Up @@ -2143,6 +2197,16 @@ components:
- FULL
- FULL_TRANSITIVE
- NONE
compatibilityGroup:
type: string
defaultMetadata:
$ref: '#/components/schemas/Metadata'
overrideMetadata:
$ref: '#/components/schemas/Metadata'
defaultRuleSet:
$ref: '#/components/schemas/RuleSet'
overrideRuleSet:
$ref: '#/components/schemas/RuleSet'
description: Config
ConfigUpdateRequest:
type: object
Expand All @@ -2159,6 +2223,16 @@ components:
- FULL
- FULL_TRANSITIVE
- NONE
compatibilityGroup:
type: string
defaultMetadata:
$ref: '#/components/schemas/Metadata'
overrideMetadata:
$ref: '#/components/schemas/Metadata'
defaultRuleSet:
$ref: '#/components/schemas/RuleSet'
overrideRuleSet:
$ref: '#/components/schemas/RuleSet'
description: Config update request
Mode:
type: object
Expand Down Expand Up @@ -2202,6 +2276,10 @@ components:
description: References to other schemas
items:
$ref: '#/components/schemas/SchemaReference'
metadata:
$ref: '#/components/schemas/Metadata'
ruleSet:
$ref: '#/components/schemas/RuleSet'
maxId:
type: integer
description: Maximum ID
Expand Down Expand Up @@ -2238,6 +2316,12 @@ components:
type: string
description: Schema definition string
example: "{\"schema\": \"{\"type\": \"string\"}\"}"
metadata:
$ref: '#/components/schemas/Metadata'
ruleset:
$ref: '#/components/schemas/RuleSet'
ruleSet:
$ref: '#/components/schemas/RuleSet'
description: Schema
SubjectVersion:
type: object
Expand Down Expand Up @@ -2288,3 +2372,89 @@ components:
type: string
commitId:
type: string
Metadata:
type: object
properties:
tags:
type: object
additionalProperties:
uniqueItems: true
type: array
items:
type: string
properties:
type: object
additionalProperties:
type: string
sensitive:
uniqueItems: true
type: array
items:
type: string
description: User-defined metadata
Rule:
type: object
properties:
name:
type: string
description: Rule name
doc:
type: string
description: Rule doc
kind:
type: string
description: Rule kind
enum:
- TRANSFORM
- CONDITION
mode:
type: string
description: Rule mode
enum:
- UPGRADE
- DOWNGRADE
- UPDOWN
- WRITE
- READ
- WRITEREAD
type:
type: string
description: Rule type
tags:
uniqueItems: true
type: array
description: The tags to which this rule applies
items:
type: string
description: The tags to which this rule applies
params:
type: object
additionalProperties:
type: string
description: Optional params for the rule
description: Optional params for the rule
expr:
type: string
description: Rule expression
onSuccess:
type: string
description: Rule action on success
onFailure:
type: string
description: Rule action on failure
disabled:
type: boolean
description: Whether the rule is disabled
description: Rule
RuleSet:
type: object
properties:
migrationRules:
type: array
items:
$ref: '#/components/schemas/Rule'
domainRules:
type: array
items:
$ref: '#/components/schemas/Rule'
description: Schema rule set
Loading