Skip to content

Commit

Permalink
feat(spec): update spec (#389)
Browse files Browse the repository at this point in the history
  • Loading branch information
samueldurantes authored Mar 21, 2024
1 parent be5bf16 commit cacb7a0
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/swaggers/woovi.json

Large diffs are not rendered by default.

107 changes: 107 additions & 0 deletions src/swaggers/woovi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -902,6 +902,79 @@ paths:
properties:
error:
type: string
"/api/v1/customer/{correlationID}":
patch:
tags:
- customer
summary: Update a Customer
parameters:
- name: correlationID
in: path
description: correlation ID
required: true
schema:
type: string
examples:
correlationID:
value: fe7834b4060c488a9b0f89811be5f5cf
description: Endpoint to update a Customer
requestBody:
description: Data to update a existent customer
required: true
content:
application/json:
schema:
type: object
$ref: "#/components/schemas/CustomerPatchPayload"
example:
name: Dan
email: [email protected]
phone: "5511999999999"
address:
zipcode: "30421322"
street: Street
number: "100"
neighborhood: Neighborhood
city: Belo Horizonte
state: MG
complement: APTO
country: BR
responses:
"200":
description: Customer ID
content:
application/json:
schema:
type: object
properties:
customer:
$ref: "#/components/schemas/Customer"
example:
customer:
name: Dan
email: [email protected]
phone: "5511999999999"
taxID:
taxID: "31324227036"
type: BR:CPF
address:
zipcode: "30421322"
street: Street
number: "100"
neighborhood: Neighborhood
city: Belo Horizonte
state: MG
complement: APTO
country: BR
"400":
description: An error message
content:
application/json:
schema:
type: object
properties:
error:
type: string
/api/v1/partner/application:
post:
tags:
Expand Down Expand Up @@ -3264,6 +3337,36 @@ components:
required:
- name
- phone
CustomerPatchPayload:
type: object
properties:
name:
type: string
email:
type: string
phone:
type: string
taxID:
type: string
address:
type: object
properties:
zipcode:
type: string
street:
type: string
number:
type: string
neighborhood:
type: string
city:
type: string
state:
type: string
complement:
type: string
country:
type: string
End:
type: string
format: date-time
Expand Down Expand Up @@ -3698,9 +3801,13 @@ components:
minimum: 3
default: 7
description: Days that the charge will take to expire from the generation day.
correlationID:
type: string
description: Your correlation ID to keep track of this subscription
required:
- customer
- value
- correlationID
Transaction:
type: object
properties:
Expand Down
2 changes: 1 addition & 1 deletion static/wooviPostman.json

Large diffs are not rendered by default.

0 comments on commit cacb7a0

Please sign in to comment.