OpenAPI obj

OpenAPI obj by 정 원혁

1. servers [Server obj]

2. paths (Paths obj)

3. components (Components obj)

4. Operation obj

4.1. tags [ string ]

4.2. summary (string)

4.3. description (string)

4.4. externalDocs (External Documentation obj)

4.5. operationId (string)

4.6. parameters [{Parameter | Reference} obj]

4.7. requestBody ({Request Body | Reference} obj)

4.8. responses (Responses obj)

4.9. callbacks (Map[ string, {Callback | Reference} obj ])

4.10. deprecated (boolean)

4.11. security [ Security Requirement obj ]

4.12. servers [ Server obj ]

5. Parameter obj

5.1. name (string)

5.2. in (string)

5.3. description (string)

5.4. required (boolean)

5.5. deprecated (boolean)

5.6. allowEmptyValue (boolean)

5.7. style (string)

5.8. explode (boolean)

5.9. allowReserved (boolean)

5.10. schema ({Schema | Reference} obj)

5.11. example (Any)

5.12. examples (Map[ string, {Example | Reference} obj ] )

5.13. content (Map[ string, Media Type obj ])

6. Request Body obj

6.1. description (string)

6.2. content (Map[ string, Media Type obj ])

6.3. required (boolean)

7. Media Type obj

7.1. schema ({ Schema | Reference } obj)

7.2. example (Any)

7.3. examples (Map[ string, {Example | Reference} obj ] )

7.4. encoding (Map[ string, Encoding obj ])

8. Encoding obj

8.1. contentType (string)

8.2. headers (Map[ string, { Header | Reference } obj ])

8.3. style (string)

8.4. explode (boolean)

8.5. allowReserved (boolean)

9. Response obj

9.1. description (string)

9.2. headers (Map[ string, { Header | Reference } obj])

9.3. content (Map[ string, Media Type Object ])

9.4. links (Map[ string, { Link | Reference } obj ])

10. Responses obj

10.1. default ({ Response | Reference } obj)

10.2. HTTP Status Code ({ Response | Reference } obj)

11. Callback obj

11.1. {expression} (Path Item obj)

12. Example obj

12.1. summary (string)

12.2. description (string)

12.3. value (Any)

12.4. externalValue (string)

13. Header obj

14. Reference obj

14.1. $ref (string)

15. Schema obj

15.1. type (string)

15.2. allOf ({ Schema | Reference obj })

15.3. oneOf ({ Schema | Reference obj })

15.4. anyOf ({ Schema | Reference obj })

15.5. not ({ Schema | Reference obj })

15.6. items ({ Schema | Reference obj })

15.7. properties ({ Schema | Reference obj })

15.8. additionalProperties (boolean | { Schema | Reference obj })

15.9. description (string)

15.10. format (string)

15.11. default (type)

15.12. nullable (boolean)

15.13. discriminator (Discriminator obj)

15.14. readOnly (boolean)

15.15. writeOnly (boolean)

15.16. xml (XML obj)

15.17. externalDocs (External Documentation obj)

15.18. example (Any)

15.19. deprecated (boolean)

16. Discriminator obj

16.1. propertyName (string)

16.2. mapping (Map[ string, string ])

17. XML obj

17.1. name (string)

17.2. namespace (string)

17.3. prefix (string)

17.4. attribute (boolean)

17.5. wrapped (boolean)

18. Server obj

18.1. url (string)

18.2. description (string)

18.3. variables (Map[string, Server Variable obj])

18.3.1. enum (string)

18.3.2. default (string)

18.3.3. description (string)

19. Paths obj

19.1. /{path} (Path Item obj)

19.1.1. $ref (string)

19.1.2. summary (string)

19.1.3. description (string)

19.1.4. get (Operation obj)

19.1.5. put (Operation obj)

19.1.6. post (Operation obj)

19.1.7. delete (Operation obj)

19.1.8. options (Operation obj)

19.1.9. head (Operation obj)

19.1.10. patch (Operation obj)

19.1.11. trace (Operation obj)

19.1.12. servers [Server obj]

19.1.13. parameters [{Parameter | Reference} obj]

20. Components obj

20.1. schemas (Map[string, Schema obj | Reference obj])

20.2. responses (Map[string, Response obj | Reference obj])

20.3. parameters (Map[string, Parameter obj | Reference obj])

20.4. examples (Map[string, Example obj | Reference obj])

20.5. requestBodies (Map[string, Request Body obj | Reference obj])

20.6. headers (Map[string, Header obj | Reference obj])

20.7. securitySchemes (Map[string, Security Scheme obj | Reference obj])

20.8. links (Map[string, Link obj | Reference obj])

20.9. callbacks (Map[string, Callback obj | Reference obj])

21. Response obj

21.1. description (string)

21.2. headers (Map[ string, { Header | Reference } obj ])

21.3. content (Map[ string, Media Type obj ])

21.4. links (Map[ string, { Link | Reference } obj ])

22. openapi (string)

23. info (Info obj)

24. security [Security Requirement obj]

25. tags [Tag obj]

26. externalDocs (External Documentation obj)

27. Link obj

27.1. operationRef (string)

27.2. operationId (string)

27.3. parameters (Map[ string, { Any | {expression} } ])

27.4. requestBody (Any | {expression})

27.5. description (string)

27.6. server (Server obj)

28. Tag obj

28.1. name (string)

28.2. description (string)

28.3. externalDocs (External Documentation obj)

29. Security Scheme obj

29.1. type (string)

29.2. description (string)

29.3. name (string)

29.4. in (string)

29.5. scheme (string)

29.6. bearerFormat (string)

29.7. flows (OAuth Flows obj)

29.8. openIdConnectUrl (string)

30. OAuth Flows obj

30.1. implicit (OAuth Flow obj)

30.2. password (OAuth Flow obj)

30.3. clientCredentials (OAuth Flow obj)

30.4. authorizationCode (OAuth Flow obj)

31. OAuth Flow obj

31.1. authorizationUrl (string)

31.2. tokenUrl (string)

31.3. refreshUrl (string)

31.4. scopes (Map[ string, string ])

32. Security Requirement obj

32.1. {name} [ string ]

33. Info obj

33.1. title (string)

33.2. description (string)

33.3. termsOfService (string)

33.4. contact (Contact obj)

33.5. license (License obj)

33.6. version (string)

34. External Documentation obj

34.1. description (string)

34.2. url (string)

35. Contact obj

35.1. name (string)

35.2. url (string)

35.3. email (string)

36. License obj

36.1. name (string)

36.2. url (string)