| openapi: 3.0.3 |
| info: |
| version: {{ .Package }} |
| title: Dubbo API |
| description: Dubbo API |
| x-ref-schema-name: "{{ .Name }}" |
| |
| paths: |
| /meshes/{mesh}/{{ .Path }}/{name}: |
| get: |
| summary: Returns {{ .Name }} entity |
| tags: [ "{{ .Name }}" ] |
| parameters: |
| - in: path |
| name: mesh |
| schema: |
| type: string |
| required: true |
| description: name of the mesh |
| - in: path |
| name: name |
| schema: |
| type: string |
| required: true |
| description: name of the {{ .Name }} |
| responses: |
| '200': |
| $ref: "#/components/responses/{{.Name}}Item" |
| |
| put: |
| summary: Creates or Updates {{ .Name }} entity |
| tags: [ "{{ .Name }}" ] |
| parameters: |
| - in: path |
| name: mesh |
| schema: |
| type: string |
| required: true |
| description: name of the mesh |
| - in: path |
| name: name |
| schema: |
| type: string |
| required: true |
| description: name of the {{ .Name }} |
| requestBody: |
| description: Put request |
| required: true |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/{{.Name}}Item' |
| responses: |
| '200': |
| description: Updated |
| '201': |
| description: Created |
| |
| delete: |
| summary: Deletes {{ .Name }} entity |
| tags: [ "{{ .Name }}" ] |
| parameters: |
| - in: path |
| name: mesh |
| schema: |
| type: string |
| required: true |
| description: name of the mesh |
| - in: path |
| name: name |
| schema: |
| type: string |
| required: true |
| description: name of the {{ .Name }} |
| responses: |
| '200': |
| description: Successful response |
| |
| |
| /meshes/{mesh}/{{ .Path }}: |
| get: |
| summary: Returns a list of {{ .Name }} in the mesh. |
| tags: [ "{{ .Name }}" ] |
| parameters: |
| - in: path |
| name: mesh |
| schema: |
| type: string |
| required: true |
| description: name of the mesh |
| responses: |
| '200': |
| $ref: "#/components/responses/{{.Name}}List" |
| |
| components: |
| schemas: |
| {{.Name}}Item: |
| $ref: 'schema.yaml' |
| responses: |
| {{.Name}}Item: |
| description: Successful response |
| content: |
| application/json: |
| schema: |
| $ref: '#/components/schemas/{{.Name}}Item' |
| {{.Name}}List: |
| description: List |
| content: |
| application/json: |
| schema: |
| type: object |
| properties: |
| items: |
| type: array |
| items: |
| $ref: "#/components/schemas/{{.Name}}Item" |
| total: |
| type: number |
| description: The total number of entities |
| next: |
| type: string |
| description: URL to the next page |