Skip to content

Commit 34213f6

Browse files
authored
Merge pull request #693 from XeroAPI/fix/yq-formatting
Fixed basic formatting using yq
2 parents e8c221a + 429bfd6 commit 34213f6

11 files changed

+35595
-40853
lines changed

xero-app-store.yaml

+146-167
Large diffs are not rendered by default.

xero-finance.yaml

+644-617
Large diffs are not rendered by default.

xero-identity.yaml

+28-37
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
openapi: 3.0.0
22
info:
3-
version: "6.3.0"
3+
version: 6.3.0
44
title: Xero OAuth 2 Identity Service API
55
description: These endpoints are related to managing authentication tokens and identity for Xero API
6-
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
6+
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/
77
contact:
8-
name: "Xero Platform Team"
9-
10-
url: "https://developer.xero.com"
8+
name: Xero Platform Team
9+
10+
url: https://developer.xero.com
1111
license:
12-
name: MIT
13-
url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
12+
name: MIT
13+
url: https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE
1414
servers:
1515
- description: Xero Identity service API
16-
url: 'https://api.xero.com'
16+
url: https://api.xero.com
1717
paths:
1818
/Connections:
1919
get:
@@ -29,31 +29,22 @@ paths:
2929
required: false
3030
name: authEventId
3131
description: Filter by authEventId
32-
example: "00000000-0000-0000-0000-000000000000"
32+
example: 00000000-0000-0000-0000-000000000000
3333
schema:
3434
type: string
3535
format: uuid
36-
x-basepath: 'https://api.xero.com'
36+
x-basepath: https://api.xero.com
3737
responses:
38-
'200':
39-
description: Success - return response of type Connections array with 0 to n Connection
38+
"200":
39+
description: Success - return response of type Connections array with 0 to n Connection
4040
content:
4141
application/json:
4242
schema:
4343
type: array
4444
items:
4545
$ref: '#/components/schemas/Connection'
46-
example: '[
47-
{
48-
"id": "7cb59f93-2964-421d-bb5e-a0f7a4572a44",
49-
"tenantId": "fe79f7dd-b6d4-4a92-ba7b-538af6289c58",
50-
"tenantName": "Demo Company (NZ)",
51-
"tenantType": "ORGANISATION",
52-
"createdDateUtc": "2019-12-07T18:46:19.5165400",
53-
"updatedDateUtc": "2019-12-07T18:46:19.5187840"
54-
}
55-
]'
56-
'/Connections/{id}':
46+
example: '[ { "id": "7cb59f93-2964-421d-bb5e-a0f7a4572a44", "tenantId": "fe79f7dd-b6d4-4a92-ba7b-538af6289c58", "tenantName": "Demo Company (NZ)", "tenantType": "ORGANISATION", "createdDateUtc": "2019-12-07T18:46:19.5165400", "updatedDateUtc": "2019-12-07T18:46:19.5187840" } ]'
47+
/Connections/{id}:
5748
delete:
5849
security:
5950
- OAuth2: []
@@ -62,7 +53,7 @@ paths:
6253
description: Override the base server url that include version
6354
operationId: deleteConnection
6455
summary: Deletes a connection for this user (i.e. disconnect a tenant)
65-
x-basepath: 'https://api.xero.com'
56+
x-basepath: https://api.xero.com
6657
parameters:
6758
- required: true
6859
in: path
@@ -72,15 +63,15 @@ paths:
7263
type: string
7364
format: uuid
7465
responses:
75-
'204':
76-
description: Success - connection has been deleted no content returned
77-
'404':
66+
"204":
67+
description: Success - connection has been deleted no content returned
68+
"404":
7869
description: Resource not found
7970
components:
8071
schemas:
8172
Connection:
8273
externalDocs:
83-
url: 'http://developer.xero.com'
74+
url: http://developer.xero.com
8475
properties:
8576
id:
8677
description: Xero identifier
@@ -105,16 +96,16 @@ components:
10596
type: string
10697
format: date-time
10798
x-is-datetime: true
108-
x-php-format: '\DateTime'
99+
x-php-format: \DateTime
109100
updatedDateUtc:
110101
description: The date when the user most recently connected this tenant to your app. May differ to the created date if the user has disconnected and subsequently reconnected this tenant to your app.
111102
type: string
112103
format: date-time
113104
x-is-datetime: true
114-
x-php-format: '\DateTime'
105+
x-php-format: \DateTime
115106
RefreshToken:
116107
externalDocs:
117-
url: 'http://developer.xero.com'
108+
url: http://developer.xero.com
118109
type: object
119110
properties:
120111
grant_type:
@@ -131,7 +122,7 @@ components:
131122
type: string
132123
AccessToken:
133124
externalDocs:
134-
url: 'http://developer.xero.com'
125+
url: http://developer.xero.com
135126
type: object
136127
properties:
137128
id_token:
@@ -151,17 +142,17 @@ components:
151142
description: token used to refresh an expired access token
152143
type: string
153144
securitySchemes:
154-
BasicAuth:
145+
BasicAuth:
155146
type: http
156147
scheme: basic
157148
OAuth2:
158149
type: oauth2
159150
description: For more information
160-
flows:
151+
flows:
161152
authorizationCode:
162-
authorizationUrl: 'https://login.xero.com/identity/connect/authorize'
163-
tokenUrl: 'https://identity.xero.com/connect/token'
153+
authorizationUrl: https://login.xero.com/identity/connect/authorize
154+
tokenUrl: https://identity.xero.com/connect/token
164155
scopes:
165156
email: Grant read-only access to your email
166157
openid: Grant read-only access to your open id
167-
profile: your profile information
158+
profile: your profile information

0 commit comments

Comments
 (0)