-
Notifications
You must be signed in to change notification settings - Fork 948
adding attribute examples #1699
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
DerManoMann
merged 46 commits into
zircote:master
from
natsuki-engr:doc-add-attribute-examples
May 14, 2025
Merged
Changes from 1 commit
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
db238f2
add in faq
natsuki-engr 10d4922
OAT to OA
natsuki-engr c0d15f4
x-tagGroups
natsuki-engr 92e2948
response examples
natsuki-engr 5279f0e
external docs
natsuki-engr 3dac190
union types
natsuki-engr 014f798
security schemes
natsuki-engr 6cf387f
secure endpoint
natsuki-engr e9c79c4
multiple security schemes
natsuki-engr 7ac5462
file upload
natsuki-engr 5a713f2
add success response description in attribute example
natsuki-engr 9da2add
xml content response
natsuki-engr f222208
upload multipart/form-data
natsuki-engr 6894ed5
nested structure with @OA\Property
natsuki-engr 7821474
expression of single or list by oneOf
natsuki-engr b341a18
reusing responses
natsuki-engr 80f6ff9
callbacks
natsuki-engr 8c166af
virtual model
natsuki-engr b902bb8
class name as type
natsuki-engr bf2837a
enums
natsuki-engr a918967
multi value query parameter
natsuki-engr 61b4348
custom response classes
natsuki-engr 5d37e10
class constants
natsuki-engr 10b6f3e
fix wrong id
natsuki-engr 72d01d3
rename wrong file name
natsuki-engr f5c6f64
context awareness
natsuki-engr 7762311
response MediaType and JsonContent
natsuki-engr 3b3596b
using $ref
natsuki-engr 40c9a98
custom property
natsuki-engr e052848
enum as values
natsuki-engr ae962ba
backed enum names as schema
natsuki-engr 71fd7d0
backed enum values as schema
natsuki-engr eb50568
replace singlequote to double quote
natsuki-engr d57f1a7
enum as schema
natsuki-engr 7f824e4
Merge remote-tracking branch 'origin/master' into doc-add-attribute-e…
natsuki-engr 341c15c
fix errors
natsuki-engr 64ba8bb
fix syntax error
natsuki-engr cac0c6b
fix syntax error
natsuki-engr c36bc1c
remove tabs of custom response example
natsuki-engr 447f406
fix syntax error
natsuki-engr db91eea
move example file into inline
natsuki-engr e04d06b
add referred schema
natsuki-engr d543878
add use statement
natsuki-engr c6390d5
Merge remote-tracking branch 'origin/master' into doc-add-attribute-e…
natsuki-engr 75d06b7
add docs/snippets to CS
natsuki-engr 66d7e95
apply style of code_sniffer to docs/snippets
natsuki-engr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<?php | ||
|
||
/** | ||
* @OA\Tag( | ||
* name="user", | ||
* description="User related operations" | ||
* ) | ||
* @OA\Info( | ||
* version="1.0", | ||
* title="Example API", | ||
* description="Example info", | ||
* @OA\Contact(name="Swagger API Team") | ||
* ) | ||
* @OA\Server( | ||
* url="https://example.localhost", | ||
* description="API server" | ||
* ) | ||
*/ | ||
class OpenApiSpec | ||
{ | ||
} |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<?php | ||
|
||
use OpenApi\Attributes as OAT; | ||
natsuki-engr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
#[OAT\Tag(name: "user", description: "User related operations")] | ||
#[OAT\Info( | ||
version: "1.0", | ||
title: "Example API", | ||
description: "Example info", | ||
contact: new OAT\Contact(name: "Swagger API Team"), | ||
)] | ||
#[OAT\Server( | ||
url: "https://example.localhost", | ||
description: "API server", | ||
)] | ||
class OpenApiSpec | ||
{ | ||
} |
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.
Uh oh!
There was an error while loading. Please reload this page.