Skip to content

open-api.md

Latest commit

 

History

History
48 lines (32 loc) · 2.53 KB

open-api.md

File metadata and controls

48 lines (32 loc) · 2.53 KB
Raw

Spaces — Open API Module

Parent: Spaces Overview · Sibling: Webhooks · Related: CDN & Caching · Auth Tokens

Purpose

Renders an interactive OpenAPI UI (Stoplight Elements) for the space's public REST API. Allows developers to explore and test the CDN endpoints directly from the CMS.

This module lives under the Developers section alongside Webhooks, rendered via DevelopersComponent's <router-outlet>.

Route

/features/spaces/:spaceId/developers/open-api

There is no route guard: neither the developers route in features-routing.module.ts nor developers-routing.module.ts has a canActivate. DEV_OPEN_API only controls whether the sidebar item is shown (see Spaces Overview).

Key Files

src/app/features/spaces/developers/
  developers.component.ts/html/scss        ← shell, router-outlet only
  developers-routing.module.ts             ← redirects '' to 'webhooks'; children: webhooks, webhooks/:webhookId, open-api
  open-api/
    open-api.component.ts/html/scss
    stoplight-elements.d.ts                ← type declaration for the '@stoplight/elements/web-components.min.js' import

OpenApiComponent

Renders the spec with the Stoplight Elements web component <elements-api> (router="memory", layout="sidebar"). The component uses CUSTOM_ELEMENTS_SCHEMA to allow non-Angular web components in the template.

The Elements bundle (~2MB) is lazy-loaded on this route only via import('@stoplight/elements/web-components.min.js') rather than a global angular.json script. Once it resolves, the elementsReady signal is set; until both the bundle and the spec are available, an hlm-progress bar is shown instead.

Injected services: OpenApiService, SpaceStore

Key behaviour:

  • ngOnInit() — reads spaceId from spaceStore.selectedSpaceId() and calls OpenApiService.generate(spaceId), which invokes the openapi-generate callable and returns the spec as a string; then starts loading the Elements bundle. The callable requires sign-in and DEV_OPEN_API (admins always pass), so it enforces the same permission the sidebar item checks
  • Passes the generated spec (as apiDescriptionDocument) to the web component for rendering
  • The spec covers all CDN endpoints: translations, links, content by slug, content by ID, assets

Services Used

Service Purpose
OpenApiService Generates the OpenAPI 3.0 spec document for the space