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
126 changes: 80 additions & 46 deletions openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/resources/feature_privilege.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ parameters:
delete:
tags:
- features
summary: Delete a privilege. Deleting a privilege removes it from all plans and subscriptions.
description: Delete privilege from feature. Deleting a privilege removes it from all plans and subscriptions.
summary: Delete a privilege
description: This endpoint deletes a privilege from a feature. Deleting a privilege removes it from all plans and subscriptions.
operationId: deleteFeaturePrivilege
responses:
'200':
Expand Down
2 changes: 1 addition & 1 deletion src/resources/plan_entitlements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ patch:
tags:
- entitlements
summary: Partial update of an entitlement
description: This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
description: This accepts a list of entitlements to update. If the feature isn't part of the plan yet, it's added with all the privileges from the payload. If the feature is already part of the plan, the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
operationId: updateEntitlement
requestBody:
description: Entitlement payload
Expand Down
6 changes: 3 additions & 3 deletions src/resources/subscription_entitlement.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,17 @@ delete:
tags:
- entitlements
summary: Remove an entitlement from a subscription
description: This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan.
description: This endpoint removes a specific feature entitlement from a subscription. The entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
operationId: destroySubscriptionEntitlement
parameters:
- $ref: "../parameters/subscription_status.yaml"
responses:
'200':
description: Subscription entitlement removed
description: Remaining subscription entitlements
content:
application/json:
schema:
$ref: '../schemas/Entitlement/SubscriptionEntitlement.yaml'
$ref: '../schemas/Entitlement/SubscriptionEntitlements.yaml'
'401':
$ref: '../responses/Unauthorized.yaml'
'404':
Expand Down
6 changes: 3 additions & 3 deletions src/resources/subscription_entitlement_privileges.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ delete:
tags:
- entitlements
summary: Remove a privilege from a subscription entitlement override
description: This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan.
description: This endpoint removes a specific privilege from a subscription entitlement. The privilege entitlement remains available from the plan. It returns the full list of entitlements remaining on the subscription.
operationId: destroySubscriptionEntitlementPrivilege
parameters:
- $ref: "../parameters/subscription_status.yaml"
responses:
'200':
description: Subscription entitlement with privilege override removed
description: Remaining subscription entitlements
content:
application/json:
schema:
$ref: '../schemas/Entitlement/SubscriptionEntitlement.yaml'
$ref: '../schemas/Entitlement/SubscriptionEntitlements.yaml'
'400':
$ref: '../responses/BadRequest.yaml'
'401':
Expand Down
2 changes: 1 addition & 1 deletion src/resources/subscription_entitlements.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ patch:
summary: Update subscription entitlements
parameters:
- $ref: "../parameters/subscription_status.yaml"
description: This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
description: This accepts a list of entitlements to update. If the feature isn't part of the subscription yet, it's added with all the privileges from the payload. If the feature is already part of the subscription (via plan or via override), the privilege and values are updated or added. All privileges must be valid for the feature. All features and privileges not part of the payload are left untouched. To remove privileges or features, use the DELETE endpoints.
operationId: updateSubscriptionEntitlements
requestBody:
description: Subscription entitlements payload
Expand Down
Loading
Loading