Documentation
¶
Index ¶
- Constants
- Variables
- func NewCreateProjectEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewDefaultProjectEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewDeleteEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewListEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewListProjectMembersEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewProjectAccountEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewReadEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewRemoveMembershipEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewSetDefaultProjectEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewSetProjectAccountEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewUpdateMembershipEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
- func NewViewedProjectListRT(res *ProjectListRT, view string) *projectviews.ProjectListRT
- func NewViewedProjectStatusRT(res *ProjectStatusRT, view string) *projectviews.ProjectStatusRT
- type AccountResult
- type Auther
- type BadRequestT
- type CreateProjectPayload
- type DefaultProjectPayload
- type DeletePayload
- type Endpoints
- type InvalidParameterT
- type InvalidScopesT
- type ListPayload
- type ListProjectMembersPayload
- type MembersList
- type NotImplementedT
- type ProjectAccountPayload
- type ProjectCreateRequest
- type ProjectListItem
- type ProjectListItemCollection
- type ProjectListRT
- type ProjectProperties
- type ProjectStatusRT
- type ReadPayload
- type RemoveMembershipPayload
- type ResourceNotFoundT
- type Service
- type ServiceNotAvailableT
- type SetDefaultProjectPayload
- type SetProjectAccountPayload
- type UnauthorizedT
- type UpdateMembershipPayload
- type UserListItem
Constants ¶
const APIName = "ivcap"
APIName is the name of the API as defined in the design.
const APIVersion = "0.44"
APIVersion is the version of the API as defined in the design.
const ServiceName = "project"
ServiceName is the name of the service as defined in the design. This is the same value that is set in the endpoint request contexts under the ServiceKey key.
Variables ¶
var MethodNames = [11]string{"list", "CreateProject", "delete", "read", "ListProjectMembers", "UpdateMembership", "RemoveMembership", "DefaultProject", "SetDefaultProject", "ProjectAccount", "SetProjectAccount"}
MethodNames lists the service method names as defined in the design. These are the same values that are set in the endpoint request contexts under the MethodKey key.
Functions ¶
func NewCreateProjectEndpoint ¶
func NewCreateProjectEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewCreateProjectEndpoint returns an endpoint function that calls the method "CreateProject" of service "project".
func NewDefaultProjectEndpoint ¶
func NewDefaultProjectEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewDefaultProjectEndpoint returns an endpoint function that calls the method "DefaultProject" of service "project".
func NewDeleteEndpoint ¶
func NewDeleteEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewDeleteEndpoint returns an endpoint function that calls the method "delete" of service "project".
func NewListEndpoint ¶
func NewListEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewListEndpoint returns an endpoint function that calls the method "list" of service "project".
func NewListProjectMembersEndpoint ¶
func NewListProjectMembersEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewListProjectMembersEndpoint returns an endpoint function that calls the method "ListProjectMembers" of service "project".
func NewProjectAccountEndpoint ¶
func NewProjectAccountEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewProjectAccountEndpoint returns an endpoint function that calls the method "ProjectAccount" of service "project".
func NewReadEndpoint ¶
func NewReadEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewReadEndpoint returns an endpoint function that calls the method "read" of service "project".
func NewRemoveMembershipEndpoint ¶
func NewRemoveMembershipEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewRemoveMembershipEndpoint returns an endpoint function that calls the method "RemoveMembership" of service "project".
func NewSetDefaultProjectEndpoint ¶
func NewSetDefaultProjectEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewSetDefaultProjectEndpoint returns an endpoint function that calls the method "SetDefaultProject" of service "project".
func NewSetProjectAccountEndpoint ¶
func NewSetProjectAccountEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewSetProjectAccountEndpoint returns an endpoint function that calls the method "SetProjectAccount" of service "project".
func NewUpdateMembershipEndpoint ¶
func NewUpdateMembershipEndpoint(s Service, authJWTFn security.AuthJWTFunc) goa.Endpoint
NewUpdateMembershipEndpoint returns an endpoint function that calls the method "UpdateMembership" of service "project".
func NewViewedProjectListRT ¶
func NewViewedProjectListRT(res *ProjectListRT, view string) *projectviews.ProjectListRT
NewViewedProjectListRT initializes viewed result type ProjectListRT from result type ProjectListRT using the given view.
func NewViewedProjectStatusRT ¶
func NewViewedProjectStatusRT(res *ProjectStatusRT, view string) *projectviews.ProjectStatusRT
NewViewedProjectStatusRT initializes viewed result type ProjectStatusRT from result type ProjectStatusRT using the given view.
Types ¶
type AccountResult ¶
type AccountResult struct { // Account URN AccountUrn string }
AccountResult is the result type of the project service ProjectAccount method.
type Auther ¶
type Auther interface { // JWTAuth implements the authorization logic for the JWT security scheme. JWTAuth(ctx context.Context, token string, schema *security.JWTScheme) (context.Context, error) }
Auther defines the authorization functions to be implemented by the service.
type BadRequestT ¶
type BadRequestT struct { // Information message Message string }
Something wasn't right with this request
func (*BadRequestT) Error ¶
func (e *BadRequestT) Error() string
Error returns an error description.
func (*BadRequestT) ErrorName
deprecated
func (e *BadRequestT) ErrorName() string
ErrorName returns "BadRequestT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*BadRequestT) GoaErrorName ¶
func (e *BadRequestT) GoaErrorName() string
GoaErrorName returns "BadRequestT".
type CreateProjectPayload ¶
type CreateProjectPayload struct { // New project description Project *ProjectCreateRequest // JWT used for authentication JWT string }
CreateProjectPayload is the payload type of the project service CreateProject method.
type DefaultProjectPayload ¶
type DefaultProjectPayload struct { // JWT used for authentication JWT string }
DefaultProjectPayload is the payload type of the project service DefaultProject method.
type DeletePayload ¶
type DeletePayload struct { // ID of project to update ID string // JWT used for authentication JWT string }
DeletePayload is the payload type of the project service delete method.
type Endpoints ¶
type Endpoints struct { List goa.Endpoint CreateProject goa.Endpoint Delete goa.Endpoint Read goa.Endpoint ListProjectMembers goa.Endpoint UpdateMembership goa.Endpoint RemoveMembership goa.Endpoint DefaultProject goa.Endpoint SetDefaultProject goa.Endpoint ProjectAccount goa.Endpoint SetProjectAccount goa.Endpoint }
Endpoints wraps the "project" service endpoints.
func NewEndpoints ¶
NewEndpoints wraps the methods of the "project" service with endpoints.
type InvalidParameterT ¶
type InvalidParameterT struct { // message describing expected type or pattern. Message string // name of parameter. Name string // provided parameter value. Value *string }
InvalidParameterT is the error returned when a parameter has the wrong value.
func (*InvalidParameterT) Error ¶
func (e *InvalidParameterT) Error() string
Error returns an error description.
func (*InvalidParameterT) ErrorName
deprecated
func (e *InvalidParameterT) ErrorName() string
ErrorName returns "InvalidParameterT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*InvalidParameterT) GoaErrorName ¶
func (e *InvalidParameterT) GoaErrorName() string
GoaErrorName returns "InvalidParameterT".
type InvalidScopesT ¶
type InvalidScopesT struct { // ID of involved resource ID *string // Message of error Message string }
Caller not authorized to access required scope.
func (*InvalidScopesT) Error ¶
func (e *InvalidScopesT) Error() string
Error returns an error description.
func (*InvalidScopesT) ErrorName
deprecated
func (e *InvalidScopesT) ErrorName() string
ErrorName returns "InvalidScopesT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*InvalidScopesT) GoaErrorName ¶
func (e *InvalidScopesT) GoaErrorName() string
GoaErrorName returns "InvalidScopesT".
type ListPayload ¶
type ListPayload struct { // The 'limit' query option sets the maximum number of items // to be included in the result. Limit int // The 'filter' system query option allows clients to filter a collection of // resources that are addressed by a request URL. The expression specified with // 'filter' // is evaluated for each resource in the collection, and only items where the // expression // evaluates to true are included in the response. Filter *string // The 'orderby' query option allows clients to request resources in either // ascending order using asc or descending order using desc. If asc or desc not // specified, // then the resources will be ordered in ascending order. The request below // orders Trips on // property EndsAt in descending order. OrderBy *string // When set order result in descending order. Ascending order is the lt. OrderDesc bool // Return the state of the respective resources at that time [now] AtTime *string // The content of 'page' is returned in the 'links' part of a previous query and // will when set, ALL other parameters, except for 'limit' are ignored. Page *string // JWT used for authentication JWT string }
ListPayload is the payload type of the project service list method.
type ListProjectMembersPayload ¶
type ListProjectMembersPayload struct { // Project URN Urn string // Role Role *string // The 'limit' query option sets the maximum number of items // to be included in the result. Limit int // A pagination token to retrieve the next set of results. Empty if there are // no more results Page *string // JWT used for authentication JWT string }
ListProjectMembersPayload is the payload type of the project service ListProjectMembers method.
type MembersList ¶
type MembersList struct { // Members Members []*UserListItem // A pagination token to retrieve the next set of results. Empty if there are // no more results Page *string // Time at which this list was valid AtTime *string }
MembersList is the result type of the project service ListProjectMembers method.
type NotImplementedT ¶
type NotImplementedT struct { // Information message Message string }
Method is not yet implemented.
func (*NotImplementedT) Error ¶
func (e *NotImplementedT) Error() string
Error returns an error description.
func (*NotImplementedT) ErrorName
deprecated
func (e *NotImplementedT) ErrorName() string
ErrorName returns "NotImplementedT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*NotImplementedT) GoaErrorName ¶
func (e *NotImplementedT) GoaErrorName() string
GoaErrorName returns "NotImplementedT".
type ProjectAccountPayload ¶
type ProjectAccountPayload struct { // Project URN ProjectUrn string // JWT used for authentication JWT string }
ProjectAccountPayload is the payload type of the project service ProjectAccount method.
type ProjectCreateRequest ¶
type ProjectCreateRequest struct { // Project name Name string // URN of the billing account AccountUrn *string // URN of the parent project ParentProjectUrn *string // Additional Metadata Properties *ProjectProperties }
type ProjectListItem ¶
type ProjectListItemCollection ¶
type ProjectListItemCollection []*ProjectListItem
type ProjectListRT ¶
type ProjectListRT struct { // Projects Projects ProjectListItemCollection // Time at which this list was valid AtTime *string // A pagination token to retrieve the next set of results. Empty if there are // no more results Page *string }
ProjectListRT is the result type of the project service list method.
func NewProjectListRT ¶
func NewProjectListRT(vres *projectviews.ProjectListRT) *ProjectListRT
NewProjectListRT initializes result type ProjectListRT from viewed result type ProjectListRT.
type ProjectProperties ¶
type ProjectProperties struct { // String metadata for detailing the use of this project Details *string }
type ProjectStatusRT ¶
type ProjectStatusRT struct { // Project status Status *string // DateTime project was created CreatedAt *string // DateTime project last modified ModifiedAt *string // Account URN Account *string // Parent Project URN Parent *string // Additional Metadata Properties *ProjectProperties // Project URN Urn string // Project name Name *string }
ProjectStatusRT is the result type of the project service CreateProject method.
func NewProjectStatusRT ¶
func NewProjectStatusRT(vres *projectviews.ProjectStatusRT) *ProjectStatusRT
NewProjectStatusRT initializes result type ProjectStatusRT from viewed result type ProjectStatusRT.
type ReadPayload ¶
type ReadPayload struct { // ID of project to show ID string // JWT used for authentication JWT string }
ReadPayload is the payload type of the project service read method.
type RemoveMembershipPayload ¶
type RemoveMembershipPayload struct { // Project URN ProjectUrn string // User URN UserUrn string // JWT used for authentication JWT string }
RemoveMembershipPayload is the payload type of the project service RemoveMembership method.
type ResourceNotFoundT ¶
type ResourceNotFoundT struct { // ID of missing resource ID string // Message of error Message string }
NotFound is the type returned when attempting to manage a resource that does not exist.
func (*ResourceNotFoundT) Error ¶
func (e *ResourceNotFoundT) Error() string
Error returns an error description.
func (*ResourceNotFoundT) ErrorName
deprecated
func (e *ResourceNotFoundT) ErrorName() string
ErrorName returns "ResourceNotFoundT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*ResourceNotFoundT) GoaErrorName ¶
func (e *ResourceNotFoundT) GoaErrorName() string
GoaErrorName returns "ResourceNotFoundT".
type Service ¶
type Service interface { // list project // The "view" return value must have one of the following views // - "default" // - "tiny" List(context.Context, *ListPayload) (res *ProjectListRT, view string, err error) // Create a new project and return its status. // The "view" return value must have one of the following views // - "default" // - "tiny" CreateProject(context.Context, *CreateProjectPayload) (res *ProjectStatusRT, view string, err error) // Delete an existing project. Delete(context.Context, *DeletePayload) (err error) // Show project by ID // The "view" return value must have one of the following views // - "default" // - "tiny" Read(context.Context, *ReadPayload) (res *ProjectStatusRT, view string, err error) // Lists the current members of a project. ListProjectMembers(context.Context, *ListProjectMembersPayload) (res *MembersList, err error) // Adds or Updates the roles of a user in a project. UpdateMembership(context.Context, *UpdateMembershipPayload) (err error) // Remove a user from a project. RemoveMembership(context.Context, *RemoveMembershipPayload) (err error) // Retrieves the user's current default project // The "view" return value must have one of the following views // - "default" // - "tiny" DefaultProject(context.Context, *DefaultProjectPayload) (res *ProjectStatusRT, view string, err error) // Sets the default project of a user. SetDefaultProject(context.Context, *SetDefaultProjectPayload) (err error) // Retrieves the project's billing account urn ProjectAccount(context.Context, *ProjectAccountPayload) (res *AccountResult, err error) // Sets the billing account of a project SetProjectAccount(context.Context, *SetProjectAccountPayload) (err error) }
Create, Join, Manage Projects
type ServiceNotAvailableT ¶
type ServiceNotAvailableT struct { }
Service necessary to fulfil the request is currently not available.
func (*ServiceNotAvailableT) Error ¶
func (e *ServiceNotAvailableT) Error() string
Error returns an error description.
func (*ServiceNotAvailableT) ErrorName
deprecated
func (e *ServiceNotAvailableT) ErrorName() string
ErrorName returns "ServiceNotAvailableT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*ServiceNotAvailableT) GoaErrorName ¶
func (e *ServiceNotAvailableT) GoaErrorName() string
GoaErrorName returns "ServiceNotAvailableT".
type SetDefaultProjectPayload ¶
type SetDefaultProjectPayload struct { // Project URN ProjectUrn string // User URN UserUrn *string // JWT used for authentication JWT string }
SetDefaultProjectPayload is the payload type of the project service SetDefaultProject method.
type SetProjectAccountPayload ¶
type SetProjectAccountPayload struct { // Project URN ProjectUrn string // Account URN AccountUrn string // JWT used for authentication JWT string }
SetProjectAccountPayload is the payload type of the project service SetProjectAccount method.
type UnauthorizedT ¶
type UnauthorizedT struct { }
Unauthorized access to resource
func (*UnauthorizedT) Error ¶
func (e *UnauthorizedT) Error() string
Error returns an error description.
func (*UnauthorizedT) ErrorName
deprecated
func (e *UnauthorizedT) ErrorName() string
ErrorName returns "UnauthorizedT".
Deprecated: Use GoaErrorName - https://github.com/goadesign/goa/issues/3105
func (*UnauthorizedT) GoaErrorName ¶
func (e *UnauthorizedT) GoaErrorName() string
GoaErrorName returns "UnauthorizedT".
type UpdateMembershipPayload ¶
type UpdateMembershipPayload struct { // Project URN ProjectUrn string // User URN UserUrn string // Role Role string // JWT used for authentication JWT string }
UpdateMembershipPayload is the payload type of the project service UpdateMembership method.