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

V14/feature/custom generic swagger #15025

Merged
merged 5 commits into from
Nov 7, 2023

Conversation

Migaroez
Copy link
Contributor

@Migaroez Migaroez commented Oct 23, 2023

Prerequisites

  • I have added steps to test this contribution in the description below

Description

Some of the generic names in the swagger docs are excessively long without giving useful meaning.

Requirements / todo

  • Come up with a maintainable, typed implementation
  • Doublecheck implementation matches purpose
  • Check whether more models require this treatment
  • Verify performance/magic strings usage
  • OpenApi spec has been updated

Reporoduction

Open management api swagger: /umbraco/swagger/index.html?urls.primaryName=Umbraco%20Management%20API
Verify ContentTypeResponseModelBaseDocumentTypePropertyTypeResponseModelDocumentTypePropertyTypeContainerResponseModel is now ContentTypeForDocumentTypeResponseModel

Before merging

  • Check with frontend

@Migaroez Migaroez changed the base branch from contrib to v14/dev October 23, 2023 15:00
Copy link
Member

@bergmania bergmania left a comment

Choose a reason for hiding this comment

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

We will need to update the OpenApi.json file, but I like the idea of an attribute.

Obviously we need to coordinate with frontend when to merge

@Migaroez Migaroez marked this pull request as ready for review November 6, 2023 14:44
@Migaroez
Copy link
Contributor Author

Migaroez commented Nov 6, 2023

@nielslyngsoe Let me know when you are ready for this to be merged in

@nielslyngsoe nielslyngsoe merged commit 2f4f2ae into v14/dev Nov 7, 2023
13 checks passed
@nielslyngsoe nielslyngsoe deleted the v14/feature/customGenericSwagger branch November 7, 2023 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants