GoToSocial/internal/api/model/error.go

/*
   GoToSocial
   Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package model

// Error represents an error message returned from the API. See https://docs.joinmastodon.org/entities/error/
type Error struct {
	// REQUIRED

	// The error message.
	Error string `json:"error"`

	// OPTIONAL

	// A longer description of the error, mainly provided with the OAuth API.
	ErrorDescription string `json:"error_description"`
}