Skip to content

Commit 3da0bf5

Browse files
committed
Improve documentation formatting
1 parent 39f7658 commit 3da0bf5

4 files changed

Lines changed: 10 additions & 19 deletions

File tree

src/docs/auth.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,8 @@
44

55
The `auth` endpoint exposes operations for authenticating against the API.
66

7-
[[actions-auth]]
8-
== Actions
9-
107
[[actions-login]]
11-
=== Log in
8+
== Log in
129

1310
[source,httprequest]
1411
----
@@ -21,7 +18,7 @@ These values must match the values of the user's account.
2118
operation::auth-token[snippets='request-fields,curl-request,response-fields,http-response']
2219

2320
[[actions-refresh]]
24-
=== Request a new access token
21+
== Request a new access token
2522

2623
You can request a new access token by passing a valid refresh value to the API.
2724

src/docs/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:icons: font
44
:source-highlighter: highlightjs
55
:toc: right
6-
:toclevels: 2
6+
:toclevels: 1
77
:sectlinks:
88

99
This server implements the https://openpodcastapi.org[Open Podcast API].

src/docs/subscriptions.adoc

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,20 @@ A subscriptionEntity represents two things:
88
1. A podcast feed
99
2. The relationship between a user and a podcast feed
1010
11-
[[actions-subscriptions]]
12-
== Actions
13-
1411
[source,httprequest]
1512
----
1613
POST /api/v1/users
1714
----
1815

1916
[[actions-subscriptions-create]]
20-
=== Create subscriptions
17+
== Create subscriptions
2118

2219
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.
2320
A link is then created between the user and the subscriptionEntity.
2421

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

27-
==== Responses
24+
=== Responses
2825

2926
If all feeds are valid and no problems are encountered, the server responds with an array of `success` objects and an empty array of `failure` objects.
3027

@@ -39,27 +36,27 @@ If the server receives a mix of responses, both arrays are populated.
3936
include::{snippets}/subscriptions-bulk-create-mixed/http-response.adoc[]
4037

4138
[[actions-subscriptions-list]]
42-
=== List subscriptions
39+
== List subscriptions
4340

4441
When a user fetches a list of subscriptions, their own subscriptions are returned.
4542
The subscriptions of other users are not returned.
4643

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

49-
==== Include unsubscribed
46+
=== Include unsubscribed
5047

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

5350
[[actions-subscriptionEntity-fetch]]
54-
=== Fetch a single subscriptionEntity
51+
== Fetch a single subscriptionEntity
5552

5653
Returns the details of a single subscriptionEntity for the authenticated user.
5754
Returns `404` if the user has no subscriptionEntity entry for the feed in question.
5855

5956
operation::subscriptionEntity-get[snippets='request-headers,path-parameters,curl-request,response-fields,http-response']
6057

6158
[[actions-subscriptionEntity-update]]
62-
=== Unsubscribe from a feed
59+
== Unsubscribe from a feed
6360

6461
Unsubscribes the authenticated user from a feed.
6562
This action updates the user subscriptionEntity record to mark the subscriptionEntity as inactive.

src/docs/users.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,8 @@
55
The `users` endpoint exposes operations taken on user accounts.
66
Users may update and delete their own user record, but only admins may update and alter the records of other users.
77

8-
[[actions-users]]
9-
== Actions
10-
118
[[actions-users-get]]
12-
=== Get all users
9+
== Get all users
1310

1411
[source,httprequest]
1512
----

0 commit comments

Comments
 (0)