Opply Public Buyer Onboarding API
The Public Buyer Onboarding API from Opply — 23 operation(s) for public buyer onboarding.
The Public Buyer Onboarding API from Opply — 23 operation(s) for public buyer onboarding.
openapi: 3.0.3
info:
title: Opply Activity Feed Public Buyer Onboarding API
version: 0.0.0
tags:
- name: Public Buyer Onboarding
paths:
/api/v1/buyer-onboarding/public/buyers/{uuid}/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_retrieve
description: Get buyer onboarding details including country information.
summary: Get buyer onboarding details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingDetail'
description: ''
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/account-details/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_account_details_retrieve
description: Get account details for this buyer.
summary: Get account details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDetail'
description: ''
'404':
description: Account details not found or buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/account-details/create/:
post:
operationId: api_v1_buyer_onboarding_public_buyers_account_details_create_create
description: Create account details for this buyer. Can only be created once.
summary: Create account details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDetail'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/AccountDetail'
multipart/form-data:
schema:
$ref: '#/components/schemas/AccountDetail'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDetail'
description: ''
'400':
description: Invalid input data or account details already exist
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/account-details/update/:
patch:
operationId: api_v1_buyer_onboarding_public_buyers_account_details_update_partial_update
description: Update account details for this buyer.
summary: Update account details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAccountDetail'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedAccountDetail'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedAccountDetail'
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDetail'
description: ''
'400':
description: Invalid input data
'404':
description: Account details not found or buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_addresses_list
description: Get all delivery addresses for the buyer onboarding.
summary: Get delivery addresses
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBuyerOnboardingDeliveryAddressList'
description: ''
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/{address_uuid}/delete/:
delete:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_addresses_delete_destroy
description: Delete a delivery address by UUID.
summary: Delete delivery address
parameters:
- in: path
name: address_uuid
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'204':
description: Address deleted successfully
'404':
description: Address not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/{address_uuid}/update/:
patch:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_addresses_update_partial_update
description: Update an existing delivery address by UUID.
summary: Update delivery address
parameters:
- in: path
name: address_uuid
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBuyerOnboardingDeliveryAddress'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedBuyerOnboardingDeliveryAddress'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedBuyerOnboardingDeliveryAddress'
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingDeliveryAddress'
description: ''
'400':
description: Validation error
'404':
description: Address not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-addresses/create/:
post:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_addresses_create_create
description: Create a new delivery address for the buyer onboarding.
summary: Create delivery address
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingDeliveryAddress'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BuyerOnboardingDeliveryAddress'
multipart/form-data:
schema:
$ref: '#/components/schemas/BuyerOnboardingDeliveryAddress'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingDeliveryAddress'
description: ''
'400':
description: Validation error
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-details/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_details_retrieve
description: Get delivery details for this buyer.
summary: Get delivery details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryDetails'
description: ''
'404':
description: Delivery details not found or buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-details/create/:
post:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_details_create_create
description: Create delivery details for this buyer. Can only be created once.
summary: Create delivery details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryDetails'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DeliveryDetails'
multipart/form-data:
schema:
$ref: '#/components/schemas/DeliveryDetails'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryDetails'
description: ''
'400':
description: Invalid input data or delivery details already exist
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-details/update/:
patch:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_details_update_partial_update
description: Update delivery details for this buyer.
summary: Update delivery details
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDeliveryDetails'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDeliveryDetails'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDeliveryDetails'
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryDetails'
description: ''
'400':
description: Invalid input data
'404':
description: Delivery details not found or buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/delivery-emails/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_emails_list
description: 'GET: Get all delivery emails for the buyer onboarding.
POST: Create or update delivery emails. Accepts an object with ''delivery_emails'' array. If UUID is provided and exists, the email will be updated. If UUID is not provided or doesn''t exist, a new email will be created. Emails not in the payload will be deleted.'
summary: Get or update delivery emails
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDeliveryEmailList'
description: ''
'400':
description: Validation error
post:
operationId: api_v1_buyer_onboarding_public_buyers_delivery_emails_create
description: 'GET: Get all delivery emails for the buyer onboarding.
POST: Create or update delivery emails. Accepts an object with ''delivery_emails'' array. If UUID is provided and exists, the email will be updated. If UUID is not provided or doesn''t exist, a new email will be created. Emails not in the payload will be deleted.'
summary: Get or update delivery emails
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeliveryEmailList'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DeliveryEmailList'
multipart/form-data:
schema:
$ref: '#/components/schemas/DeliveryEmailList'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDeliveryEmailList'
description: ''
'400':
description: Validation error
/api/v1/buyer-onboarding/public/buyers/{uuid}/documents/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_documents_list
description: Get all documents for the buyer onboarding.
summary: List documents
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBuyerOnboardingDocumentList'
description: ''
/api/v1/buyer-onboarding/public/buyers/{uuid}/documents/{document_uuid}/delete/:
delete:
operationId: api_v1_buyer_onboarding_public_buyers_documents_delete_destroy
description: Delete a document by UUID.
summary: Delete document
parameters:
- in: path
name: document_uuid
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'204':
description: Document deleted successfully
'404':
description: Document not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/documents/upload/:
post:
operationId: api_v1_buyer_onboarding_public_buyers_documents_upload_create
description: Upload a document for the buyer onboarding.
summary: Upload document
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingDocument'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BuyerOnboardingDocument'
multipart/form-data:
schema:
$ref: '#/components/schemas/BuyerOnboardingDocument'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingDocument'
description: ''
'400':
description: Validation error
/api/v1/buyer-onboarding/public/buyers/{uuid}/phases/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_phases_list
description: Get all available onboarding phases with their step templates.
summary: Get onboarding phases
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedOnboardingStepTemplateList'
description: ''
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/steps/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_steps_list
description: Get all onboarding steps for this buyer, organized by phase.
summary: List buyer onboarding steps
parameters:
- in: query
name: is_completed
schema:
type: boolean
description: Filter by completion status (true/false)
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: phase
schema:
type: string
description: Filter by phase (phase_1, phase_2, phase_3, phase_4)
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedBuyerOnboardingStepList'
description: ''
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/steps/{step_id}/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_steps_retrieve
description: Get details of a specific onboarding step.
summary: Get buyer onboarding step
parameters:
- in: path
name: step_id
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingStep'
description: ''
'404':
description: Step not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_suppliers_list
description: Get all suppliers for this buyer.
summary: List suppliers
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedSupplierList'
description: ''
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/{supplier_id}/:
get:
operationId: api_v1_buyer_onboarding_public_buyers_suppliers_retrieve
description: Get details of a specific supplier.
summary: Get supplier details
parameters:
- in: path
name: supplier_id
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Supplier'
description: ''
'404':
description: Supplier not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/{supplier_id}/update/:
patch:
operationId: api_v1_buyer_onboarding_public_buyers_suppliers_update_partial_update
description: Update a supplier for this buyer.
summary: Update supplier
parameters:
- in: path
name: supplier_id
schema:
type: string
required: true
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedSupplier'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedSupplier'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedSupplier'
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Supplier'
description: ''
'400':
description: Invalid input data
'404':
description: Supplier not found or buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/complete/:
post:
operationId: api_v1_buyer_onboarding_public_buyers_suppliers_complete_create
description: Mark the supplier section as complete for this buyer.
summary: Mark supplier section as complete
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BuyerOnboardingStep'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/BuyerOnboardingStep'
multipart/form-data:
schema:
$ref: '#/components/schemas/BuyerOnboardingStep'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'200':
description: Supplier section marked as complete
'404':
description: Buyer onboarding not found
/api/v1/buyer-onboarding/public/buyers/{uuid}/suppliers/create/:
post:
operationId: api_v1_buyer_onboarding_public_buyers_suppliers_create_create
description: Create a new supplier for this buyer.
summary: Create supplier
parameters:
- in: path
name: uuid
schema:
type: string
format: uuid
description: Unique identifier for sharing the onboarding form
required: true
tags:
- Public Buyer Onboarding
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Supplier'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Supplier'
multipart/form-data:
schema:
$ref: '#/components/schemas/Supplier'
required: true
security:
- tokenAuth: []
- cookieAuth: []
- {}
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Supplier'
description: ''
'400':
description: Invalid input data
'404':
description: Buyer onboarding not found
components:
schemas:
BuyerOnboardingDocument:
type: object
description: Serializer for BuyerOnboardingDocument model.
properties:
uuid:
type: string
format: uuid
readOnly: true
description: Unique identifier for document lookup
document:
type: string
format: uri
description: Uploaded document
document_url:
type: string
readOnly: true
description:
type: string
nullable: true
description: Optional description of the document
created_at:
type: string
format: date-time
readOnly: true
modified_at:
type: string
format: date-time
readOnly: true
required:
- created_at
- document
- document_url
- modified_at
- uuid
Country:
enum:
- AF
- AX
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CG
- CD
- CK
- CR
- CI
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- KP
- MK
- XI
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- KR
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
type: string
description: '* `AF` - Afghanistan
* `AX` - Åland Islands
* `AL` - Albania
* `DZ` - Algeria
* `AS` - Americ
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/opply/refs/heads/main/openapi/opply-public-buyer-onboarding-api-openapi.yml