customer-api-python/openapi.yaml at main · ramith/customer-api-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
openapi: 3.0.0
servers:
  - description: Customer API
    url: http://localhost:8080
info:
  description: "CRUD Operations for customer"
  version: "1.0.0"
  title: "Customer API"
  contact:
    email: "choreo-help@wso2.com"
  license:
    name: "Apache 2.0"
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
tags:
  - name: "customer"
    description: "customer api"
  - name: "demo"
    description: "This api is created for demo purposes"
paths:
  /customer/{accountId}:
    get:
      summary: "Retrieve a customer by id"
      operationId: "getCustomerById"
      description: |
        Retrieve a customer by account id.
      parameters:
        - name: accountId
          in: path
          description: "Customer account Id"
          required: true
          schema:
            type: string
      responses:
        "200":
          description: "The Customer with Id"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Customer"

        "404":
          description: "Unable to find the Customer"

components:
  schemas:
    Customer:
      type: object
      required:
        - accountId
        - firstName
        - lastName
        - kycStatus
      properties:
        accountId:
          type: string
          example: "1"
        firstName:
          type: string
          example: "John"
        lastName:
          type: string
          example: "Smith"
        kycStatus:
          type: string
          example: "verified"