Skip to content

Commit 8d603e8

Browse files
committed
Fix subscription documentation
1 parent f8bf413 commit 8d603e8

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

src/docs/subscriptions.adoc

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:sectlinks:
44

55
The `subscriptions` endpoint exposes operations taken on subscriptions.
6-
A subscriptionEntity represents two things:
6+
A subscription represents two things:
77

88
1. A podcast feed
99
2. The relationship between a user and a podcast feed
@@ -16,8 +16,8 @@ POST /api/v1/users
1616
[[actions-subscriptions-create]]
1717
== Create subscriptions
1818

19-
When a user adds a subscription to the system, a corresponding `subscriptionEntity` object is fetched or created depending on whether a matching subscriptionEntity is present.
20-
A link is then created between the user and the subscriptionEntity.
19+
When a user adds a subscription to the system, a corresponding `subscription` object is fetched or created depending on whether a matching subscription is present.
20+
A link is then created between the user and the subscription.
2121

2222
operation::subscriptions-bulk-create-mixed[snippets='request-headers,request-fields,curl-request,response-fields,http-response']
2323

@@ -38,28 +38,27 @@ include::{snippets}/subscriptions-bulk-create-mixed/http-response.adoc[]
3838
[[actions-subscriptions-list]]
3939
== List subscriptions
4040

41-
When a user fetches a list of subscriptions, their own subscriptions are returned.
42-
The subscriptions of other users are not returned.
41+
When a user fetches a list of subscriptions, only their own subscriptions are returned.
4342

4443
operation::subscriptions-list[snippets='request-headers,query-parameters,curl-request,response-fields,http-response']
4544

4645
=== Include unsubscribed
4746

4847
operation::subscriptions-list-with-unsubscribed[snippets='curl-request,http-response']
4948

50-
[[actions-subscriptionEntity-fetch]]
51-
== Fetch a single subscriptionEntity
49+
[[actions-subscription-fetch]]
50+
== Fetch a single subscription
5251

53-
Returns the details of a single subscriptionEntity for the authenticated user.
54-
Returns `404` if the user has no subscriptionEntity entry for the feed in question.
52+
Returns the details of a single subscription for the authenticated user.
53+
Returns `404` if the user has no subscription entry for the feed in question.
5554

5655
operation::subscription-get[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']
5756

58-
[[actions-subscriptionEntity-update]]
57+
[[actions-subscription-update]]
5958
== Unsubscribe from a feed
6059

6160
Unsubscribes the authenticated user from a feed.
62-
This action updates the user subscriptionEntity record to mark the subscriptionEntity as inactive.
63-
It does not delete the subscriptionEntity record.
61+
This action updates the user subscription record to mark the subscription as inactive.
62+
It does not delete the subscription record.
6463

6564
operation::subscription-unsubscribe[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']

0 commit comments

Comments
 (0)