From 91cfe01ff7ca0ba77925f467ab83aaef035087a5 Mon Sep 17 00:00:00 2001 From: Chandni Yadav Date: Fri, 10 May 2024 15:53:26 +0530 Subject: [PATCH 1/3] XBFIL-4328- Fix formatting and add new fields 'Name', 'Size' and 'SendWithObject' to object association endpoint --- xero_files.yaml | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/xero_files.yaml b/xero_files.yaml index ef0aad25..321fcd05 100644 --- a/xero_files.yaml +++ b/xero_files.yaml @@ -553,6 +553,9 @@ paths: $ref: '#/components/schemas/Association' example: '[ { + "SendWithObject":false, + "Name":"testfile.pdf", + "Size":12357, "FileId":"6beccb4a-0d7d-4518-93f3-e0cd1dccb254", "ObjectId":"1270bf7c-5d18-473a-9231-1e36c4bd33ed", "ObjectType":"Business", @@ -591,9 +594,8 @@ paths: example: '{ "19d4fc59-e799-410f-912b-03d4ab294d73": 2, "82195976-5175-45d4-926e-807ff10892e7": 1, - "a8547af2-2900-4879-98b8-f1a780c78feb": 0 - }' - /Folders: + "a8547af2-2900-4879-98b8-f1a780c78feb": 0}' +/Folders: parameters: - $ref: '#/components/parameters/requiredHeader' get: @@ -683,7 +685,7 @@ paths: example: '{ "Name": "My Docs" }' - /Folders/{FolderId}: +/Folders/{FolderId}: parameters: - $ref: '#/components/parameters/requiredHeader' get: @@ -791,7 +793,7 @@ paths: '204': description: Successful deletion - return response 204 no content x-isEmpty: true - /Inbox: +/Inbox: parameters: - $ref: '#/components/parameters/requiredHeader' get: @@ -984,6 +986,18 @@ components: Association: type: object properties: + SendWithObject: + description: Boolean flag to know if a file is associated to a document. This is only relevant for object association endpoint- /Associations/{ObjectId}. + type: boolean + example: true + Name: + description: The name of the associated file. This is only relevant for object association endpoint- /Associations/{ObjectId}. + type: string + example: Test.pdf + Size: + description: The size of the associated file in bytes. This is only relevant for object association endpoint- /Associations/{ObjectId}. + type: integer + example: 12357 FileId: description: The unique identifier of the file type: string From 134150e4b54e963281503bf69407c48456058898 Mon Sep 17 00:00:00 2001 From: Chandni Yadav Date: Tue, 14 May 2024 15:34:16 +0530 Subject: [PATCH 2/3] XBFIL-4328- Update property description --- xero_files.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/xero_files.yaml b/xero_files.yaml index 321fcd05..269e0b16 100644 --- a/xero_files.yaml +++ b/xero_files.yaml @@ -987,15 +987,15 @@ components: type: object properties: SendWithObject: - description: Boolean flag to know if a file is associated to a document. This is only relevant for object association endpoint- /Associations/{ObjectId}. + description: Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. type: boolean example: true Name: - description: The name of the associated file. This is only relevant for object association endpoint- /Associations/{ObjectId}. + description: The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint. type: string example: Test.pdf Size: - description: The size of the associated file in bytes. This is only relevant for object association endpoint- /Associations/{ObjectId}. + description: The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint. type: integer example: 12357 FileId: From 5819554eb929afd39dbb02a4ce844aecd6b37fbf Mon Sep 17 00:00:00 2001 From: Chandni Yadav Date: Mon, 3 Jun 2024 11:09:32 +0530 Subject: [PATCH 3/3] XBFIL-4328- Fix PR comments on formatting --- xero_files.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/xero_files.yaml b/xero_files.yaml index 269e0b16..b8775051 100644 --- a/xero_files.yaml +++ b/xero_files.yaml @@ -595,7 +595,7 @@ paths: "19d4fc59-e799-410f-912b-03d4ab294d73": 2, "82195976-5175-45d4-926e-807ff10892e7": 1, "a8547af2-2900-4879-98b8-f1a780c78feb": 0}' -/Folders: + /Folders: parameters: - $ref: '#/components/parameters/requiredHeader' get: @@ -685,7 +685,7 @@ paths: example: '{ "Name": "My Docs" }' -/Folders/{FolderId}: + /Folders/{FolderId}: parameters: - $ref: '#/components/parameters/requiredHeader' get: @@ -793,7 +793,7 @@ paths: '204': description: Successful deletion - return response 204 no content x-isEmpty: true -/Inbox: + /Inbox: parameters: - $ref: '#/components/parameters/requiredHeader' get: @@ -987,7 +987,7 @@ components: type: object properties: SendWithObject: - description: Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. + description: Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint. type: boolean example: true Name: