rock-n-code/amiibo-service
1
0
Fork 0
Code Issues Pull Requests Actions Releases 16 Activity

Open API and documentation improvements #20

Merged
javier merged 7 commits from library/openapi-improvements into main 2025-10-28 15:41:03 +00:00
Conversation 0 Commits 7 Files Changed 125
+181 -175
javier commented 2025-10-28 15:40:54 +00:00
Owner
Copy Link
Copy Source

This PR contains the work done to polish the Open API specification document as well as the DocC documentation even further, by removing unnecessary intermediate types and adding missing documentation.

This PR contains the work done to polish the `Open API` specification document as well as the `DocC` documentation even further, by removing unnecessary intermediate types and adding missing documentation.
javier added the Kind/EnhancementKind/Documentation
Priority
Medium
 labels 2025-10-28 15:40:54 +00:00
javier self-assigned this 2025-10-28 15:40:54 +00:00
javier added 7 commits 2025-10-28 15:40:54 +00:00
Removed the definitions of the intermediary list types from the Open API specification document in the library target. 7cd3217a89
Improved the "head" and "tail" properties for the Amiibo type of the Open API specification document in the library target. d5c6863e0a
Improved the "key" property for the Tuple type of the Open API specification document in the library target. 565f02bd69
Updated a test case for the AmiiboServiceLiveTests suite in the tests target. 88f9705532
Improved the documentation for the AmiiboSeries, AmiiboType, GameCharacter, and GameSeries types in the library target. cdf391a29f
Moved the Amiibo nested model from the Library article in the DocC documentation catalog in the library target to its own Amiibo extension. fc95142b2c
Regenerated the Github Pages documentation from the DocC documentation catalog in the library target. 85d8baca26
javier merged commit 0d9c9e22a4 into main 2025-10-28 15:41:03 +00:00
javier deleted branch library/openapi-improvements 2025-10-28 15:41:03 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status
Need More Info
Feedback is required to reproduce issue or to continue work
No labels Kind/Documentation Kind/Enhancement
Priority
Medium
Milestone
No items
No Milestone
Assignees
Clear assignees
javier (Javier Cicchelli)
No Assignees javier
1 Participants
Notifications
Due Date
No due date set.
Reference: rock-n-code/amiibo-service#20