Skip to content

Make top-of-page links conditional #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Make top-of-page links conditional #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
430acf0
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
0ec6170
ci: Generate docs
seambot Jul 2, 2025
5d4ad6e
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
fc27818
ci: Generate docs
seambot Jul 2, 2025
93dcd1b
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
179fe4d
ci: Generate docs
seambot Jul 2, 2025
f5896e6
Update api-route.ts
DebbieAtSeam Jul 2, 2025
a4e336b
Update api-route.ts
DebbieAtSeam Jul 2, 2025
fe0e8ce
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
9960b8e
ci: Generate docs
seambot Jul 2, 2025
daafaa4
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
739ab5d
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
fbe5f0e
ci: Generate docs
seambot Jul 2, 2025
f3cad0f
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
57d1c95
ci: Generate docs
seambot Jul 2, 2025
1260a7a
Update api-resource.hbs
DebbieAtSeam Jul 2, 2025
a692b81
ci: Generate docs
seambot Jul 2, 2025
8ab8fb1
Merge branch 'main' into make-top-links-conditional
DebbieAtSeam Jul 3, 2025
58e8aba
Update api-route.ts
DebbieAtSeam Jul 3, 2025
716de6d
Merge branch 'main' into make-top-links-conditional
DebbieAtSeam Jul 3, 2025
7035377
ci: Generate docs
seambot Jul 3, 2025
7f967a0
Update api-route.ts
DebbieAtSeam Jul 3, 2025
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
2 changes: 0 additions & 2 deletions docs/api/access_grants/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
## The access_grant Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/access_methods/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@
## The access_method Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/acs/access_groups/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## The acs_access_group Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
1 change: 0 additions & 1 deletion docs/api/acs/credentials/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## The acs_credential Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)
Expand Down
2 changes: 0 additions & 2 deletions docs/api/acs/encoders/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## The acs_encoder Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/acs/entrances/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## The acs_entrance Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/client_sessions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## The client_session Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/connect_webviews/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## The connect_webview Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/devices/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4336,8 +4336,6 @@ Indicates that the temperature threshold has been exceeded.
## The device_provider Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/noise_sensors/noise_thresholds/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## The noise_threshold Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
2 changes: 0 additions & 2 deletions docs/api/phones/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

- [Properties](./#properties)
- [phone.properties](./#phone.properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)

Expand Down
3 changes: 0 additions & 3 deletions docs/api/spaces/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@
## The space Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)


Expand Down
3 changes: 0 additions & 3 deletions docs/api/thermostats/schedules/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
## The thermostat_schedule Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)


Expand Down
1 change: 0 additions & 1 deletion docs/api/user_identities/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)


Expand Down
3 changes: 0 additions & 3 deletions docs/api/webhooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
## The webhook Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)


Expand Down
3 changes: 0 additions & 3 deletions docs/api/workspaces/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
## The workspace Object

- [Properties](./#properties)
- [Errors](./#errors)
- [Warnings](./#warnings)
- [Events](./#events)
- [Endpoints](./#endpoints)


Expand Down
10 changes: 10 additions & 0 deletions src/layouts/partials/api-resource.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,24 @@
{{#unless hidePreamble}}
## The {{name}} Object

{{#if propertyGroups.length}}
- [Properties](./#properties)
{{/if}}
{{#if legacyPropertyGroups}}
- [{{name}}.properties](./#{{name}}.properties)
{{/if}}
{{#if errorGroups}}
- [Errors](./#errors)
{{/if}}
{{#if warningGroups}}
- [Warnings](./#warnings)
{{/if}}
{{#if events}}
- [Events](./#events)
{{/if}}
{{#if endpoints}}
- [Endpoints](./#endpoints)
{{/if}}

{{#if description}}

Expand Down
2 changes: 2 additions & 0 deletions src/lib/layout/api-route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ export interface ApiRouteResource {
legacyPropertyGroups?: ApiRoutePropertyGroup[]
events: ApiRouteEvent[]
hidePreamble: boolean
endpoints?: ApiRouteEndpoint[]
}

interface ApiRouteVariantGroup {
Expand Down Expand Up @@ -198,6 +199,7 @@ export const setApiRouteLayoutContext = (
warningGroups,
hidePreamble: route.path !== resource.routePath,
events: eventsByRoutePath.get(resource.routePath) ?? [],
endpoints: file.endpoints,
resourceSamples: resource.resourceSamples
.filter(({ title }) => {
if (groupOptions.include != null) {
Expand Down
Loading