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.

Sign up for GitHub

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

Jump to bottom

Swagger API docs example value not showing proper values #2160

Closed
Zejnilovic opened this issue Jan 12, 2023 · 2 comments · Fixed by #2178
Closed

Swagger API docs example value not showing proper values #2160

Zejnilovic opened this issue Jan 12, 2023 · 2 comments · Fixed by #2178
Assignees
@dk1844
Labels
bug Something isn't working documentation Improvements or additions to documentation priority: low Nice to have Rest-API Rest-API component affected

Comments

@Zejnilovic
Copy link
Contributor

Describe the bug

When I run swagger API docs and look at the example value for both, create and returns, and I don't very well understand them, and they don't look like what I would expect.

Screenshots

image
@Zejnilovic Zejnilovic added bug Something isn't working priority: undecided Undecided priority to be assigned after discussion Rest-API Rest-API component affected labels Jan 12, 2023
@benedeki benedeki added priority: low Nice to have documentation Improvements or additions to documentation and removed priority: undecided Undecided priority to be assigned after discussion labels Jan 17, 2023
@dk1844 dk1844 self-assigned this Feb 3, 2023
dk1844 added a commit that referenced this issue Feb 17, 2023
@dk1844
#2160 openApi3 added
d227084 
 - !! generated types for VersionModel descendants is incorrect !!
 - spring updated
@dk1844
Copy link
Contributor

dk1844 commented Feb 17, 2023

To be inspired by AbsaOSS/login-service#14

dk1844 added a commit that referenced this issue Feb 17, 2023
@dk1844
#2160 openApi3:
e379f49 
 - annotation of Dataset/VersionModel updated for SpringDoc - works relatively ok in swagger. = TODO Schema, MT, PropertyDefinition
dk1844 added a commit that referenced this issue Feb 20, 2023
@dk1844
#2160 openApi3: Schema, SchemaField, and Reference covered
dcf5f4a
dk1844 added a commit that referenced this issue Feb 21, 2023
@dk1844
#2160 openApi3: examples added for Schema, SchemaField, Reference
d669b55
dk1844 added a commit that referenced this issue Feb 21, 2023
@dk1844
#2160 openApi3: Dataset annotations improved
7655739
dk1844 added a commit that referenced this issue Feb 22, 2023
@dk1844
#2160 openApi3: Dataset+Validation annotations improved
1ed4f30
dk1844 added a commit that referenced this issue Feb 22, 2023
@dk1844
#2160 openApi3: MT, defaultValue annotations added; annotations for D…
4446bc2 
…ataset, Schema updated

MappingTable.{defaultMappingValue -> defaultMappingValues} method renamed
dk1844 added a commit that referenced this issue Feb 23, 2023
@dk1844
#2160 openApi3 added: PropertyDefinition
310d90c
dk1844 added a commit that referenced this issue Mar 1, 2023
@dk1844
#2160 openApi3: MT filter example added
0a55aaf
dk1844 added a commit that referenced this issue Mar 1, 2023
@dk1844
#2160 openApi3: conformance rules discriminatory schema settings
5fb4dc1
dk1844 added a commit that referenced this issue Mar 1, 2023
@dk1844
#2160 openApi3: some examples for conformanceRules added (including s…
004cd3d 
…tring list fields)
dk1844 added a commit that referenced this issue Mar 1, 2023
@dk1844
#2160 openApi3: testfix
6bf0e70
dk1844 added a commit that referenced this issue Mar 2, 2023
@dk1844
#2160 openApi3: version incompatibility in integration, reverting to …
8190eaa 
…develop
dk1844 added a commit that referenced this issue Mar 2, 2023
@dk1844
#2160 cleanup
30456a0
@dk1844 dk1844 mentioned this issue Mar 2, 2023
Merged
dk1844 added a commit that referenced this issue Mar 2, 2023
@dk1844
#2160 versions references from parent/pom.xml used
fb7e6e3
dk1844 added a commit that referenced this issue Mar 3, 2023
@dk1844
#2160 openApi3: reverted MT.defaultMappingValues -> MT.defaultMapping…
2b78a00 
…Value (while the getDefaultMappingValueAsMap being present, but excluded from serialization)
dk1844 added a commit that referenced this issue Mar 3, 2023
@dk1844
#2160 openApi3: GroupedOpenApi labels (ordering is done based on grou…
f040f32 
…p name, not display name!)
dk1844 added a commit that referenced this issue Mar 3, 2023
@dk1844
#2160 cleanup
4e47766
dk1844 added a commit that referenced this issue Mar 7, 2023
@dk1844
#2160 spring version revereted (2.0.9.RELEASE -> 2.0.0.RELEASE) to fi…
7edf180 
…x the issue where 404 was returned in place of 401
dk1844 added a commit that referenced this issue Mar 7, 2023
@dk1844
#2160 swagger now has JWT header auth option (custom impl - just JWT …
e893297 
…header, no bearer!)
dk1844 added a commit that referenced this issue Mar 8, 2023
@dk1844
#2160 /api/login in swagger
937840a
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 typos, imports fix
280314f
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 spring profile (dev) removed -> reflected in README.md
f3cc304
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 imports fix
2061933
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 comment removed
e947222
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 401 unauthorized api response added, authentication label editied
6cea459
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 403 Forbidden reponse annotations added where needed (preauth),…
2271c67 
… comment cleanup
dk1844 added a commit that referenced this issue Mar 14, 2023
@dk1844
#2160 swagger masking login pwd, other swagger config settings
a037e88
dk1844 added a commit that referenced this issue Mar 16, 2023
@dk1844
Feature/2160 openapi3 (#2178)
77bc82a 
* #2160 openApi3:
 - SpringDoc replacing SpringFox
 - annotation of Dataset, VersionModel,Schema,SchemaField, Reference, MT, PropertyDefinition, Validation
 - conformance rules discriminatory schema settings for correct inheritance
 - MT.defaultMappingValue present (while the getDefaultMappingValueAsMap being present, but excluded from serialization)
 - GroupedOpenApi labels (ordering is done based on group name, not display name!)
- JWT header auth option (custom impl - just JWT header, no bearer!)
- spring profile (dev) removed -> reflected in README.md
 - 401 unauthorized api response added, authentication has custom OpenAPI description
 - 403 Forbidden response annotations added where needed (preauth), comment cleanup
 - swagger masking login pwd in UI
@dk1844
Copy link
Contributor

dk1844 commented Mar 16, 2023 •
edited

Release notes:
SpringFox implementation replaced by newer SpringDoc -> brings OpenAPI 3 (can be generated from annotations), newer swagger with more info, examples, and JWT working (/api/login is part of OpenAPI and can be used in Swagger UI, too).

@miroslavpojer miroslavpojer mentioned this issue Mar 30, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dk1844 dk1844

Labels
bug Something isn't working documentation Improvements or additions to documentation priority: low Nice to have Rest-API Rest-API component affected
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feature/2160 openapi3 AbsaOSS/enceladus
3 participants
@dk1844 @benedeki @Zejnilovic