Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions components/schemas/CommonErrors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@
content:
application/json:
schema:
"$ref": "./error/ErrorResponse.yml"
$ref: "./error/ErrorResponse.yml"
"401":
description: OAuth token is invalid.
content:
application/json:
schema:
"$ref": "./error/ErrorResponse.yml"
$ref: "./error/ErrorResponse.yml"
"404":
description: The requested resource doesn't exist.
content:
application/json:
schema:
"$ref": "./error/ErrorResponse.yml"
$ref: "./error/ErrorResponse.yml"
"500":
description: Indicates an issue with Cycle. Rare.
content:
application/json:
schema:
"$ref": "./error/ErrorResponse.yml"
$ref: "./error/ErrorResponse.yml"
4 changes: 2 additions & 2 deletions components/schemas/State.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ required:
- changed
properties:
changed:
"$ref": "./DateTime.yml"
$ref: "./DateTime.yml"
error:
type: object
description: An error, if any, that has occurred for this resource.
Expand All @@ -16,4 +16,4 @@ properties:
description: Details about the error that has occurred.
time:
description: The timestamp of when the error was encountered.
"$ref": "./DateTime.yml"
$ref: "./DateTime.yml"
14 changes: 7 additions & 7 deletions components/schemas/accounts/Account.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ required:
- events
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
name:
type: object
description: The first and last name associated with the Account.
Expand Down Expand Up @@ -40,7 +40,7 @@ properties:
description: If true, the email has been verified and the Account is active.
added:
description: The date the email was added to the Account
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
two_factor_auth:
description: Two factor auth verification information.
oneOf:
Expand All @@ -56,7 +56,7 @@ properties:
description: Indicates whether or not Cycle employees have authorization to log in to this Account in a support capacity.
type: boolean
state:
"$ref": "./AccountState.yml"
$ref: "./AccountState.yml"
events:
title: AccountEvents
type: object
Expand All @@ -69,13 +69,13 @@ properties:
properties:
created:
description: The timestamp of when the image was created.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
updated:
description: The timestamp of when the image was updated.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
deleted:
description: The timestamp of when the image was deleted.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
last_login:
description: The timestamp of when the Account was last accessed.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
2 changes: 1 addition & 1 deletion components/schemas/accounts/AccountEmployeeLogin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ title: AccountEmployeeLogin
type: object
description: A login event where the authentication mechanism was an employee login.
allOf:
- "$ref": "./AccountLogin.yml"
- $ref: "./AccountLogin.yml"
- type: object
properties:
type:
Expand Down
2 changes: 1 addition & 1 deletion components/schemas/accounts/AccountInfo.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ required:
- ip
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
ip:
type: string
description: The IP of the request used during login.
6 changes: 3 additions & 3 deletions components/schemas/accounts/AccountLogin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ required:
- success
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
account:
"$ref": "./AccountInfo.yml"
$ref: "./AccountInfo.yml"
time:
description: A timestamp of the time the login occurred.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
type:
type: string
description: The type of login mechanism used.
Expand Down
2 changes: 1 addition & 1 deletion components/schemas/accounts/AccountState.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ allOf:
- purging
- deleting
- deleted
- "$ref": "../State.yml"
- $ref: "../State.yml"
16 changes: 8 additions & 8 deletions components/schemas/announcements/Announcement.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ required:
- state
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
title:
type: string
description: A description of the event being announced.
Expand All @@ -22,7 +22,7 @@ properties:
updates:
type: array
items:
"$ref": "./AnnouncementUpdate.yml"
$ref: "./AnnouncementUpdate.yml"
affected_integrations:
type: array
items:
Expand All @@ -32,7 +32,7 @@ properties:
items:
type: string
creator:
"$ref": "../creators/CreatorScope.yml"
$ref: "../creators/CreatorScope.yml"
state:
allOf:
- required:
Expand All @@ -45,7 +45,7 @@ properties:
- live
- deleting
- deleted
- "$ref": "../State.yml"
- $ref: "../State.yml"
priority:
type: string
description: The priority or severity of the announcement.
Expand All @@ -67,13 +67,13 @@ properties:
properties:
created:
description: The timestamp of when the announcement was created.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
updated:
description: The timestamp of when the announcement was updated.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
deleted:
description: The timestamp of when the announcement was deleted.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
resolved:
description: The timestamp of when the announcement was resolved.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
2 changes: 1 addition & 1 deletion components/schemas/announcements/AnnouncementState.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ allOf:
enum:
- live
- deleted
- "$ref": "../State.yml"
- $ref: "../State.yml"
6 changes: 3 additions & 3 deletions components/schemas/announcements/AnnouncementUpdate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ required:
- time
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
message:
type: string
description: The text describing the update to the announcement.
creator:
"$ref": "../creators/CreatorScope.yml"
$ref: "../creators/CreatorScope.yml"
time:
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
description: A timestamp of when the update took place.
20 changes: 10 additions & 10 deletions components/schemas/billing/BillingOrder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,25 @@ required:
- state
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
hub_id:
"$ref": "../HubID.yml"
$ref: "../HubID.yml"
creator:
"$ref": "../creators/CreatorScope.yml"
$ref: "../creators/CreatorScope.yml"
promo_code_id:
type:
- string
- "null"
description: An ID associated with a promo code used with the order.
term:
"$ref": "./Term.yml"
$ref: "./Term.yml"
approved:
type: boolean
description: A boolean where true represents the order is approved to be paid by the user.
items:
type: array
items:
"$ref": "./orders/OrderItem.yml"
$ref: "./orders/OrderItem.yml"
total_price:
type: integer
description: 1/10th of a cent.
Expand All @@ -48,16 +48,16 @@ properties:
properties:
created:
description: The timestamp of when the billing order was created.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
updated:
description: The timestamp of when the billing order was updated.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
deleted:
description: The timestamp of when the billing order was deleted.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
expires:
description: The timestamp of when the billing order expires.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
state:
allOf:
- required:
Expand All @@ -71,4 +71,4 @@ properties:
- processed
- deleting
- deleted
- "$ref": "../State.yml"
- $ref: "../State.yml"
26 changes: 13 additions & 13 deletions components/schemas/billing/BillingService.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,24 @@ required:
- state
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
hub_id:
"$ref": "../HubID.yml"
$ref: "../HubID.yml"
creator:
"$ref": "../creators/CreatorScope.yml"
$ref: "../creators/CreatorScope.yml"
title:
type: string
description: Billing service title.
order:
"$ref": "./orders/Order.yml"
$ref: "./orders/Order.yml"
item:
"$ref": "./ServiceItem.yml"
$ref: "./ServiceItem.yml"
discount:
"$ref": "./discounts/AssociatedDiscount.yml"
$ref: "./discounts/AssociatedDiscount.yml"
price:
"$ref": "./BillingAmount.yml"
$ref: "./BillingAmount.yml"
term:
"$ref": "./Term.yml"
$ref: "./Term.yml"
events:
title: BillingServiceEvents
type: object
Expand All @@ -45,15 +45,15 @@ properties:
properties:
created:
description: The timestamp of when the billing service was created.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
updated:
description: The timestamp of when the billing service was updated.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
deleted:
description: The timestamp of when the billing service was deleted.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
last_billed:
description: The timestamp of when the billing service was last billed.
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
state:
"$ref": "./BillingServiceState.yml"
$ref: "./BillingServiceState.yml"
2 changes: 1 addition & 1 deletion components/schemas/billing/BillingServiceState.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ allOf:
type: string
enum:
- active
- "$ref": "../State.yml"
- $ref: "../State.yml"
2 changes: 1 addition & 1 deletion components/schemas/billing/BillingSummary.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ properties:
- tier
- support
term:
"$ref": "./Term.yml"
$ref: "./Term.yml"
price:
type: number
description: 1/10th of a cent (mills).
Expand Down
6 changes: 3 additions & 3 deletions components/schemas/billing/PromoCode.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ properties:
type: string
description: The promo "code".
expires:
"$ref": "../DateTime.yml"
$ref: "../DateTime.yml"
credit:
description: The amount of credit the promo code offers.
oneOf:
- type: object
properties:
amount:
"$ref": "./BillingAmount.yml"
$ref: "./BillingAmount.yml"
expires:
type: object
required:
Expand Down Expand Up @@ -47,4 +47,4 @@ properties:
enum:
- live
- deleted
- "$ref": "../State.yml"
- $ref: "../State.yml"
6 changes: 3 additions & 3 deletions components/schemas/billing/ServiceItem.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ properties:
- price
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
name:
type: string
description: The support contract name.
Expand All @@ -27,9 +27,9 @@ properties:
- price
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
name:
type: string
description: The support contract name.
price:
"$ref": "./BillingAmount.yml"
$ref: "./BillingAmount.yml"
2 changes: 1 addition & 1 deletion components/schemas/billing/ServiceOrder.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ required:
- item_id
properties:
id:
"$ref": "../ID.yml"
$ref: "../ID.yml"
item_id:
type: string
description: The ID of the billing item.
4 changes: 2 additions & 2 deletions components/schemas/billing/SupportPlan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ properties:
type: string
description: The name of the support plan.
price:
"$ref": "./BillingAmount.yml"
$ref: "./BillingAmount.yml"
description:
type: string
description: Information about the billing support plan that describes the plan.
features:
"$ref": "./SupportPlanFeatures.yml"
$ref: "./SupportPlanFeatures.yml"
contract:
type: boolean
description: A boolean where true represents the plan is a long term contract, not just month to month.
Expand Down
Loading