Skip to content
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.

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

Demo REST API embedded docs #780

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Demo REST API embedded docs #780

wants to merge 1 commit into from

Conversation

djfarrelly
Copy link
Member

A demo to consider moving from spotlight to putting it right into our docs.

Copy link

vercel bot commented May 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 15, 2024 7:24pm

@@ -0,0 +1,102 @@
export const description = "Returns a single function run by its run ID. Response includes status, output, and timestamps."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
export const description = "Returns a single function run by its run ID. Response includes status, output, and timestamps."
export const description = "REST API: Get a function run (Returns a single function run by its run ID. Response includes status, output, and timestamps.)"

More descriptive of what this page is about and where it belongs


# Get a function run {{ tag: 'GET', label: '/v1/runs/{runID}' }}

Returns a single function run by its run ID
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Returns a single function run by its run ID
Returns a single function run by its run ID.

Copy link
Contributor

@sylwiavargas sylwiavargas left a comment

Choose a reason for hiding this comment

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

Thank you, looks great!

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.

None yet

2 participants