OpenAPI obj

OpenAPI-Specification 3.0.2

Comienza Ya. Es Gratis
ó regístrate con tu dirección de correo electrónico
OpenAPI obj por Mind Map: OpenAPI obj

1. openapi (string)

2. info (Info obj)

3. servers [Server obj]

4. paths (Paths obj)

5. components (Components obj)

6. security [Security Requirement obj]

7. tags [Tag obj]

8. externalDocs (External Documentation obj)

9. Operation obj

9.1. tags [ string ]

9.2. summary (string)

9.3. description (string)

9.4. externalDocs (External Documentation obj)

9.5. operationId (string)

9.6. parameters [{Parameter | Reference} obj]

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

9.8. responses (Responses obj)

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

9.10. deprecated (boolean)

9.11. security [ Security Requirement obj ]

9.12. servers [ Server obj ]

10. Parameter obj

10.1. name (string)

10.2. in (string)

10.3. description (string)

10.4. required (boolean)

10.5. deprecated (boolean)

10.6. allowEmptyValue (boolean)

10.7. style (string)

10.8. explode (boolean)

10.9. allowReserved (boolean)

10.10. schema ({Schema | Reference} obj)

10.11. example (Any)

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

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

11. Request Body obj

11.1. description (string)

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

11.3. required (boolean)

12. Media Type obj

12.1. schema ({ Schema | Reference } obj)

12.2. example (Any)

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

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

13. Encoding obj

13.1. contentType (string)

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

13.3. style (string)

13.4. explode (boolean)

13.5. allowReserved (boolean)

14. Response obj

14.1. description (string)

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

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

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

15. Responses obj

15.1. default ({ Response | Reference } obj)

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

16. Callback obj

16.1. {expression} (Path Item obj)

17. Example obj

17.1. summary (string)

17.2. description (string)

17.3. value (Any)

17.4. externalValue (string)

18. Link obj

18.1. operationRef (string)

18.2. operationId (string)

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

18.4. requestBody (Any | {expression})

18.5. description (string)

18.6. server (Server obj)

19. Header obj

20. Tag obj

20.1. name (string)

20.2. description (string)

20.3. externalDocs (External Documentation obj)

21. Reference obj

21.1. $ref (string)

22. Schema obj

22.1. type (string)

22.2. allOf ({ Schema | Reference obj })

22.3. oneOf ({ Schema | Reference obj })

22.4. anyOf ({ Schema | Reference obj })

22.5. not ({ Schema | Reference obj })

22.6. items ({ Schema | Reference obj })

22.7. properties ({ Schema | Reference obj })

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

22.9. description (string)

22.10. format (string)

22.11. default (type)

22.12. nullable (boolean)

22.13. discriminator (Discriminator obj)

22.14. readOnly (boolean)

22.15. writeOnly (boolean)

22.16. xml (XML obj)

22.17. externalDocs (External Documentation obj)

22.18. example (Any)

22.19. deprecated (boolean)

23. Discriminator obj

23.1. propertyName (string)

23.2. mapping (Map[ string, string ])

24. XML obj

24.1. name (string)

24.2. namespace (string)

24.3. prefix (string)

24.4. attribute (boolean)

24.5. wrapped (boolean)

25. Security Scheme obj

25.1. type (string)

25.2. description (string)

25.3. name (string)

25.4. in (string)

25.5. scheme (string)

25.6. bearerFormat (string)

25.7. flows (OAuth Flows obj)

25.8. openIdConnectUrl (string)

26. OAuth Flows obj

26.1. implicit (OAuth Flow obj)

26.2. password (OAuth Flow obj)

26.3. clientCredentials (OAuth Flow obj)

26.4. authorizationCode (OAuth Flow obj)

27. OAuth Flow obj

27.1. authorizationUrl (string)

27.2. tokenUrl (string)

27.3. refreshUrl (string)

27.4. scopes (Map[ string, string ])

28. Security Requirement obj

28.1. {name} [ string ]

29. Info obj

29.1. title (string)

29.2. description (string)

29.3. termsOfService (string)

29.4. contact (Contact obj)

29.5. license (License obj)

29.6. version (string)

30. Server obj

30.1. url (string)

30.2. description (string)

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

30.3.1. enum (string)

30.3.2. default (string)

30.3.3. description (string)

31. Paths obj

31.1. /{path} (Path Item obj)

31.1.1. $ref (string)

31.1.2. summary (string)

31.1.3. description (string)

31.1.4. get (Operation obj)

31.1.5. put (Operation obj)

31.1.6. post (Operation obj)

31.1.7. delete (Operation obj)

31.1.8. options (Operation obj)

31.1.9. head (Operation obj)

31.1.10. patch (Operation obj)

31.1.11. trace (Operation obj)

31.1.12. servers [Server obj]

31.1.13. parameters [{Parameter | Reference} obj]

32. External Documentation obj

32.1. description (string)

32.2. url (string)

33. Components obj

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

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

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

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

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

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

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

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

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

34. Response obj

34.1. description (string)

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

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

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

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)