Skip to content

Commit

Permalink
Merge pull request #693 from XeroAPI/fix/yq-formatting
Browse files Browse the repository at this point in the history
Fixed basic formatting using yq
  • Loading branch information
vigneshk-tw authored Nov 6, 2024
2 parents e8c221a + 429bfd6 commit 34213f6
Show file tree
Hide file tree
Showing 11 changed files with 35,595 additions and 40,853 deletions.
313 changes: 146 additions & 167 deletions xero-app-store.yaml

Large diffs are not rendered by default.

1,261 changes: 644 additions & 617 deletions xero-finance.yaml

Large diffs are not rendered by default.

65 changes: 28 additions & 37 deletions xero-identity.yaml
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
openapi: 3.0.0
info:
version: "6.3.0"
version: 6.3.0
title: Xero OAuth 2 Identity Service API
description: These endpoints are related to managing authentication tokens and identity for Xero API
termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
termsOfService: https://developer.xero.com/xero-developer-platform-terms-conditions/
contact:
name: "Xero Platform Team"
email: "api@xero.com"
url: "https://developer.xero.com"
name: Xero Platform Team
email: api@xero.com
url: https://developer.xero.com
license:
name: MIT
url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
name: MIT
url: https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE
servers:
- description: Xero Identity service API
url: 'https://api.xero.com'
url: https://api.xero.com
paths:
/Connections:
get:
Expand All @@ -29,31 +29,22 @@ paths:
required: false
name: authEventId
description: Filter by authEventId
example: "00000000-0000-0000-0000-000000000000"
example: 00000000-0000-0000-0000-000000000000
schema:
type: string
format: uuid
x-basepath: 'https://api.xero.com'
x-basepath: https://api.xero.com
responses:
'200':
description: Success - return response of type Connections array with 0 to n Connection
"200":
description: Success - return response of type Connections array with 0 to n Connection
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Connection'
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"
}
]'
'/Connections/{id}':
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" } ]'
/Connections/{id}:
delete:
security:
- OAuth2: []
Expand All @@ -62,7 +53,7 @@ paths:
description: Override the base server url that include version
operationId: deleteConnection
summary: Deletes a connection for this user (i.e. disconnect a tenant)
x-basepath: 'https://api.xero.com'
x-basepath: https://api.xero.com
parameters:
- required: true
in: path
Expand All @@ -72,15 +63,15 @@ paths:
type: string
format: uuid
responses:
'204':
description: Success - connection has been deleted no content returned
'404':
"204":
description: Success - connection has been deleted no content returned
"404":
description: Resource not found
components:
schemas:
Connection:
externalDocs:
url: 'http://developer.xero.com'
url: http://developer.xero.com
properties:
id:
description: Xero identifier
Expand All @@ -105,16 +96,16 @@ components:
type: string
format: date-time
x-is-datetime: true
x-php-format: '\DateTime'
x-php-format: \DateTime
updatedDateUtc:
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.
type: string
format: date-time
x-is-datetime: true
x-php-format: '\DateTime'
x-php-format: \DateTime
RefreshToken:
externalDocs:
url: 'http://developer.xero.com'
url: http://developer.xero.com
type: object
properties:
grant_type:
Expand All @@ -131,7 +122,7 @@ components:
type: string
AccessToken:
externalDocs:
url: 'http://developer.xero.com'
url: http://developer.xero.com
type: object
properties:
id_token:
Expand All @@ -151,17 +142,17 @@ components:
description: token used to refresh an expired access token
type: string
securitySchemes:
BasicAuth:
BasicAuth:
type: http
scheme: basic
OAuth2:
type: oauth2
description: For more information
flows:
flows:
authorizationCode:
authorizationUrl: 'https://login.xero.com/identity/connect/authorize'
tokenUrl: 'https://identity.xero.com/connect/token'
authorizationUrl: https://login.xero.com/identity/connect/authorize
tokenUrl: https://identity.xero.com/connect/token
scopes:
email: Grant read-only access to your email
openid: Grant read-only access to your open id
profile: your profile information
profile: your profile information
Loading

0 comments on commit 34213f6

Please sign in to comment.