definition-apiv1.js 963 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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: 'The base URL for the GROWI API except for the version path (/_api). This can be set to your GROWI instance URL.',
  15. },
  16. },
  17. },
  18. {
  19. url: 'https://demo.growi.org/_api',
  20. },
  21. ],
  22. security: [
  23. {
  24. bearer: [],
  25. accessTokenInQuery: [],
  26. },
  27. ],
  28. components: {
  29. securitySchemes: {
  30. bearer: {
  31. type: 'http',
  32. scheme: 'bearer',
  33. description: 'Access token generated by each GROWI users',
  34. },
  35. accessTokenInQuery: {
  36. type: 'apiKey',
  37. name: 'access_token',
  38. in: 'query',
  39. description: 'Access token generated by each GROWI users',
  40. },
  41. },
  42. },
  43. };