fix: edited responses in organization docs (#397)

Author: BrRenat

src/actions/organization/create.js

@@ -62,7 +62,8 @@ async function createOrganization(organizationName, active, lock) {
  * @apiParam (Payload) {String} members.lastName - member last name.
  * @apiParam (Payload) {String[]} members.permissions - member permission list.
  *
- * @apiSuccess (Response) {String} meta.invites - organization invites list.
+ * @apiSuccess (Response) {Object} data - response data.
+ * @apiSuccess (Response) {Object} meta - response meta.
  * @apiSuccess (Response) {String} data.id - organization id.
  * @apiSuccess (Response) {String} data.type - response type.
  * @apiSuccess (Response) {String} data.attributes.id - organization id.
@@ -76,6 +77,7 @@ async function createOrganization(organizationName, active, lock) {
  * @apiSuccess (Response) {Date} data.attributes.members.accepted - member accept invite date.
  * @apiSuccess (Response) {String[]} data.attributes.members.permissions - member permission list.
  * @apiSuccess (Response) {Object} data.attributes.metadata - organization metadata
+ * @apiSuccess (Response) {String} meta.invites - organization invites list.
  */
 async function createOrganizationAction({ params, locals }) {
   const service = this;

src/actions/organization/get.js

@@ -9,6 +9,7 @@ const { getOrganizationMetadataAndMembers, checkOrganizationExists } = require('
  *
  * @apiParam (Payload) {String} organizationId - organization id.
  *
+ * @apiSuccess (Response) {Object} data - response data.
  * @apiSuccess (Response) {String} data.id - organization id.
  * @apiSuccess (Response) {String} data.type - response type.
  * @apiSuccess (Response) {String} data.attributes.id - organization id.

src/actions/organization/getMetadata.js

@@ -9,6 +9,7 @@ const { getOrganizationMetadata, checkOrganizationExists } = require('../../util
  *
  * @apiParam (Payload) {String} organizationId - organization id.
  *
+ * @apiSuccess (Response) {Object} data - response data.
  * @apiSuccess (Response) {Object} data.id - organization id
  * @apiSuccess (Response) {String} data.type - response type.
  * @apiSuccess (Response) {Object} data.attributes.metadata - organization metadata

src/actions/organization/list.js

@@ -19,6 +19,19 @@ const { ORGANIZATIONS_INDEX, ORGANIZATIONS_DATA } = require('../../constants.js'
  * @apiParam (Payload) {String="ASC","DESC"} [order=ASC] - sort order
  * @apiParam (Payload) {String} [criteria] - if supplied, sort will be performed based on this field
  * @apiParam (Payload) {Object} [filter] to use, consult https://github.com/makeomatic/redis-filtered-sort, can already be stringified
+
+ * @apiSuccess (Response) {Object[]} data - response data.
+ * @apiSuccess (Response) {String} data.id - organization id.
+ * @apiSuccess (Response) {String} data.type - response type.
+ * @apiSuccess (Response) {String} data.attributes.id - organization id.
+ * @apiSuccess (Response) {String} data.attributes.name - organization name.
+ * @apiSuccess (Response) {Boolean} data.attributes.active - organization state.
+ * @apiSuccess (Response) {Object} data.attributes.metadata - organization metadata
+ * @apiSuccess (Response) {Object} meta - response meta.
+ * @apiSuccess (Response) {Number} meta.cursor - cursor.
+ * @apiSuccess (Response) {Number} meta.page - page.
+ * @apiSuccess (Response) {Number} meta.pages - pages.
+ * @apiSuccess (Response) {Number} meta.total - total.
  */
 async function getOrganizationsList({ params }) {
   const { redis } = this;

src/actions/organization/members/list.js

@@ -12,13 +12,19 @@ const { getOrganizationMembers } = require('../../../utils/organization');
  *
  * @apiParam (Payload) {String} organizationId - organization id.
  *
- * @apiSuccess (Response) {Object[]} members - organization members.
- * @apiSuccess (Response) {String} members.username - member email.
- * @apiSuccess (Response) {String} members.firstName - member first name.
- * @apiSuccess (Response) {String} members.lastName - member last name.
- * @apiSuccess (Response) {Date} members.invited - member invite date.
- * @apiSuccess (Response) {Date} members.accepted - member accept invite date.
- * @apiSuccess (Response) {String[]} members.permissions - member permission list.
+ * @apiSuccess (Response) {Object} data - response data.
+ * @apiSuccess (Response) {Object} data.id - organization id.
+ * @apiSuccess (Response) {Object} data.type - response type.
+ * @apiSuccess (Response) {Object[]} data.attributes - organization members.
+ * @apiSuccess (Response) {String} data.attributes.id - organization member id.
+ * @apiSuccess (Response) {String} data.attributes.type - entity type.
+ * @apiSuccess (Response) {Object[]} data.attributes.attributes - organization member.
+ * @apiSuccess (Response) {String} data.attributes.attributes.username - member email.
+ * @apiSuccess (Response) {String} data.attributes.attributes.firstName - member first name.
+ * @apiSuccess (Response) {String} data.attributes.attributes.lastName - member last name.
+ * @apiSuccess (Response) {Date} data.attributes.attributes.invited - member invite date.
+ * @apiSuccess (Response) {Date} data.attributes.attributes.accepted - member accept invite date.
+ * @apiSuccess (Response) {String[]} data.attributes.attributes.permissions - member permission list.
  */
 async function organizationMembersList({ params }) {
   const { organizationId } = params;

src/actions/organization/state.js

@@ -13,6 +13,11 @@ const redisKey = require('../../utils/key');
  *
  * @apiParam (Payload) {String} organizationId - organization id.
  * @apiParam (Payload) {Boolean} active=false - organization state.
+ *
+ * @apiSuccess (Response) {Object} data - response data.
+ * @apiSuccess (Response) {String} data.id - organization id.
+ * @apiSuccess (Response) {String} data.type - response type.
+ * @apiSuccess (Response) {Boolean} data.attributes.active - organization state.
  */
 async function updateOrganizationState({ params }) {
   const { redis } = this;

src/actions/organization/updateMetadata.js

@@ -14,7 +14,10 @@ const { checkOrganizationExists, getOrganizationMetadata } = require('../../util
  * @apiParam (Payload) {Object} metadata - metadata operations,
  *   supports `$set key:value`, `$remove keys[]`, `$incr key:diff`
  *
- * @apiSuccess (Response) {Object} metadata - organization metadata
+ * @apiSuccess (Response) {Object} data - response data.
+ * @apiSuccess (Response) {Object} data.id - organization id
+ * @apiSuccess (Response) {String} data.type - response type.
+ * @apiSuccess (Response) {Object} data.attributes - organization metadata
  */
 async function updateOrganizationMetadata({ params }) {
   const { config } = this;