Merge pull request #396 from inaturalist/395-id-param-missing-in-some…

…-v2-project-endpoints

Fix issues in projects endpoints (missing ID param, support array of IDs or slug, ...)

lib/controllers/v1/projects_controller.js

@@ -221,7 +221,7 @@ const ProjectsController = class ProjectsController {
 
   static async show( req ) {
     InaturalistAPI.setPerPage( req, { max: 100 } );
-    const ids = _.filter( req.params.id.split( "," ), _.identity );
+    const ids = _.filter( req.params.id.toString( ).split( "," ), _.identity );
     if ( ids.length > req.query.per_page ) {
       throw util.httpError( 422, "Too many IDs" );
     }
@@ -290,7 +290,7 @@ const ProjectsController = class ProjectsController {
         null,
         "prup.owner_id = pu.id AND prup.owner_type = 'ProjectUser' AND prup.name = 'updates'"
       )
-      .where( "p.id IN (?)", ids )
+      .where( "p.id IN ?", ids )
       .where( "pu.user_id = ?", req.userSession.user_id );
     const { rows } = await pgClient.query( query.toString( ) );
     _.each( rows, row => {
@@ -344,13 +344,13 @@ const ProjectsController = class ProjectsController {
 
   static async posts( req ) {
     const { page, perPage } = InaturalistAPI.paginationData( req, { default: 10, max: 30 } );
-    const ids = _.filter( req.params.id.split( "," ), _.identity );
+    const ids = _.filter( req.params.id.toString( ).split( "," ), _.identity );
     let numericIDs = _.filter( ids, id => Number( id ) );
     if ( _.isEmpty( numericIDs ) ) { numericIDs = [-1]; }
     const query = squel.select( ).field( "posts.*, count(*) OVER() AS total_count" )
       .from( "posts" )
       .join( "projects", null, "posts.parent_id = projects.id AND parent_type='Project'" )
-      .where( "projects.id IN (?) OR projects.slug IN (?)", numericIDs, ids )
+      .where( "projects.id IN ? OR projects.slug IN ?", numericIDs, ids )
       .where( "posts.published_at IS NOT NULL" )
       .order( "posts.published_at", false )
       .limit( perPage )

lib/views/swagger_v1.yml.ejs

@@ -1562,10 +1562,10 @@ paths:
     get:
       summary: Membership of current user
       description: |
-        Given a project ID, return the details of the authenticated user's
-        membership in that project
+        Given an ID, or an array of IDs in comma-delimited format, return the details of the
+        authenticated user's membership in these projects
       parameters:
-        - $ref: "#/parameters/path_id"
+        - $ref: "#/parameters/path_multi_id"
       tags:
         - Projects
       security:

openapi/paths/v2/projects.js

@@ -1,7 +1,7 @@
 const _ = require( "lodash" );
 const projectsSearchSchema = require( "../../schema/request/projects_search" );
 const transform = require( "../../joi_to_openapi_parameter" );
-const ProjectsController = require( "../../../lib/controllers/v2/projects_controller" );
+const ProjectsController = require( "../../../lib/controllers/v1/projects_controller" );
 
 module.exports = sendWrapper => {
   async function GET( req, res ) {

openapi/paths/v2/projects/{id}.js

@@ -1,6 +1,6 @@
 const Joi = require( "joi" );
 const transform = require( "../../../joi_to_openapi_parameter" );
-const projectsController = require( "../../../../lib/controllers/v2/projects_controller" );
+const projectsController = require( "../../../../lib/controllers/v1/projects_controller" );
 
 module.exports = sendWrapper => {
   async function GET( req, res ) {

openapi/paths/v2/projects/{id}/members.js

@@ -1,18 +1,27 @@
 const _ = require( "lodash" );
 const Joi = require( "joi" );
 const transform = require( "../../../../joi_to_openapi_parameter" );
-const ProjectsController = require( "../../../../../lib/controllers/v2/projects_controller" );
-const observationsSearchSchema = require( "../../../../schema/request/projects_members" );
+const ProjectsController = require( "../../../../../lib/controllers/v1/projects_controller" );
+const projectsMembersSchema = require( "../../../../schema/request/projects_members" );
 
 module.exports = sendWrapper => {
   async function GET( req, res ) {
     const results = await ProjectsController.members( req );
     sendWrapper( req, res, null, results );
   }
 
-  const parameters = _.map(
-    observationsSearchSchema.$_terms.keys,
-    child => transform( child.schema.label( child.key ) )
+  const parameters = [
+    transform(
+      Joi.number( ).integer( )
+        .label( "id" )
+        .meta( { in: "path" } )
+        .required( )
+        .description( "A single ID" )
+    )
+  ].concat(
+    _.map( projectsMembersSchema.$_terms.keys, child => (
+      transform( child.schema.label( child.key ) )
+    ) )
   );
   parameters.push(
     transform( Joi.string( ).label( "X-HTTP-Method-Override" ).meta( { in: "header" } ) )

openapi/paths/v2/projects/{id}/membership.js

@@ -1,6 +1,6 @@
 const Joi = require( "joi" );
 const transform = require( "../../../../joi_to_openapi_parameter" );
-const projectsController = require( "../../../../../lib/controllers/v2/projects_controller" );
+const projectsController = require( "../../../../../lib/controllers/v1/projects_controller" );
 
 module.exports = sendWrapper => {
   async function GET( req, res ) {
@@ -16,11 +16,12 @@ module.exports = sendWrapper => {
     }],
     parameters: [
       transform(
-        Joi.number( ).integer( )
+        Joi.array( )
+          .items( Joi.number( ).integer( ) )
           .label( "id" )
           .meta( { in: "path" } )
           .required( )
-          .description( "A single project ID" )
+          .description( "A single ID or a comma-separated list of them" )
       ),
       transform( Joi.string( ).label( "fields" ).meta( { in: "query" } ) ),
       transform( Joi.string( ).label( "X-HTTP-Method-Override" ).meta( { in: "header" } ) )

openapi/paths/v2/projects/{id}/posts.js

@@ -1,7 +1,7 @@
 const _ = require( "lodash" );
 const Joi = require( "joi" );
 const transform = require( "../../../../joi_to_openapi_parameter" );
-const ProjectsController = require( "../../../../../lib/controllers/v2/projects_controller" );
+const ProjectsController = require( "../../../../../lib/controllers/v1/projects_controller" );
 const projectsPostsSchema = require( "../../../../schema/request/projects_posts" );
 
 module.exports = sendWrapper => {
@@ -10,9 +10,19 @@ module.exports = sendWrapper => {
     sendWrapper( req, res, null, results );
   }
 
-  const parameters = _.map(
-    projectsPostsSchema.$_terms.keys,
-    child => transform( child.schema.label( child.key ) )
+  const parameters = [
+    transform(
+      Joi.array( )
+        .items( Joi.number( ).integer( ) )
+        .label( "id" )
+        .meta( { in: "path" } )
+        .required( )
+        .description( "A single ID or a comma-separated list of them" )
+    )
+  ].concat(
+    _.map( projectsPostsSchema.$_terms.keys, child => (
+      transform( child.schema.label( child.key ) )
+    ) )
   );
   parameters.push(
     transform( Joi.string( ).label( "X-HTTP-Method-Override" ).meta( { in: "header" } ) )

openapi/schema/request/projects_members.js

@@ -4,8 +4,8 @@ module.exports = Joi.object( ).keys( {
   page: Joi.number( ).integer( ),
   per_page: Joi.number( ).integer( ),
   fields: Joi.any( ),
-  order_by: Joi.array( ).items( Joi.string( ).valid(
+  order_by: Joi.string( ).valid(
     "observations_count",
     "login"
-  ) ).default( "observations_count" )
+  ).default( "observations_count" )
 } ).unknown( false );