/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License") +  you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.openmeetings.webservice.schema;

import java.util.List;

import org.apache.openmeetings.db.dto.user.UserDTO;

import io.swagger.v3.oas.annotations.media.Schema;

/**
 *
 * @author Sebastian.wagner
 *
 * Provide the correct schema response including the wrapping root element + add example response.
 *
 * See https://issues.apache.org/jira/browse/OPENMEETINGS-2667
 *
 */
@Schema(example = """
		{
		  "userDTO": [
		    {
		      "address": {
		        "created": 1630191589000,
		        "deleted": false,
		        "country": "NZ",
		        "mail": "seba.wagner@gmail.com"
		      },
		      "firstname": "firstname",
		      "id": 1,
		      "languageId": 1,
		      "lastname": "lastname",
		      "login": "admin",
		      "rights": [
		        "ROOM",
		        "SOAP",
		        "DASHBOARD",
		        "ADMIN",
		        "LOGIN"
		      ],
		      "timeZoneId": "Europe/Berlin",
		      "type": "USER"
		    },
		    {
		      "address": {
		        "created": 1631324533000,
		        "deleted": false,
		        "country": "NZ",
		        "mail": "john.doe@gmail.com"
		      },
		      "externalId": "uniqueId1",
		      "externalType": "myCMS",
		      "firstname": "John",
		      "id": 2,
		      "languageId": 1,
		      "lastname": "Doe",
		      "login": "john.doe",
		      "pictureUri": "",
		      "rights": "ROOM",
		      "timeZoneId": "Europe/Berlin",
		      "type": "EXTERNAL"
		    },
		    {
		      "address": {
		        "created": 1631958373000,
		        "deleted": false,
		        "country": "NZ",
		        "mail": "test@test.com"
		      },
		      "id": 3,
		      "languageId": 1,
		      "login": "soapuser",
		      "rights": [
		        "ROOM",
		        "SOAP",
		        "DASHBOARD",
		        "ADMIN",
		        "LOGIN"
		      ],
		      "timeZoneId": "Europe/Berlin",
		      "type": "USER"
		    }
		  ]
		}""")
public class UserDTOListWrapper {
	private List<UserDTO> userDTO;

	public List<UserDTO> getUserDTO() {
		return userDTO;
	}

	public void setUserDTO(List<UserDTO> userDTO) {
		this.userDTO = userDTO;
	}
}
