Documentation
¶
Index ¶
- Constants
- type AccessTokenResponse
- type Action
- type ActionApprovePermissions
- type ActionExecutePermissions
- type ActionPermissions
- type ActionProperty
- type ActionTitle
- type ActionUserInputs
- type AggregationPropertyPathFilter
- type ApprovalNotification
- type Blueprint
- type BlueprintAggregationProperty
- type BlueprintCalculationProperty
- type BlueprintMirrorProperty
- type BlueprintPermissions
- type BlueprintPermissionsBlock
- type BlueprintPermissionsEntities
- type BlueprintProperty
- type BlueprintRolesOrPropertiesPermissionsBlock
- type BlueprintSchema
- type ChangelogDestination
- type Dataset
- type DatasetRule
- type DatasetValue
- type EntitiesSortModel
- type Entity
- type EntityProperty
- type Folder
- type Integration
- type InvocationMethod
- type Level
- type MappingSchema
- type Mappings
- type Meta
- type Migration
- type Option
- type Organization
- type Ownership
- type Page
- type PagePermissions
- type PageReadPermissions
- type PortBlueprintPermissionsBody
- type PortBody
- type PortBodyDelete
- type PortBodyForIntegration
- type PortClient
- func (c *PortClient) Authenticate(ctx context.Context, clientID, clientSecret string) (string, error)
- func (c *PortClient) CreateAction(ctx context.Context, action *Action) (*Action, error)
- func (c *PortClient) CreateBlueprint(ctx context.Context, b *Blueprint, createCatalogPage *bool) (*Blueprint, error)
- func (c *PortClient) CreateEntity(ctx context.Context, e *Entity, runID string, ...) (*Entity, error)
- func (c *PortClient) CreateFolder(ctx context.Context, folder *Folder) (*Folder, error)
- func (c *PortClient) CreateIntegration(ctx context.Context, integration *Integration) (*Integration, error)
- func (c *PortClient) CreatePage(ctx context.Context, page *Page) (*Page, error)
- func (c *PortClient) CreatePermissions(ctx context.Context, clientID string, scopes ...string) error
- func (c *PortClient) CreateScorecard(ctx context.Context, blueprintID string, scorecard *Scorecard) (*Scorecard, error)
- func (c *PortClient) CreateTeam(ctx context.Context, team *PortTeam) (*Team, error)
- func (c *PortClient) CreateWebhook(ctx context.Context, webhook *Webhook) (*Webhook, error)
- func (c *PortClient) DeleteAction(ctx context.Context, actionID string) error
- func (c *PortClient) DeleteBlueprint(ctx context.Context, id string) error
- func (c *PortClient) DeleteBlueprintWithAllEntities(ctx context.Context, id string) (*string, error)
- func (c *PortClient) DeleteEntity(ctx context.Context, id string, blueprint string) error
- func (c *PortClient) DeleteFolder(ctx context.Context, folderId string) (int, error)
- func (c *PortClient) DeleteIntegration(ctx context.Context, id string) (int, error)
- func (c *PortClient) DeletePage(ctx context.Context, pageId string) (int, error)
- func (c *PortClient) DeleteScorecard(ctx context.Context, blueprintID string, scorecardID string) error
- func (c *PortClient) DeleteTeam(ctx context.Context, teamName string) error
- func (c *PortClient) DeleteWebhook(ctx context.Context, webhookID string) error
- func (c *PortClient) FeatureFlags(ctx context.Context) ([]string, error)
- func (c *PortClient) GetActionPermissions(ctx context.Context, actionID string) (*ActionPermissions, int, error)
- func (c *PortClient) GetBlueprintPermissions(ctx context.Context, blueprintID string) (*BlueprintPermissions, int, error)
- func (c *PortClient) GetFolder(ctx context.Context, id string) (*Folder, int, error)
- func (c *PortClient) GetIntegration(ctx context.Context, id string) (*Integration, error)
- func (c *PortClient) GetMigration(ctx context.Context, id string) (*Migration, error)
- func (c *PortClient) GetPage(ctx context.Context, pageId string) (*Page, int, error)
- func (c *PortClient) GetPagePermissions(ctx context.Context, pageID string) (*PagePermissions, int, error)
- func (c *PortClient) HasFeatureFlags(ctx context.Context, flags ...string) (bool, error)
- func (c *PortClient) ReadAction(ctx context.Context, id string) (*Action, int, error)
- func (c *PortClient) ReadBlueprint(ctx context.Context, id string) (*Blueprint, int, error)
- func (c *PortClient) ReadEntity(ctx context.Context, id string, blueprint string) (*Entity, int, error)
- func (c *PortClient) ReadOrganization(ctx context.Context) (*Organization, int, error)
- func (c *PortClient) ReadScorecard(ctx context.Context, blueprintID string, scorecardID string) (*Scorecard, int, error)
- func (c *PortClient) ReadSystemBlueprintStructure(ctx context.Context, id string) (*Blueprint, int, error)
- func (c *PortClient) ReadTeam(ctx context.Context, teamName string) (*Team, int, error)
- func (c *PortClient) ReadWebhook(ctx context.Context, webhookID string) (*Webhook, int, error)
- func (c *PortClient) Search(ctx context.Context, searchRequest *SearchRequestQuery) (*SearchResult, error)
- func (c *PortClient) UpdateAction(ctx context.Context, actionID string, action *Action) (*Action, error)
- func (c *PortClient) UpdateActionPermissions(ctx context.Context, actionID string, permissions *ActionPermissions) (*ActionPermissions, error)
- func (c *PortClient) UpdateBlueprint(ctx context.Context, b *Blueprint, id string) (*Blueprint, error)
- func (c *PortClient) UpdateBlueprintPermissions(ctx context.Context, blueprintID string, permissions *BlueprintPermissions) (*BlueprintPermissions, error)
- func (c *PortClient) UpdateEntity(ctx context.Context, id string, blueprint string, e *Entity, runID string, ...) (*Entity, error)
- func (c *PortClient) UpdateFolder(ctx context.Context, folder *Folder) (*Folder, error)
- func (c *PortClient) UpdateIntegration(ctx context.Context, id string, integration *Integration) (*Integration, error)
- func (c *PortClient) UpdatePage(ctx context.Context, pageId string, page *Page) (*Page, error)
- func (c *PortClient) UpdatePagePermissions(ctx context.Context, pageID string, permissions *PagePermissions) (*PagePermissions, error)
- func (c *PortClient) UpdateScorecard(ctx context.Context, blueprintID string, scorecardId string, ...) (*Scorecard, error)
- func (c *PortClient) UpdateTeam(ctx context.Context, teamName string, team *PortTeam) (*Team, error)
- func (c *PortClient) UpdateWebhook(ctx context.Context, webhookID string, webhook *Webhook) (*Webhook, error)
- type PortPagePermissionsBody
- type PortProviderModel
- type PortTeam
- type PortTeamBody
- type Query
- type Relation
- type Rule
- type Scorecard
- type ScorecardModel
- type ScorecardRulesModel
- type SearchEntityResult
- type SearchRequestQuery
- type SearchResult
- type Security
- type SidebarDTO
- type SidebarFolderItem
- type SidebarGetResponseDTO
- type SidebarItemDTO
- type SidebarLocation
- type SpecAuthentication
- type Step
- type Team
- type TeamInheritance
- type TeamPortBody
- type TeamUserBody
- type Trigger
- type TriggerCondition
- type TriggerEvent
- type Webhook
Constants ¶
View Source
const FeatureFlagUsersAndTeamsV2 = "USERS_AND_TEAMS_OWNERSHIP_V2"
View Source
const MissingTeamEntityError = utils.StringErr("team entity is missing")
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessTokenResponse ¶
type Action ¶
type Action struct {
ID string `json:"id,omitempty"`
Identifier string `json:"identifier"`
Title *string `json:"title,omitempty"`
Icon *string `json:"icon,omitempty"`
Description *string `json:"description,omitempty"`
Trigger *Trigger `json:"trigger"`
InvocationMethod *InvocationMethod `json:"invocationMethod,omitempty"`
RequiredApproval any `json:"requiredApproval,omitempty"`
ApprovalNotification *ApprovalNotification `json:"approvalNotification,omitempty"`
Publish *bool `json:"publish,omitempty"`
}
type ActionPermissions ¶
type ActionPermissions struct {
Execute ActionExecutePermissions `json:"execute"`
Approve ActionApprovePermissions `json:"approve"`
}
type ActionProperty ¶
type ActionProperty struct {
Type string `json:"type,omitempty"`
Title *string `json:"title,omitempty"`
Identifier string `json:"identifier,omitempty"`
Items map[string]any `json:"items,omitempty"`
Default any `json:"default,omitempty"`
Icon *string `json:"icon,omitempty"`
Format *string `json:"format,omitempty"`
MaxLength *int `json:"maxLength,omitempty"`
MinLength *int `json:"minLength,omitempty"`
MaxItems *int `json:"maxItems,omitempty"`
MinItems *int `json:"minItems,omitempty"`
Maximum *float64 `json:"maximum,omitempty"`
Minimum *float64 `json:"minimum,omitempty"`
Description *string `json:"description,omitempty"`
Blueprint *string `json:"blueprint,omitempty"`
Pattern any `json:"pattern,omitempty"`
Enum any `json:"enum,omitempty"`
Spec *string `json:"spec,omitempty"`
SpecAuthentication *SpecAuthentication `json:"specAuthentication,omitempty"`
EnumColors map[string]string `json:"enumColors,omitempty"`
DependsOn []string `json:"dependsOn,omitempty"`
Dataset *Dataset `json:"dataset,omitempty"`
Encryption *string `json:"encryption,omitempty"`
Visible any `json:"visible,omitempty"`
Disabled any `json:"disabled,omitempty"`
Sort *EntitiesSortModel `json:"sort,omitempty"`
}
type ActionTitle ¶ added in v2.9.0
type ActionUserInputs ¶
type ActionUserInputs = struct {
Properties map[string]ActionProperty `json:"properties"`
Required any `json:"required,omitempty"`
Order []string `json:"order,omitempty"`
Steps []Step `json:"steps,omitempty"`
Titles map[string]ActionTitle `json:"titles,omitempty"`
}
type AggregationPropertyPathFilter ¶ added in v2.12.0
type ApprovalNotification ¶
type Blueprint ¶
type Blueprint struct {
Meta
Identifier string `json:"identifier,omitempty"`
Title string `json:"title,omitempty"`
Icon *string `json:"icon,omitempty"`
Description *string `json:"description,omitempty"`
Schema BlueprintSchema `json:"schema"`
MirrorProperties map[string]BlueprintMirrorProperty `json:"mirrorProperties"`
CalculationProperties map[string]BlueprintCalculationProperty `json:"calculationProperties"`
AggregationProperties map[string]BlueprintAggregationProperty `json:"aggregationProperties,omitempty"`
ChangelogDestination *ChangelogDestination `json:"changelogDestination,omitempty"`
TeamInheritance *TeamInheritance `json:"teamInheritance,omitempty"`
Relations map[string]Relation `json:"relations"`
Ownership *Ownership `json:"ownership,omitempty"`
}
type BlueprintAggregationProperty ¶
type BlueprintAggregationProperty struct {
Title *string `json:"title,omitempty"`
Description *string `json:"description,omitempty"`
Icon *string `json:"icon,omitempty"`
Target string `json:"target,omitempty"`
CalculationSpec map[string]string `json:"calculationSpec,omitempty"`
Query any `json:"query,omitempty"`
PathFilter []AggregationPropertyPathFilter `json:"pathFilter,omitempty"`
}
type BlueprintCalculationProperty ¶
type BlueprintCalculationProperty struct {
Type string `json:"type,omitempty"`
Title *string `json:"title,omitempty"`
Identifier string `json:"identifier,omitempty"`
Calculation string `json:"calculation,omitempty"`
Default any `json:"default,omitempty"`
Icon *string `json:"icon,omitempty"`
Format *string `json:"format,omitempty"`
Description *string `json:"description,omitempty"`
Colorized *bool `json:"colorized,omitempty"`
Colors map[string]string `json:"colors,omitempty"`
}
type BlueprintMirrorProperty ¶
type BlueprintPermissions ¶
type BlueprintPermissions struct {
Entities BlueprintPermissionsEntities `json:"entities"`
}
type BlueprintPermissionsEntities ¶
type BlueprintPermissionsEntities struct {
Register BlueprintPermissionsBlock `json:"register"`
Unregister BlueprintPermissionsBlock `json:"unregister"`
Update BlueprintPermissionsBlock `json:"update"`
UpdateProperties BlueprintRolesOrPropertiesPermissionsBlock `json:"updateProperties,omitempty"`
UpdateRelations BlueprintRolesOrPropertiesPermissionsBlock `json:"updateRelations,omitempty"`
}
type BlueprintProperty ¶
type BlueprintProperty struct {
Type string `json:"type,omitempty"`
Title *string `json:"title,omitempty"`
Identifier string `json:"identifier,omitempty"`
Items map[string]any `json:"items,omitempty"`
Default any `json:"default,omitempty"`
Icon *string `json:"icon,omitempty"`
Format *string `json:"format,omitempty"`
MaxLength *int `json:"maxLength,omitempty"`
MinLength *int `json:"minLength,omitempty"`
MaxItems *int `json:"maxItems,omitempty"`
MinItems *int `json:"minItems,omitempty"`
Maximum *float64 `json:"maximum,omitempty"`
Minimum *float64 `json:"minimum,omitempty"`
Description *string `json:"description,omitempty"`
Blueprint *string `json:"blueprint,omitempty"`
Pattern *string `json:"pattern,omitempty"`
Enum []any `json:"enum,omitempty"`
Spec *string `json:"spec,omitempty"`
SpecAuthentication *SpecAuthentication `json:"specAuthentication,omitempty"`
EnumColors map[string]string `json:"enumColors,omitempty"`
// UnknownFields captures any dynamic fields not explicitly defined above
UnknownFields map[string]any `json:"-"`
}
func (BlueprintProperty) MarshalJSON ¶ added in v2.8.2
func (bp BlueprintProperty) MarshalJSON() ([]byte, error)
Custom MarshalJSON for BlueprintProperty to include dynamic fields
func (*BlueprintProperty) UnmarshalJSON ¶ added in v2.8.2
func (bp *BlueprintProperty) UnmarshalJSON(data []byte) error
Custom UnmarshalJSON for BlueprintProperty to capture dynamic fields
type BlueprintRolesOrPropertiesPermissionsBlock ¶
type BlueprintRolesOrPropertiesPermissionsBlock map[string]BlueprintPermissionsBlock
type BlueprintSchema ¶
type BlueprintSchema struct {
Properties map[string]BlueprintProperty `json:"properties"`
Required []string `json:"required,omitempty"`
}
type ChangelogDestination ¶
type Dataset ¶
type Dataset struct {
Combinator string `json:"combinator,omitempty"`
Rules []DatasetRule `json:"rules,omitempty"`
}
type DatasetRule ¶
type DatasetRule struct {
Blueprint *string `json:"blueprint,omitempty"`
Property *string `json:"property,omitempty"`
Operator string `json:"operator,omitempty"`
Value *DatasetValue `json:"value,omitempty"`
}
type DatasetValue ¶
type DatasetValue struct {
JqQuery string `json:"jqQuery,omitempty"`
}
type EntitiesSortModel ¶ added in v2.0.20
type Entity ¶
type Entity struct {
Meta
Identifier string `json:"identifier,omitempty"`
Title string `json:"title"`
Icon string `json:"icon,omitempty"`
Blueprint string `json:"blueprint"`
Team []string `json:"team,omitempty"`
Properties map[string]any `json:"properties"`
Relations map[string]any `json:"relations"`
Scorecards map[string]ScorecardModel `json:"scorecards,omitempty"`
}
type EntityProperty ¶
type EntityProperty struct {
Identifier any `json:"identifier,omitempty"`
Title *string `json:"title,omitempty"`
Icon *string `json:"icon,omitempty"`
Team *string `json:"team,omitempty"`
Properties map[string]string `json:"properties,omitempty"`
Relations map[string]any `json:"relations,omitempty"`
}
type Integration ¶ added in v2.0.5
type Integration struct {
InstallationId string `json:"installationId"`
Title *string `json:"title"`
InstallationAppType *string `json:"installationAppType"`
Version *string `json:"version"`
Config *map[string]any `json:"config"`
ChangelogDestination *ChangelogDestination `json:"changelogDestination,omitempty"`
}
type InvocationMethod ¶
type InvocationMethod struct {
Type string `json:"type"`
Payload any `json:"payload,omitempty"`
Url *string `json:"url,omitempty"`
Agent any `json:"agent,omitempty"`
Synchronized any `json:"synchronized,omitempty"`
Method *string `json:"method,omitempty"`
Headers map[string]string `json:"headers,omitempty"`
Body any `json:"body,omitempty"`
Org *string `json:"org,omitempty"`
Repo *string `json:"repo,omitempty"`
Workflow *string `json:"workflow,omitempty"`
WorkflowInputs map[string]any `json:"workflowInputs,omitempty"`
ReportWorkflowStatus any `json:"reportWorkflowStatus,omitempty"`
Branch *string `json:"branch,omitempty"`
ProjectName *string `json:"projectName,omitempty"`
GroupName *string `json:"groupName,omitempty"`
DefaultRef *string `json:"defaultRef,omitempty"`
PipelineVariables map[string]any `json:"pipelineVariables,omitempty"`
Webhook *string `json:"webhook,omitempty"`
BlueprintIdentifier *string `json:"blueprintIdentifier,omitempty"`
Mapping *MappingSchema `json:"mapping,omitempty"`
}
type MappingSchema ¶ added in v2.0.8
type Mappings ¶
type Mappings struct {
Blueprint string `json:"blueprint,omitempty"`
Filter *string `json:"filter,omitempty"`
Operation any `json:"operation,omitempty"`
ItemsToParse *string `json:"itemsToParse,omitempty"`
Entity *EntityProperty `json:"entity,omitempty"`
}
type Migration ¶
type Migration struct {
Meta
Id string `json:"id,omitempty"`
Actor string `json:"actor,omitempty"`
SourceBlueprint string `json:"sourceBlueprint,omitempty"`
Mapping any `json:"mapping,omitempty"`
Status string `json:"status,omitempty"`
DeleteBlueprint bool `json:"deleteBlueprint,omitempty"`
DeleteEntities bool `json:"deleteEntities,omitempty"`
FailureCount int `json:"failureCount,omitempty"`
SuccessCount int `json:"successCount,omitempty"`
}
type Organization ¶ added in v2.5.0
type Page ¶
type Page struct {
Meta
Identifier string `json:"identifier,omitempty"`
Type string `json:"type,omitempty"`
Icon *string `json:"icon,omitempty"`
Parent *string `json:"parent,omitempty"`
After *string `json:"after,omitempty"`
Title *string `json:"title,omitempty"`
Locked *bool `json:"locked,omitempty"`
Blueprint *string `json:"blueprint,omitempty"`
Widgets *[]map[string]any `json:"widgets,omitempty"`
Description *string `json:"description,omitempty"`
}
type PagePermissions ¶
type PagePermissions struct {
Read PageReadPermissions `json:"read"`
}
type PageReadPermissions ¶
type PortBlueprintPermissionsBody ¶
type PortBlueprintPermissionsBody struct {
OK bool `json:"ok"`
BlueprintPermissions BlueprintPermissions `json:"permissions"`
}
type PortBody ¶
type PortBody struct {
OK bool `json:"ok"`
Entity Entity `json:"entity"`
Blueprint Blueprint `json:"blueprint"`
BlueprintPermissions Blueprint `json:"blueprint_permissions"`
Action Action `json:"action"`
ActionPermissions ActionPermissions `json:"permissions"`
Webhook Webhook `json:"integration"`
Scorecard Scorecard `json:"Scorecard"`
Team PortTeam `json:"team"`
Page Page `json:"page"`
MigrationId string `json:"migrationId"`
Migration Migration `json:"migration"`
Folder Folder `json:"folder"`
Organization *Organization `json:"organization"`
}
type PortBodyDelete ¶
type PortBodyDelete struct {
Ok bool `json:"ok"`
}
type PortBodyForIntegration ¶ added in v2.0.5
type PortBodyForIntegration struct {
OK bool `json:"ok"`
Integration Integration `json:"integration"`
}
type PortClient ¶
type PortClient struct {
Client *resty.Client
ClientID string
Token string
JSONEscapeHTML bool
BlueprintPropertyTypeChangeProtection bool
// contains filtered or unexported fields
}
func (*PortClient) Authenticate ¶
func (*PortClient) CreateAction ¶
func (*PortClient) CreateBlueprint ¶
func (*PortClient) CreateEntity ¶
func (*PortClient) CreateFolder ¶ added in v2.2.1
func (*PortClient) CreateIntegration ¶ added in v2.0.5
func (c *PortClient) CreateIntegration(ctx context.Context, integration *Integration) (*Integration, error)
func (*PortClient) CreatePage ¶
func (*PortClient) CreatePermissions ¶
func (*PortClient) CreateScorecard ¶
func (*PortClient) CreateTeam ¶
func (*PortClient) CreateWebhook ¶
func (*PortClient) DeleteAction ¶
func (c *PortClient) DeleteAction(ctx context.Context, actionID string) error
func (*PortClient) DeleteBlueprint ¶
func (c *PortClient) DeleteBlueprint(ctx context.Context, id string) error
func (*PortClient) DeleteBlueprintWithAllEntities ¶
func (*PortClient) DeleteEntity ¶
func (*PortClient) DeleteFolder ¶ added in v2.2.1
func (*PortClient) DeleteIntegration ¶ added in v2.0.5
func (*PortClient) DeletePage ¶
func (*PortClient) DeleteScorecard ¶
func (*PortClient) DeleteTeam ¶
func (c *PortClient) DeleteTeam(ctx context.Context, teamName string) error
func (*PortClient) DeleteWebhook ¶
func (c *PortClient) DeleteWebhook(ctx context.Context, webhookID string) error
func (*PortClient) FeatureFlags ¶ added in v2.5.0
func (c *PortClient) FeatureFlags(ctx context.Context) ([]string, error)
FeatureFlags Fetches the feature flags from the Organization API. It caches the feature flags locally to reduce call count.
func (*PortClient) GetActionPermissions ¶
func (c *PortClient) GetActionPermissions(ctx context.Context, actionID string) (*ActionPermissions, int, error)
func (*PortClient) GetBlueprintPermissions ¶
func (c *PortClient) GetBlueprintPermissions(ctx context.Context, blueprintID string) (*BlueprintPermissions, int, error)
func (*PortClient) GetIntegration ¶ added in v2.0.5
func (c *PortClient) GetIntegration(ctx context.Context, id string) (*Integration, error)
func (*PortClient) GetMigration ¶
func (*PortClient) GetPagePermissions ¶
func (c *PortClient) GetPagePermissions(ctx context.Context, pageID string) (*PagePermissions, int, error)
func (*PortClient) HasFeatureFlags ¶ added in v2.5.0
func (*PortClient) ReadAction ¶
func (*PortClient) ReadBlueprint ¶
func (*PortClient) ReadEntity ¶
func (*PortClient) ReadOrganization ¶ added in v2.5.0
func (c *PortClient) ReadOrganization(ctx context.Context) (*Organization, int, error)
func (*PortClient) ReadScorecard ¶
func (*PortClient) ReadSystemBlueprintStructure ¶ added in v2.2.0
func (*PortClient) ReadWebhook ¶
func (*PortClient) Search ¶ added in v2.0.7
func (c *PortClient) Search(ctx context.Context, searchRequest *SearchRequestQuery) (*SearchResult, error)
func (*PortClient) UpdateAction ¶
func (*PortClient) UpdateActionPermissions ¶
func (c *PortClient) UpdateActionPermissions(ctx context.Context, actionID string, permissions *ActionPermissions) (*ActionPermissions, error)
func (*PortClient) UpdateBlueprint ¶
func (*PortClient) UpdateBlueprintPermissions ¶
func (c *PortClient) UpdateBlueprintPermissions(ctx context.Context, blueprintID string, permissions *BlueprintPermissions) (*BlueprintPermissions, error)
func (*PortClient) UpdateEntity ¶
func (*PortClient) UpdateFolder ¶ added in v2.2.1
func (*PortClient) UpdateIntegration ¶ added in v2.0.5
func (c *PortClient) UpdateIntegration(ctx context.Context, id string, integration *Integration) (*Integration, error)
func (*PortClient) UpdatePage ¶
func (*PortClient) UpdatePagePermissions ¶
func (c *PortClient) UpdatePagePermissions(ctx context.Context, pageID string, permissions *PagePermissions) (*PagePermissions, error)
func (*PortClient) UpdateScorecard ¶
func (*PortClient) UpdateTeam ¶
func (*PortClient) UpdateWebhook ¶
type PortPagePermissionsBody ¶
type PortPagePermissionsBody struct {
OK bool `json:"ok"`
PagePermissions PagePermissions `json:"permissions"`
}
type PortProviderModel ¶
type PortProviderModel struct {
ClientId types.String `tfsdk:"client_id"`
Secret types.String `tfsdk:"secret"`
Token types.String `tfsdk:"token"`
BaseUrl types.String `tfsdk:"base_url"`
JSONEscapeHTML types.Bool `tfsdk:"json_escape_html"`
BlueprintPropertyTypeChangeProtection types.Bool `tfsdk:"blueprint_property_type_change_protection"`
}
type PortTeamBody ¶
type PortTeamBody struct {
OK bool `json:"ok"`
Team TeamPortBody `json:"team"`
}
type ScorecardModel ¶ added in v2.0.7
type ScorecardModel struct {
Rules []ScorecardRulesModel `json:"rules"`
Level string `json:"level"`
}
type ScorecardRulesModel ¶ added in v2.0.7
type SearchEntityResult ¶ added in v2.0.7
type SearchEntityResult struct {
Meta
Identifier string `json:"identifier,omitempty"`
Title string `json:"title,omitempty"`
Icon *string `json:"icon,omitempty"`
Team []string `json:"team,omitempty"`
Properties map[string]any `json:"properties,omitempty"`
Relations map[string]any `json:"relations,omitempty"`
}
type SearchRequestQuery ¶ added in v2.0.7
type SearchRequestQuery struct {
Query *map[string]any `json:"query"`
ExcludeCalculatedProperties *bool `json:"exclude_calculated_properties,omitempty"`
Include []string `json:"include,omitempty"`
Exclude []string `json:"exclude,omitempty"`
AttachTitleToRelation *bool `json:"attach_title_to_relation,omitempty"`
}
type SearchResult ¶ added in v2.0.7
type Security ¶
type Security struct {
Secret *string `json:"secret,omitempty"`
SignatureHeaderName *string `json:"signatureHeaderName,omitempty"`
SignatureAlgorithm *string `json:"signatureAlgorithm,omitempty"`
SignaturePrefix *string `json:"signaturePrefix,omitempty"`
RequestIdentifierPath *string `json:"requestIdentifierPath,omitempty"`
}
type SidebarDTO ¶ added in v2.2.1
type SidebarDTO struct {
Identifier string `json:"identifier"`
Items []SidebarItemDTO `json:"items"`
}
type SidebarFolderItem ¶ added in v2.2.1
type SidebarFolderItem struct {
SidebarLocation
Identifier string `json:"identifier"`
Title string `json:"title"`
}
type SidebarGetResponseDTO ¶ added in v2.2.1
type SidebarGetResponseDTO struct {
Ok bool `json:"ok"`
Sidebar *SidebarDTO `json:"sidebar"`
}
type SidebarItemDTO ¶ added in v2.2.1
type SidebarLocation ¶ added in v2.2.1
type SpecAuthentication ¶
type TeamInheritance ¶
type TeamInheritance struct {
Path string `json:"path,omitempty"`
}
type TeamPortBody ¶
type TeamPortBody struct {
CreatedAt *time.Time `json:"createdAt,omitempty"`
UpdatedAt *time.Time `json:"updatedAt,omitempty"`
Name string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
Users []TeamUserBody `json:"users,omitempty"`
Provider string `json:"provider,omitempty"`
}
type TeamUserBody ¶
type TeamUserBody struct {
Email string `json:"email"`
}
type Trigger ¶
type Trigger struct {
Type string `json:"type"`
BlueprintIdentifier *string `json:"blueprintIdentifier,omitempty"`
Operation *string `json:"operation,omitempty"`
UserInputs *ActionUserInputs `json:"userInputs,omitempty"`
Event *TriggerEvent `json:"event,omitempty"`
Condition *TriggerCondition `json:"condition,omitempty"`
}
type TriggerCondition ¶
type TriggerEvent ¶
type Webhook ¶
type Webhook struct {
Meta
Identifier string `json:"identifier,omitempty"`
Title *string `json:"title,omitempty"`
Icon *string `json:"icon,omitempty"`
Description *string `json:"description,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Security *Security `json:"security,omitempty"`
Mappings []Mappings `json:"mappings,omitempty"`
WebhookKey string `json:"webhookKey,omitempty"`
Url string `json:"url,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.