Skip to content

OpenAPI: Set the describedby top-level link #1497

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

Merged
merged 2 commits into from
Mar 11, 2024
Merged

Conversation

bkoelman
Copy link
Member

@bkoelman bkoelman commented Mar 11, 2024

Closes #1456.

After adding the next lines to JsonApiDotNetCoreExample\Program.cs:

builder.Services.Configure<SwaggerOptions>(
    options => options.RouteTemplate = "api-docs/{documentName}/openapi.yaml");

// ...

app.UseSwaggerUI(options => options.SwaggerEndpoint("/api-docs/v1/openapi.yaml", "ExampleAPI V1"));

image

image

QUALITY CHECKLIST

@bkoelman bkoelman changed the title Links described by OpenAPI: Set the describedby top-level link Mar 11, 2024
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

Attention: Patch coverage is 88.88889% with 3 lines in your changes are missing coverage. Please review.

Project coverage is 90.79%. Comparing base (22b00b3) to head (6b5bb6a).

Files Patch % Lines
...tNetCore.OpenApi/OpenApiDescriptionLinkProvider.cs 84.61% 1 Missing and 1 partial ⚠️
...re.OpenApi/JsonApiRequestFormatMetadataProvider.cs 50.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           openapi    #1497      +/-   ##
===========================================
- Coverage    90.79%   90.79%   -0.01%     
===========================================
  Files          393      394       +1     
  Lines        12938    12957      +19     
  Branches      2055     2057       +2     
===========================================
+ Hits         11747    11764      +17     
- Misses         776      777       +1     
- Partials       415      416       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bkoelman bkoelman marked this pull request as ready for review March 11, 2024 02:26
@bkoelman bkoelman merged commit ff2f420 into openapi Mar 11, 2024
16 checks passed
@bkoelman bkoelman deleted the links-described-by branch March 11, 2024 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant