Skip to content

Conversation

@si-net
Copy link
Collaborator

@si-net si-net commented Nov 4, 2025

Description

Integrate the Scalar Plugin to render open-api files. We are especially interested in rendering the new Real Device Access API.

Motivation and Context

Currently we maintain our API contracts by translating the open-api spec manually to html.

This is not scalable and error prone in case of changes to the API.

We therefore introduce 'scalar' plugin, which can read and render open-api files.

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation fix (typos, incorrect content, missing content, etc.)

@si-net si-net changed the title Integrate 'Scalar' openapi plugin to render Real Device Access API Integrate 'Scalar' openapi plugin so that we can render Real Device Access API Nov 4, 2025
@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

1 similar comment
@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 4, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 5, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

{
// This title will appear in the top left dropdown within Scalar API doc.
title: 'Real Device Access API',
url: 'https://raw.githubusercontent.com/saucelabs/real-device-api/6b34c94ae9be3af027cad344bcfd01f319ef270d/open_api_specification.yaml',
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revert previous commit

@github-actions
Copy link

github-actions bot commented Nov 5, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

github-actions bot commented Nov 6, 2025

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

1 similar comment
@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

@github-actions
Copy link

Deploy preview ready for 3312!
https://docs.dev.saucelabs.net/pr-preview/pr-3312

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants