Azure / Azure/azure-functions-openapi-extension
OpenApiResponseBody is obsolete but mentioned in docs
- Dominant language
- C#
- Stars
- 388
- Forks
- 202
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/Azure/azure-functions-openapi-extension/blob/main/docs/openapi-core.md#expose-endpoints-to-openapi-document
This page uses `OpenApiResponseBody` instead of `OpenApiResponseWithBody`, but the former is [marked obsolete](https://github.com/Azure/azure-functions-openapi-extension/blob/main/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Attributes/OpenApiResponseBodyAttribute.cs#L9)
Contributor guide
Research direction
Open docs/openapi-core.md at the “Expose endpoints to OpenAPI document” section and compare its attribute name with the linked obsolete OpenApiResponseBodyAttribute declaration. Update the documentation to use OpenApiResponseWithBody, then verify that the referenced example no longer mentions the obsolete attribute.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100