This repository has been archived by the owner on May 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
v4 #154
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Renaming `@api-throws` to `@api-error`.
Moving `@api-error` over to a MSON-like syntax.
@api-vendortag
Simplified URI grouping
Simplified pathing
Now throwing an exception when `string` MSON should be written as `enum`
Adding a new `@api-maxversion` annotation.
Properly converting subtyeps to API Blueprint-compatible types.
Scopes will now carry with `@api-see` annotations.
OpenAPI compiler
OpenAPI fixes
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added
@api-vendortag
annotation, replacing@api-capability
.@api-vendorTag
#148@api-maxversion
. Same as@api-minversion
, but the opposite. @api-maxversion #161@api-param
. Parameters don't support subtypes #159@api-queryparam
annotation for documenting parameters that are to be used in query strings.@api-param
now represents body payloads. Denoting the payload format for an API parameter #109authentication
,info
andservers
OpenAPI fixes #173Changed
generate
command is now calledcompile
. Create an OAI 3.0 generator #16@api-throws
to@api-error
. Rename@api-throws
to@api-error
#141@api-error
annotations now have a new MSON syntax. Moving@api-error
over to a MSON-like syntax. #155@api-uri
is now@api-path
. Simplified pathing #162@api-urisegment
is now@api-pathparam
. Simplified pathing #162scopes
config is now nested withinauthentication
. OpenAPI fixes #173generators
config is now calledcompilers
. Create an OAI 3.0 generator #16Fixed
enum
annotations (annotations with member values) are written asstring
. Representation data that's a string, but with members doesn't get recognized as an enum #150@api-see
annotations, much like@api-version
is already. Scope not applied to@api-see
annotations #140Removed
@api-capability
has been removed and replaced with a new@api-vendorTag
system.@api-vendorTag
#148