platform-api-integration

What problem does it solve?

Integrating with multiple Rubin Science Platform (RSP) APIs, each with its own OpenAPI specification and authentication patterns, can be complex and time-consuming. This skill provides a comprehensive guide to streamline API discovery, type generation, data fetching, and mock API development.

Core Features & Use Cases

• OpenAPI-Driven Integration: Guides on using OpenAPI specifications to discover endpoints, generate TypeScript types, and understand API schemas for Gafaelfawr (authentication) and Times Square (notebooks).
• SWR-Based Data Fetching: Provides patterns for implementing robust, cached data fetching hooks with SWR, including error handling, polling, and pagination.
• Authentication & Mocking: Covers handling Gafaelfawr's CSRF tokens, cookie-based authentication, and setting up mock API endpoints for efficient local development.
• Use Case: When building a new feature that requires user authentication and token management from Gafaelfawr, use this skill to quickly find the relevant OpenAPI specs, generate types, implement SWR hooks with CSRF token handling, and set up local mocks.

Quick Start

Discover all available endpoints and their descriptions for the Gafaelfawr authentication API. WebFetch({ url: 'https://gafaelfawr.lsst.io/_static/openapi.json', prompt: 'Show me all endpoints and their descriptions' })