definition-apiv1.js 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. const pkg = require('../../package.json');
  2. module.exports = {
  3. openapi: '3.0.1',
  4. info: {
  5. title: 'GROWI REST API v1',
  6. version: pkg.version,
  7. },
  8. servers: [
  9. {
  10. url: '{server}/_api',
  11. variables: {
  12. server: {
  13. default: 'https://demo.growi.org',
  14. description:
  15. 'The base URL for the GROWI API except for the version path (/_api). This can be set to your GROWI instance URL.',
  16. },
  17. },
  18. },
  19. {
  20. url: 'https://demo.growi.org/_api',
  21. },
  22. ],
  23. security: [
  24. {
  25. bearer: [],
  26. accessTokenHeaderAuth: [],
  27. accessTokenInQuery: [],
  28. },
  29. ],
  30. components: {
  31. securitySchemes: {
  32. bearer: {
  33. type: 'http',
  34. scheme: 'bearer',
  35. description: 'Access token generated by each GROWI users',
  36. },
  37. accessTokenHeaderAuth: {
  38. type: 'apiKey',
  39. in: 'header',
  40. name: 'x-growi-access-token',
  41. description: 'Access token generated by each GROWI users',
  42. },
  43. accessTokenInQuery: {
  44. type: 'apiKey',
  45. name: 'access_token',
  46. in: 'query',
  47. description: 'Access token generated by each GROWI users',
  48. },
  49. },
  50. },
  51. };