OpenAPI spec for admin API #379

Merged
lx merged 15 commits from ecosystem/openapi into main 2022-11-16 10:51:05 +00:00
Showing only changes of commit eabb37b53f - Show all commits

View file

@ -851,11 +851,15 @@ paths:
- name: id - name: id
in: query in: query
required: true required: true
schema:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
- name: alias - name: alias
in: query in: query
required: true required: true
example: my_documents example: my_documents
schema:
type: string
responses: responses:
'500': '500':
description: "The server can not handle your request. Check your connectivity with the rest of the cluster." description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
@ -881,10 +885,14 @@ paths:
- name: id - name: id
in: query in: query
required: true required: true
schema:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
- name: alias - name: alias
in: query in: query
required: true required: true
schema:
type: string
example: my_documents example: my_documents
responses: responses:
'500': '500':
@ -912,14 +920,20 @@ paths:
- name: id - name: id
in: query in: query
required: true required: true
schema:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
- name: accessKeyId - name: accessKeyId
in: query in: query
required: true required: true
schema:
type: string
example: GK31c2f218a2e44f485b94239e example: GK31c2f218a2e44f485b94239e
- name: alias - name: alias
in: query in: query
required: true required: true
schema:
type: string
example: my_documents example: my_documents
responses: responses:
'500': '500':
@ -946,13 +960,19 @@ paths:
- name: id - name: id
in: query in: query
required: true required: true
schema:
type: string
example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
- name: accessKeyId - name: accessKeyId
in: query in: query
schema:
type: string
required: true required: true
example: GK31c2f218a2e44f485b94239e example: GK31c2f218a2e44f485b94239e
- name: alias - name: alias
in: query in: query
schema:
type: string
required: true required: true
example: my_documents example: my_documents
responses: responses:
@ -1105,7 +1125,6 @@ components:
properties: properties:
id: id:
type: string type: string
required: true
example: afa8f0a22b40b1247ccd0affb869b0af5cff980924a20e4b5e0720a44deb8d39 example: afa8f0a22b40b1247ccd0affb869b0af5cff980924a20e4b5e0720a44deb8d39
globalAliases: globalAliases:
type: array type: array
@ -1113,7 +1132,7 @@ components:
type: string type: string
example: "my_documents" example: "my_documents"
websiteAccess: websiteAccess:
type: bool type: boolean
example: true example: true
websiteConfig: websiteConfig:
type: object type: object