Azure / Azure/azure-rest-api-specs

Relative URL: Not resolving when linked from elsewhere.

Open
#27,635 0 comments 0 reactions 0 assignees View on GitHub
Cognitive Services customer-reported question Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

Not sure where the spec originally comes from, but the link to the guide ('See the `[guide](/docs/guides/gpt/function-calling)` for examples') https://github.com/Azure/azure-rest-api-specs/blob/73d1e6522dfdedb795f46cf997921c623011caa6/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json#L1087 is sadly a relative URL. When coming from the Azure docs (https://learn.microsoft.com/en-us/azure/ai-services/openai/reference) only the spec file (https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json) is linked, so it's unclear where the guide ought to be.

Contributor guide

Open the contributing guide

Research direction

Start at specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-09-01-preview/inference.json around line 1087 and compare how the link is rendered from the Microsoft Azure OpenAI reference. Confirm the guide link resolves to the intended destination when reached through the published documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.