From 1c5adb17fd731fe3641c904e67a996e78e85ad63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fujita=20Haruka=28=E8=97=A4=E7=94=B0=20=E6=98=A5=E4=BD=B3?= =?UTF-8?q?=29?= Date: Thu, 28 Dec 2023 14:01:26 +0900 Subject: [PATCH 1/3] fix: reflect comments --- .../OpenAPI_Specification_3.0.3.md | 210 +++++++++--------- 1 file changed, 102 insertions(+), 108 deletions(-) diff --git a/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md b/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md index 8b5cf03d..1682d569 100644 --- a/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md +++ b/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md @@ -1246,28 +1246,31 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 name: MIT servers: - url: http://petstore.swagger.io/v1 + tags: + - name: pets + description: Everything about your Pets paths: /pets: get: - $ref: "./pets_get/pets_get.yaml" + $ref: "./pets_get/pets_get.yaml#/operation" post: - $ref: "./pets_post/pets_post.yaml" + $ref: "./pets_post/pets_post.yaml#/operation" /pets/{petId}: get: - $ref: "./pets-pet-id_get/pets-pet-id_get.yaml" + $ref: "./pets-pet-id_get/pets-pet-id_get.yaml#/operation" components: schemas: ResPetsGet: - $ref: "./pets_get/response.yaml" + $ref: "./pets_get/pets_get.yaml#/components/schemas/ResPetsGet" ReqPetsPost: - $ref: "./pets_post/request.yaml" + $ref: "./pets_post/pets_post.yaml#/components/schemas/ReqPetsPost" ResPetsPetIdGet: - $ref: "./pets-pet-id_get/response.yaml#/ResPetsPetIdGet" + $ref: "./pets-pet-id_get/pets-pet-id_get.yaml#/components/schemas/ResPetsPetIdGet" PetDetail: - $ref: "./pets-pet-id_get/response.yaml#/PetDetail" + $ref: "./pets-pet-id_get/pets-pet-id_get.yaml#/components/schemas/PetDetail" Pedigree: - $ref: "./pets-pet-id_get/response.yaml#/Pedigree" + $ref: "./pets-pet-id_get/pets-pet-id_get.yaml#/components/schemas/Pedigree" Pet: $ref: "./common/pet.yaml" Error: @@ -1280,132 +1283,120 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 ファイル分割例： ディレクトリ構成 ```sh - │ openapi.gen.yaml - │ openapi.yaml + ├─openapi.gen.yaml + ├─openapi.yaml │ ├─common - │ error.yaml - │ pet.yaml + │ ├─error.yaml + │ └─pet.yaml │ ├─pets-pet-id_get - │ │ pets-pet-id_get.yaml - │ │ response.yaml - │ │ + │ ├─pets-pet-id_get.yaml │ └─examples - │ res_example1.yaml + │ └─res_example1.yaml │ ├─pets_get - │ │ pets_get.yaml - │ │ response.yaml - │ │ + │ ├─pets_get.yaml │ └─examples - │ res_example1.yaml - │ res_example2.yaml + │ ├─res_example1.yaml + │ └─res_example2.yaml │ └─pets_post - │ pets_post.yaml - │ request.yaml - │ + ├─pets_post.yaml └─examples - req_example1.yaml + └─req_example1.yaml ``` -- `openapi.yaml` の `paths` に記載したAPIファイルは以下のように作成する。`schema` にて `openapi.yaml` に指定したキー（`../openapi.yaml#/components/schemas/ResPetsPetIdGet`）を参照する。 +- `openapi.yaml` の `paths` に記載したAPIファイルは以下のように作成する。 +- `schema` にて `openapi.yaml` に指定したキー（`../openapi.yaml#/components/schemas/ResPetsPetIdGet`）を参照する。 +- 複数API間に共通のモデルについても `openapi.yaml` に指定したキー（`../openapi.yaml#/components/schemas/Pet`）を参照する。 +- ネストしているモデルについても `openapi.yaml` に指定したキーを経由して参照する（`../openapi.yaml#/components/schemas/PetDetail`, `../openapi.yaml#/components/schemas/Pedigree`）。 - `examples` には、各APIのテストケースIDをキーとして指定（`ResExample1`）し、`value` に該当するテストケースのデータファイルパスを指定（`./examples/res_example1.yaml`）する。ファイル名は、指定したキーをスネークケースに変換したものを使用するとよい。
API別ファイルの記載例： pets-pet-id_get.yaml ```yaml - summary: Details for a pet - operationId: get-pets-pet-id - tags: - - pets - parameters: - - name: petId - in: path - required: true - description: The id of the pet to retrieve - schema: - type: string - responses: - "200": - description: Expected response to a valid request - content: - application/json: - schema: - $ref: "../openapi.yaml#/components/schemas/ResPetsPetIdGet" - examples: - ResExample1: - value: - $ref: "./examples/res_example1.yaml" - "404": - description: not found error - content: - application/json: - schema: - $ref: "../openapi.yaml#/components/schemas/Error" - "500": - description: unexpected error - content: - application/json: - schema: - $ref: "../openapi.yaml#/components/schemas/Error" - ``` - -
- -- `schema` ファイルの例は以下の通り。 - - 複数API間に共通のモデルは `openapi.yaml` に指定したキーを指定する（`../openapi.yaml#/components/schemas/Pet`）。 - - ネストしているモデルは `openapi.yaml` に指定したキーを経由して参照できるようにする（`../openapi.yaml#/components/schemas/PetDetail`, `../openapi.yaml#/components/schemas/Pedigree`）。 - -
- schemaファイル記載例： pets-pet-id_get/response.yaml + operation: + summary: Details for a pet + operationId: get-pets-pet-id + tags: + - pets + parameters: + - name: petId + in: path + required: true + description: The id of the pet to retrieve + schema: + type: string + responses: + "200": + description: Expected response to a valid request + content: + application/json: + schema: + $ref: "../openapi.yaml#/components/schemas/ResPetsPetIdGet" + examples: + ResExample1: + value: + $ref: "./examples/res_example1.yaml" + "404": + description: not found error + content: + application/json: + schema: + $ref: "../openapi.yaml#/components/schemas/Error" + "500": + description: unexpected error + content: + application/json: + schema: + $ref: "../openapi.yaml#/components/schemas/Error" - ```yaml - ResPetsPetIdGet: - required: - - pet - - pet_detail - type: object - properties: - pet: - $ref: "../openapi.yaml#/components/schemas/Pet" - pet_detail: - $ref: "../openapi.yaml#/components/schemas/PetDetail" - - PetDetail: - type: object - properties: - breeder: - type: string - date_of_birth: - type: string - format: date - pedigree: - $ref: "../openapi.yaml#/components/schemas/Pedigree" - - Pedigree: - required: - - registration_no - - date_of_registration - - pedigree_image - type: object - properties: - registration_no: - type: integer - format: int64 - date_of_registration: - type: string - format: date - pedigree_image: - type: string + components: + schemas: + ResPetsPetIdGet: + required: + - pet + - pet_detail + type: object + properties: + pet: + $ref: "../openapi.yaml#/components/schemas/Pet" + pet_detail: + $ref: "../openapi.yaml#/components/schemas/PetDetail" + PetDetail: + type: object + properties: + breeder: + type: string + date_of_birth: + type: string + format: date + pedigree: + $ref: "../openapi.yaml#/components/schemas/Pedigree" + Pedigree: + required: + - registration_no + - date_of_registration + - pedigree_image + type: object + properties: + registration_no: + type: integer + format: int64 + date_of_registration: + type: string + format: date + pedigree_image: + type: string ```
+ - OpenAPIの使用用途により、分割ファイルを1つのファイルにまとめる必要がある場合には、例えば[swagger-cli](https://apitools.dev/swagger-cli/)を使用して以下コマンドを実行する。 ```bash @@ -1424,6 +1415,9 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 name: MIT servers: - url: 'http://petstore.swagger.io/v1' + tags: + - name: pets + description: Everything about your Pets paths: /pets: get: From 12bf92c68cfc1dacf9e239b9af0801f797b163d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fujita=20Haruka=28=E8=97=A4=E7=94=B0=20=E6=98=A5=E4=BD=B3?= =?UTF-8?q?=29?= Date: Thu, 28 Dec 2023 14:10:43 +0900 Subject: [PATCH 2/3] fix: update sample --- .../reference/divided_files_sample.zip | Bin 7267 -> 6702 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/documents/forOpenAPISpecification/reference/divided_files_sample.zip b/documents/forOpenAPISpecification/reference/divided_files_sample.zip index 6ffeea93ed2a3e5b245ee962a2c7374719c9725c..06ce0206e556f43e5eab4f3185d1443283b61088 100644 GIT binary patch delta 3513 zcmZuz2{_bU7yr*p#;&mrX6*aE%w#9qYbV4I6%w*!$rgi&ELpPs?OXPJ&62&8NOnR9 zsVqe#WKG}nzR&yZ=RWs7_qq3+^E=PEzvrC$QLYwSuL`C1@W`>Kh`?VsJ_i8npdpln za3x_<5)m?5SAWiQx!@p-(?iJGmQQu%t{R!SJI0Vo7wzWc9C5fE=Pj?CTv~!Y?^=UH z&12418=z8^~(`H8i&Gb z4Q?vNvH}xLzOrGy-4V@!Fs5L_l#dX{gSR zeMOJ*GS86Fs#djLHqR&|UUZ!$N0HI&zYdYH_^}lFM&O8~d?X%S?aWLX={9NXm_M_lNJaSzxsJV*{iJ+pSvfRLvGAh@@O6hbN)je({cq1QfEYOFyty;oh*^~$$Lja%fxl6|EPUazTM^9wW7eK zKU9KcXjff4%~5t(ZYuLz1W5>2>miaos1muw+?kNYeIu+#II<+{7tC{LCFJoQjgmpS zlYYHMVzdj5iUGlk_%QX={#a~@`kG!%*L)a=% zaw1J-ImvvRHjnZ_+8Hl7G-a=jL){rjOS8SW#K5=GmfYyao{z)On? zjm;nBJeCyb*Y;zhcWF<`X5#&k`e#^MOySGj9s@Ao?3u?$9H9}(Qx#OyK0azcr7fK1 zXL(z7h~k%n>GL2ddOp7!V@wR)hhbPI6W#UlQp>HAxHT7TooI*oo|fLCr$fQNb~&H? z93=m6MJrKA=;GH&0O>whnb3Nova!DT-42u5==W0#k7_*1jDBhHLVT-T4RdE~A#<56 z-H$b@qkBf-jF)gV;2=22;X>P|r4ZP7^w9jP+sX7ytku12WulEUe}w z5t&b8hXn;YTgUCMv_6Hi9ziFr|Av3~{^ka&>XyhcO@YDe|8) zQJfJ@xi(nQORzvJjo@S@T@&e-!ZHVK^MnrMY7dDHnZ)6EGl>V{Hdi>CmG>jdHt7#d zHv~7#lqA)!XyV@Mmx=cI%JgnFn6$5cA4Vq~tY);>;cn2Ad#PKM!FhSQ@uZ{^nf;q0 zd|Eu)4l|47?Gd1z9+P7Aj#Hq9W0PZtJ&q7G@wBS@Z0V-jlDhdvb?~BwW69_0@qAFl zMrLe4?F;>(XXICs7=bKi;~RxHVf)I5Cxh`)qJi<@6h_??{7yEap@fr5-+*x&gEfO_Yg#w@aX5E>F< z;=goR`0Nl9k0AvGDTE2bX2b6Dl2qNubw#qp+UQBH`JOcr4UeAsjsnZLqUUMY81bwp z9DMVScV(*=?xm8x_^@=4#O=VA&wJa@iy#obJ%{_yfUpTIcJF*^&0s2*Z)@0{P>HxO z7PhYv#AHRHI4~E56{VzgTVB#l5ktJcDP1iX_QIYlwvbwcm#vS0c|K~yBS~XNT7(O& zGw#r_IF-9MruVjs^X#Krm}oz(%UvVdZUt2l*mq7JpSZ8HgKw%=fbHrX$;X2#HMlEY zjGnt6^0|$L_yN5gQB)1L-8U>8H;rJ(BH>X=$ETObTM+wLgnNk=ogmllPICFAo=Y)X&& zF6A^*BN+8UqgYneX=CbG3-yqXy=p`d@_^~r<$f6mp7-QvHP;`0Y)#;B+ur84ACi%y z${g*>ms=_=*VzcTBWV8aFh6^`cPp>;hsm0x5>R|eYv2z;hAd;VGRvFj7dD?Z9@TKU zDj@4>U7`RA&xxzu==*}Y#&f}KlR8lszaf`(Z}Txq-MQX9aiOTY>rf@6JXq<>@tmc( zYbjE@1uMg1YUmwx)6hVF;Wg{^g*nU{5wXcms|)WPMhia=DzMbj{Ur4tv+%==OZ->EhYp&$75B=c2hvk$^CL{0UqZzS3@8uikK|#>5hEf` z2ya6rew@FB#R&4V-4na}VF0BHcO|oQ4)bR{U+j_`=^i%=Na|p>od~Q@La3W@_t!gr{-4r2xE?!h-1YFkBPX^-YI!fHscPd z{g!aEC3Z}9iqHzrK^44S>AJD1ZLof8A>-~-|D787r$75= zv~kKkc{(@(n_;0iK7f@TShU50{sFD4+*1u^C zDx=RS)Q8i;#EYeOnk%Bm*KsPLTp!;;G@26_GgT?e*vGoo9d+buQ(-I5h2R)13UGS~UYhS0P@9jGM!o_&Gubr{E2bM#0o{qUm z_be*&+Szu5KX?a8&1yUk>Bt9J_YZsX=FE-1N+q-SfdH0mNlX5Kz2@J||2NnfFE>lYkC&8hZN;pVRuT+t_P$x|QvwSOD1!-!QItY$<( zhQL>h9PpkRdRfgsFF;BrcIYt~NJEYSwU~^cQsl&~C^*kd1&%QBa{OnF2LN8;_)C7H zTmos47EPpSVeDJ_a*-p-jk{2;b=Y_5Jnly{`9t&pFpQ&voC=b3f1Xo+{~?Gu5hK##IYHOnm=M+zb=| zO7Qw%Bu@9%s3g2?9%BJ6^ZDF@>Jf8hv!FA&W(`+Qo76jYj+tiC@)GZ!;!G<+Ikouy zS(rzqIcMmVvuj;@R|NYU<6Zl&o?2oIalD}^>SY!4HtKegwk-1FIv~Vi0-E@=8?sdKgSs}dO=JDgR`AY{8 zlKuT%X|N@n9n-@y$QsSdF~tne?j_Ls30qVcm)fo_3lt5UXFBpw5aFfkP*exrqV zz;Qj%x2sZ?m_?LMrija@=D5W9X^zw?abSFb;k&{@8^(a=V=el=&W?JAm1 z2zgHS`gAsO-V2a1rUeIEPoXnHWlo*4?5A&@VO`lMa11QI>^XC>(k!`2eKGAaycySi z#jvz>w5-K#U7LiIxwqEua$S98-r@5d)*&qys*GnY0nj{Oe&yxx#wIS=H*bD4Su>}t zFqsP8EN#8QRCs>LM>C^s9pCeqU87Q;=Q+7{-gV@uO<~9qU!HO{!)c_R`{|@jS`!4d zo+_>Q9#ym*`KDs`l(s%ns@)0EY21$6|KQUy^L3z}=s5--1-r(ko!J37-{lPA&4y3advmSr`8t(~*sV2K&`2(EAA-Y8HK{0W z47@~~>;)&BpT9FacKM5)&D?RJ_I>I(_b1z>*~^4|0-X8?b}z?>L+ z?&>5~-)vl-Fp096f6y{Ewqv3%*DqGOX2%uPDw^p=*f;ht?koCK;*@=zKnmwzD>YAn4=fG<4vwplw%oV(QJTRcCSDuhW zJIAE`bTyJ=z}8g8O5X8pW}RfXyy26iHp2&8C9lXz*U0_j$uq6tWWAhM62*hsgePr& ztu5B8CET*2mz3=K(V0U$TUT9Wb{w42rb@lm=W7`O9bu>OC$N5` zbkVRCDtmNoD#=p6hOoon-vB9Ech0_SwOyFkAHKh4;I-CAw_vGx8!61QILamN+D9B} z+93p*KKfamxnSASI;`BSr%YcH>>hlhMcUOIHj-oczMy_o^6jiGc}wU+Z_w29W912{ zI5sjmUqQ6%wS0g($K@-yC4(B*<9*=#Q~$v33gy(2+cie#XG)aZBH2#86OBKc6UxI_ z@vdW58gkC_sj197Qp(n~)F8=jf9fgAxf0Kx6U4C#Lh5oOmK`icB_btjZgUDNU&WfO zl=OMeC*;4(J6ZXS^X}ZHN9PWekuC(v0ssIlz+mZzQP}1*=K=vZfDr-!43x*-KF(hD zK5pXI>^-lhrRaNiq8MVAe;`UHWs1za336sidWntigzhxa8H2}22BY=+%8(xuaU2a? z@QLd@YaEVhy5&$S&mURdn9LCx{!`t95e7)HiP(=GM}lV+;a_KMWEoMS?TX&;lcQxv z>LJF%Bef;O65OuG8~_oB@yB);RF8*>CU(G#mzZyenh@kN)7oyntU(QPd<%#tAOD~_ z^hs(*E8)vi6{o36hfJBJD3nw2C_16wBYrb{x8d#S5;4riSV-HgrixRKWjF#t+R86| zo}K=Lv}S+p^#UHn-y9vo>GT{Wnh{3zVFg-O-fV*mTU4!*Trc0SS<%kD8xRUem<5S? zGA9!*$J3VzY*#bKoP-@AVN$<@VwuU+>(Jay)KIOMk@0YFXPukJN%1c+JC&<}Gn zOWZ*d1OV0)hYA3AE>=NYm$8y}hbqH6{#g|ZHw>+5zzb{BngU{|^9kyz-te(`)YkWn z*@z=)RbA&;p49E;PT6o(Xe!HoQ;#aXRlUMM8(D-7LupC9uY5$^C~!>Eaa&Ih!x}X? zafj+Dl-ZUQgcPG&L1MFHzxccq&bKENpKKvWg)_!paG^hXrzY6}*C%+gEWK@+R*&X7 z63aK?|Lz}7*VBgu$SglhxkfQy<2{kfrrevz2qqWo4o?B$7Yvu zILU7jWVu9-jewkrP~3^K>)j-f=jSz@4AQD|_dMoI(Ftk=`zL8*^KK1Qd%ikzg%v5a zm-<=d#Qbg73mB>(4x2xRme9vsShs#Y&w(YcR=zj+Aotthw7>$Tf13`h|Fc37>=GCN zxGB4jbAZ1XWf608vU70`knnT%_wn}fcNV{fqewaDVxN1bB)pYo^{C)t!{+_*d=_8F#0grN#;Wk%$YjtiB=uDRennH;RD%8u<0_HWi zNeAf~9dlVrEb*b_P)njo<@h`&xjQX`a!eM14mi`|~!=kXn@n^=jqoQAIXx;cG%eLwQQc(G5M0 zjCOh~Put>DnICfU#9vGb%A4d+NVQ3)YO(N^16rEJQH3XXZJkQo7$4VYnUW-{V&fu% z``vVF?2oZjZVT;mq95Uyl5XEb9lz^zndam)cO<*+x9*QrFtZI=Q2j@HNj-OROn4Ex zdrps4h+f!U@0U$+pP^K>w zr_<6C=+c3;)k^Fe9M()<=NRMs?w@5f2sLr$Gwjh8T^l9icwea%R{PqFb3QO>Y2c3~ zWebKo|KK;!m)Uy}HV{B8m{`_T0>`y~)vn(yuU#?c7FJCEVTOKk@h7nmCm?JNwjsqT zFMpG&UsWc@6+Kv?--*1k_(r3dq+`?bU0z;5yUTNL<;%~RUWp}QOSar}>*o!IDk_S+ z^ZIaAT~mfQrMmX-IQbE^Az>r_^;+0I@H=j_K#GAMMxKoRW=v7H8D+BmtMdORZ;HCP zyQN?eCgh zc#_iW=}z!s3u28sHLj0aDCl~R=@q7Dv&-Z<_0jx>0RSI${qTE7w_!+%c#O7}5{^>D z(*(v-Gabiu8TA<)WEG}Yr2_n_n@%KyDtr%a1&2&eOPX?$No%OeYg{2d=^e7|rk-Gxi*}wsqa@_`5R>rP344*I zYQcQEA33p#B}FIIzou2Z@If+5lwPyVXx=!pi8GR8)E$pie643)&M8=d9T(7aSmSZf zKFgE(o%cQw18VhIWEm0a(wH1_%^1FQZARo{R9KKpIZQW5NkSKMkEJ}Ua{aCXvYD@c z-Xu}`hHv;Q>;|6_icZ2t`EguHDNDuMj<*dh<$8{gB-tzwDU^JA#-r@X_;%rhifPMG zE-sKRc&ZTt(TZk^z=dCC~b3Gh9A8-GI;^Z6X>>u!}%OZLY zf(O?ae*a7n-hc=(_<(>vk7u&TXqevYkjCeo?cSm4wtsGK21U}8LCaUKcRu7Bgr-M~ z#PBZM!%cRasm!XEWfag>!?5MO-r^D#5)dxlq8~=osTK3oIWs4N{`}oZWs#y1PW0LD z#M>iyR1Td1{yhQ+P{1Ax6lH4D{COZa^6M!8fB<$NaQY(WGl~sv&0h@=bMVdY0jG4n z{|-21yGi?Zbv|rqy26&e>A({H7y<=up~dGTIPpdZ1Mup>r8UprUG=wh6va9m&&hh4 z3d?0D{OEv@(cit{@Y@;me`EQ-PC-ef!@%<8_%;vR#LWu;lp6X6MY=yIcH&c5*`X4= zHNto%w&VCdRupIfZ^VYcgV+qf9E|vjZ2sW=gN+A2%O;EZvko6*_F;_bFg!Pmo#`-= z+5rK`FM1dLE((V~g;M-|&@NbZURJ9jhasHRv q-#K&m^?v4mx&4(vhjB$)h9@3yL$FX$QwUI8%L=Sg1ZZ{a;O;+VrMln% From e25289543413bf5d57b50576174931e88a9afe22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fujita=20Haruka=28=E8=97=A4=E7=94=B0=20=E6=98=A5=E4=BD=B3?= =?UTF-8?q?=29?= Date: Thu, 28 Dec 2023 19:27:25 +0900 Subject: [PATCH 3/3] fix: reflect comments --- .../OpenAPI_Specification_3.0.3.md | 10 ++++------ .../reference/divided_files_sample.zip | Bin 6702 -> 6716 bytes 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md b/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md index 1682d569..de965978 100644 --- a/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md +++ b/documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md @@ -1310,9 +1310,7 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 - `openapi.yaml` の `paths` に記載したAPIファイルは以下のように作成する。 -- `schema` にて `openapi.yaml` に指定したキー（`../openapi.yaml#/components/schemas/ResPetsPetIdGet`）を参照する。 -- 複数API間に共通のモデルについても `openapi.yaml` に指定したキー（`../openapi.yaml#/components/schemas/Pet`）を参照する。 -- ネストしているモデルについても `openapi.yaml` に指定したキーを経由して参照する（`../openapi.yaml#/components/schemas/PetDetail`, `../openapi.yaml#/components/schemas/Pedigree`）。 +- 複数API間に共通のモデルについては `openapi.yaml` に指定したキー（`../openapi.yaml#/components/schemas/Pet`）を参照する。 - `examples` には、各APIのテストケースIDをキーとして指定（`ResExample1`）し、`value` に該当するテストケースのデータファイルパスを指定（`./examples/res_example1.yaml`）する。ファイル名は、指定したキーをスネークケースに変換したものを使用するとよい。
@@ -1337,7 +1335,7 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 content: application/json: schema: - $ref: "../openapi.yaml#/components/schemas/ResPetsPetIdGet" + $ref: "#/components/schemas/ResPetsPetIdGet" examples: ResExample1: value: @@ -1366,7 +1364,7 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 pet: $ref: "../openapi.yaml#/components/schemas/Pet" pet_detail: - $ref: "../openapi.yaml#/components/schemas/PetDetail" + $ref: "#/components/schemas/PetDetail" PetDetail: type: object properties: @@ -1376,7 +1374,7 @@ OpenAPI ドキュメントは単一のファイルで構成することも複数 type: string format: date pedigree: - $ref: "../openapi.yaml#/components/schemas/Pedigree" + $ref: "#/components/schemas/Pedigree" Pedigree: required: - registration_no diff --git a/documents/forOpenAPISpecification/reference/divided_files_sample.zip b/documents/forOpenAPISpecification/reference/divided_files_sample.zip index 06ce0206e556f43e5eab4f3185d1443283b61088..439036138aa93945ecb996145c87b8b8362f16ba 100644 GIT binary patch delta 1513 zcmY*ZX*`sB6n@{C#*8&H%tB_2ktMP;6lE;81z~L0R%BnUEvmt`BUkRljHHYd*)ZSD8v69@n@NC4OfKpHq*h%INRYR;3njO4u?{fAA7AaXXw(fWhdKwUCIC^D#Pn{b4cBMiA#CE}B!}X@ zNf&UE7;NBDLd51WJ_2PzF6ca^et^F`VbUZ@xt2cZVndmeXP;;{9Hx>=7mtdj7e!;H-p<||l2Le6)Cc}F2Sg|JOdHoCe!;z^yg36^U zO=`|GhkOs1veD`poKep9-V(N}gOjgSz3ia&P_Ko_L$en_i)&ApB_Y(dxHG)Wl{kfq zi%aPj?_Je9@5#rmZ-_RT`*1c^Gf9cp2HB|T;6ql+%H}&bt{Rr3UrGv8KCbW2)Xl&2 zsB=&&6_#h7b0C37cEV&O2YoQ_8z-((Xt~@Xiha*}?}o?$tBQH}xzK0A1mi!v>mqFq z={tu(TG%Zqj)L9X0dCd!hrogxfivvMiE_~7PgQ!5pd<16bkJ|df`+$)}C2h?WZ7RbDp$y%gQw>?4GFs*N>x<6+NCzv5n%CzBoF8vl6rTtKgML z8GaGG2H{3K3U3cq1P$q8S0T8KzG&m&*gaoFOYb0NoT6$pSVv!u^c2sPVUaHI6_|W} zA9PSV>X#Hj?7QNxJfC0>*`8dxhmA4A=HAB>HWY>v;7h4*gbK+yQTJL4YTR}?9r9D# zkqGw8*hie?M~e%{0^_ecSphD^ys0Z|!_45@U72S2*Z2MYYXsw<*XzSGOTEf`oz>27 zg8u5Wv-H>djFQu+1J7FAS*2on!3E&rI#QV-h6f#;q4LyH`-QD45>3>?l45x z103e#mW6zyg7AKgBo`B2{MYLrTXLK*DMR;AS;e+CyG|{{Hm7Um^iQ4qI?`UQH>lDv zYf>v&j|3GZQd-esX2l*UtrZXgZOkg~W#O9Bwn}DA=dpVMSA6yCMNnT6KMv$M~I$J{F!zUWH?q9KIIU?2jh#L1# z&Iv9Vl$a%ka@nc)cv_O#Smgyb2|pYu`$+v!QJBRn{hRZ#nABTt2pA1EoOirs<*icVGyG&_MqEe=dcbTHU;8ZY z+jZfA@OFJd%N!;BgmI_khEOYn9(?5KiL(6OlF+$qRQckNzf(J-4&C0%bO}h{P(BL* zT3FjT(c9LQ_wrH9WfMuDr$n(f0+Rts)eTxwp&?qycg9knCj{a;6u``dd{r$G%$n^{ z-&2~90EMaLt6G4HKS>`Xi`#>U(yCWu{3tq%BZ27<8@C^I?g+Wmj9wHlsUi*%Rh1AuRWR76I&-oXg C3#qUG delta 1456 zcmZ8hc{tPw7@psZG1knu!eB6wW3Uq%F@z=+<35|Ql%qn9*0@%dW)R7$(2tONlUR2X zxjp5WNV(4%m5gIuja@{l9nU`dNBjNrz0dc4&-?xHKJVA6SFKk|hC+jbS!Pf*I5azm z6@XZWqTxY#v_IQu;XD8WA%ecbRLM$CY$l>}_U(4MvX4TM%4ORSraCw%ECr;3^TJBN z1yBg7$+Q!1HzI4nHV%e|-&~z~F<2L#lPy z<&Jl)6*O)+F6bCTO6<*hPiGrQ)tktUCU<(yEf-cP1sY*$ssoZB!t~*@?ef>~mJZWS zSDQvCNyk58-dkQ)mC_CMXdga$zrF2~DWmMF@mF5~*E4~o7>foyeOV{lu%wH&HrAXz zISaa4;i(&~2fozKAUOD~LMt0lf5A_r-|5Qnr`$*5!iy%Ly5Ya<&!YUSJE1>!^w zGE+x%#M%z=aOQC^`RNj$rnw$(xK;>x574tJEm!*L8V!Bf;g>fZ;aE;>neMc+iy|`C zql_CO=F&5dt}fFc-otWV-aMm8$=?pK5?^UOnT*qBZi!yfBjVK*VhLAfd$DA}Kp|KE_((a?TK{|7 z$z}m->Rd~kH99Ke{otzQ1wAm{&!URtCHEZTx|mTAjx|I!vpf!Ib8!vO6f63;K;P?% z23zO)Z=4=={~oeQ(KhKChpR}aQ(tigo#d(4Mb5@rH#_Ed)?r)KZ`30@#F!Xoe;&8z z8z;uAraz6CpXreu<`e$23nz4Ob3m+HRdJ57>_1^v?=f-Yh+w|kKpER0!mqyZK%xU~ zB60UvV({?Ifvzz_gn~nh?q)-R%UeZaZiWUA%TBgie2`-lHa=W}Tk>O(Dyqwa3N3u1 ztDQJ{2DJGu*Sm(fHllNF#+#|6y9>s5UYF&+WV9NMf~bP~x0iexZ+Tj3$CRstWLc(= zn_z5r4TtuE>1l~vS7aBXUFQ?1o1rI!w$8Cv96%F!0i)UkaoFLKBfR?Z2na#4gFqii68z5C zY@`K$gagNgBv>Po2EhLw8AkdvJgSR6WX@kQ0ph_zX*Xy&3Ve^21Vu4+(5Zch0~r_> zXgit@RlyyM4(_|~!66W7hzjK2I>>JTNRd&6|7u^>urG=O;bIc#|9CMz&jV{^+yPlI uL{=J9mbC+{_=tx4&U_dIBJ-W*8n_^<4tJfKpW4@y0`YPpf<6-aH~#?=_J8OA