Fix #1015, resolve discrepancies between idmap API and unit tests

Ensures correlation between the test cases and documented return
values for the OSAL idmap API.

src/os/inc/osapi-idmap.h

@@ -154,10 +154,11 @@ static inline bool OS_ObjectIdDefined(osal_id_t object_id)
  * @param[out] buffer Buffer in which to store the name
  * @param[in]  buffer_size Size of the output storage buffer
  *
- * @returns #OS_SUCCESS if successful
- *          #OS_ERR_INVALID_ID if the passed-in ID is not a valid OSAL ID
- *          #OS_INVALID_POINTER if the passed-in buffer is invalid
- *          #OS_ERR_NAME_TOO_LONG if the name will not fit in the buffer provided
+ * @returns Execution status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS  @copybrief OS_SUCCESS
+ * @retval #OS_ERR_INVALID_ID if the passed-in ID is not a valid OSAL ID
+ * @retval #OS_INVALID_POINTER if the passed-in buffer is invalid
+ * @retval #OS_ERR_NAME_TOO_LONG if the name will not fit in the buffer provided
  */
 int32 OS_GetResourceName(osal_id_t object_id, char *buffer, size_t buffer_size);
 
@@ -194,9 +195,10 @@ osal_objtype_t OS_IdentifyObject(osal_id_t object_id);
  * @param[in]  object_id    The object ID to operate on
  * @param[out] *ArrayIndex  The Index to return
  *
- * @return Execution status, see @ref OSReturnCodes
- * @retval #OS_SUCCESS                 @copybrief OS_SUCCESS
- * @retval #OS_ERR_INCORRECT_OBJ_TYPE  @copybrief OS_ERR_INCORRECT_OBJ_TYPE
+ * @returns Execution status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
+ * @retval #OS_ERR_INVALID_ID if the object_id argument is not valid
+ * @retval #OS_INVALID_POINTER if the ArrayIndex is NULL
  */
 int32 OS_ConvertToArrayIndex(osal_id_t object_id, osal_index_t *ArrayIndex);
 
@@ -225,9 +227,8 @@ int32 OS_ConvertToArrayIndex(osal_id_t object_id, osal_index_t *ArrayIndex);
  * @param[in]  object_id    The object ID to operate on
  * @param[out] *ArrayIndex  The Index to return
  *
- * @return Execution status, see @ref OSReturnCodes
- * @retval #OS_SUCCESS                 @copybrief OS_SUCCESS
- * @retval #OS_ERR_INCORRECT_OBJ_TYPE  @copybrief OS_ERR_INCORRECT_OBJ_TYPE
+ * @returns Execution status, see @ref OSReturnCodes
+ * @retval #OS_SUCCESS @copybrief OS_SUCCESS
  * @retval #OS_ERR_INVALID_ID if the object_id argument is not valid
  * @retval #OS_INVALID_POINTER if the ArrayIndex is NULL
  * */

src/os/shared/src/osapi-idmap.c

@@ -331,7 +331,7 @@ int32 OS_ObjectIdTransactionInit(OS_lock_mode_t lock_mode, osal_objtype_t idtype
      */
     if (OS_GetMaxForObjectType(idtype) == 0)
     {
-        return OS_ERR_INCORRECT_OBJ_TYPE;
+        return OS_ERR_INVALID_ID;
     }
 
     token->lock_mode = lock_mode;