Documentation
¶
Index ¶
Constants ¶
const ( AppsResource = "apps" BuildpacksResource = "buildpacks" BuildsResource = "builds" DeploymentsResource = "deployments" DomainsResource = "domains" DropletsResource = "droplets" EventsResource = "audit_events" EnvironmentVariableGroupsResource = "environment_variable_groups" FeatureFlagsResource = "feature_flags" IsolationSegmentsResource = "isolation_segments" OrgsResource = "organizations" OrgQuotasResource = "organization_quotas" PackagesResource = "packages" ProcessesResource = "processes" ResourceMatches = "resource_matches" SecurityGroupsResource = "security_groups" ServiceBrokersResource = "service_brokers" RolesResource = "roles" RoutesResource = "routes" ServiceInstancesResource = "service_instances" ServiceOfferingsResource = "service_offerings" ServicePlansResource = "service_plans" SpaceQuotasResource = "space_quotas" SpacesResource = "spaces" StacksResource = "stacks" TasksResource = "tasks" UsersResource = "users" )
When adding a resource, also add it to the api/cloudcontroller/ccv3/ccv3_suite_test.go resources response
const ( DeleteApplicationProcessInstanceRequest = "DeleteApplicationProcessInstance" DeleteApplicationRequest = "DeleteApplication" DeleteBuildpackRequest = "DeleteBuildpack" DeleteDomainRequest = "DeleteDomainRequest" DeleteIsolationSegmentRelationshipOrganizationRequest = "DeleteIsolationSegmentRelationshipOrganization" DeleteIsolationSegmentRequest = "DeleteIsolationSegment" DeleteOrganizationRequest = "DeleteOrganization" DeleteOrganizationQuotaRequest = "DeleteOrganizationQuota" DeleteOrphanedRoutesRequest = "DeleteOrphanedRoutes" DeleteRouteRequest = "DeleteRouteRequest" DeleteRoleRequest = "DeleteRoleRequest" DeleteSecurityGroupRequest = "DeleteSecurityGroup" DeleteSecurityGroupStagingSpaceRequest = "DeleteSecurityGroupStagingSpace" DeleteSecurityGroupRunningSpaceRequest = "DeleteSecurityGroupRunningSpace" DeleteServiceBrokerRequest = "DeleteServiceBrokerRequest" DeleteServiceOfferingRequest = "DeleteServiceOffering" DeleteServicePlanVisibilityRequest = "DeleteServicePlanVisibility" DeleteSpaceQuotaRequest = "DeleteSpaceQuota" DeleteSpaceRequest = "DeleteSpace" DeleteSpaceQuotaFromSpaceRequest = "DeleteSpaceQuotaFromSpace" DeleteUserRequest = "DeleteUser" GetApplicationDropletCurrentRequest = "GetApplicationDropletCurrent" GetApplicationEnvRequest = "GetApplicationEnv" GetApplicationFeaturesRequest = "GetApplicationFeatures" GetApplicationManifestRequest = "GetApplicationManifest" GetApplicationProcessRequest = "GetApplicationProcess" GetApplicationProcessesRequest = "GetApplicationProcesses" GetApplicationRoutesRequest = "GetApplicationRoutes" GetApplicationTasksRequest = "GetApplicationTasks" GetApplicationsRequest = "GetApplications" GetBuildRequest = "GetBuild" GetBuildpacksRequest = "GetBuildpacks" GetDefaultDomainRequest = "GetDefaultDomain" GetDeploymentRequest = "GetDeployment" GetDeploymentsRequest = "GetDeployments" GetDomainRequest = "GetDomain" GetDomainRouteReservationsRequest = "GetDomainRouteReservations" GetDomainsRequest = "GetDomains" GetDropletRequest = "GetDroplet" GetDropletsRequest = "GetDroplets" GetEnvironmentVariableGroupRequest = "GetEnvironmentVariableGroup" GetEventsRequest = "GetEvents" GetFeatureFlagRequest = "GetFeatureFlag" GetFeatureFlagsRequest = "GetFeatureFlags" GetIsolationSegmentOrganizationsRequest = "GetIsolationSegmentOrganizations" GetIsolationSegmentRequest = "GetIsolationSegment" GetIsolationSegmentsRequest = "GetIsolationSegments" GetOrganizationDomainsRequest = "GetOrganizationDomains" GetOrganizationQuotasRequest = "GetOrganizationQuotas" GetOrganizationQuotaRequest = "GetOrganizationQuota" GetOrganizationRelationshipDefaultIsolationSegmentRequest = "GetOrganizationRelationshipDefaultIsolationSegment" GetOrganizationRequest = "GetOrganization" GetOrganizationsRequest = "GetOrganizations" GetPackageRequest = "GetPackage" GetPackagesRequest = "GetPackages" GetPackageDropletsRequest = "GetPackageDroplets" GetProcessRequest = "GetProcess" GetProcessStatsRequest = "GetProcessStats" GetProcessSidecarsRequest = "GetProcessSidecars" GetRolesRequest = "GetRoles" GetRouteDestinationsRequest = "GetRouteDestinations" GetRoutesRequest = "GetRoutes" GetSecurityGroupsRequest = "GetSecurityGroups" GetServiceBrokersRequest = "GetServiceBrokers" GetServiceInstancesRequest = "GetServiceInstances" GetServiceOfferingsRequest = "GetServiceOfferings" GetServicePlansRequest = "GetServicePlans" GetServicePlanVisibilityRequest = "GetServicePlanVisibility" GetSpaceFeatureRequest = "GetSpaceFeatureRequest" GetSpaceRelationshipIsolationSegmentRequest = "GetSpaceRelationshipIsolationSegment" GetSpaceRunningSecurityGroupsRequest = "GetSpaceRunningSecurityGroups" GetSpacesRequest = "GetSpaces" GetSpaceQuotaRequest = "GetSpaceQuota" GetSpaceQuotasRequest = "GetSpaceQuotas" GetSpaceStagingSecurityGroupsRequest = "GetSpaceStagingSecurityGroups" GetSSHEnabled = "GetSSHEnabled" GetStacksRequest = "GetStacks" GetUserRequest = "GetUser" GetUsersRequest = "GetUsers" MapRouteRequest = "MapRoute" PatchApplicationCurrentDropletRequest = "PatchApplicationCurrentDroplet" PatchApplicationEnvironmentVariablesRequest = "PatchApplicationEnvironmentVariables" PatchApplicationRequest = "PatchApplication" PatchApplicationFeaturesRequest = "PatchApplicationFeatures" PatchEnvironmentVariableGroupRequest = "PatchEnvironmentVariableGroup" PatchBuildpackRequest = "PatchBuildpack" PatchDomainRequest = "PatchDomain" PatchFeatureFlagRequest = "PatchFeatureFlag" PatchOrganizationRelationshipDefaultIsolationSegmentRequest = "PatchOrganizationRelationshipDefaultIsolationSegment" PatchOrganizationRequest = "PatchOrganization" PatchOrganizationQuotaRequest = "PatchOrganizationQuota" PatchProcessRequest = "PatchProcess" PatchRouteRequest = "PatchRoute" PatchSecurityGroupRequest = "PatchSecurityGroup" PatchServiceBrokerRequest = "PatchServiceBrokerRequest" PatchServiceOfferingRequest = "PatchServiceOfferingRequest" PatchServicePlanRequest = "PatchServicePlanRequest" PatchSpaceRelationshipIsolationSegmentRequest = "PatchSpaceRelationshipIsolationSegment" PatchSpaceRequest = "PatchSpace" PatchSpaceFeaturesRequest = "PatchSpaceFeatures" PatchSpaceQuotaRequest = "PatchSpaceQuota" PatchStackRequest = "PatchStack" PostApplicationActionApplyManifest = "PostApplicationActionApplyM" PostApplicationActionRestartRequest = "PostApplicationActionRestart" PostApplicationActionStartRequest = "PostApplicationActionStart" PostApplicationActionStopRequest = "PostApplicationActionStop" PostApplicationDeploymentActionCancelRequest = "PostApplicationDeploymentActionCancel" PostApplicationDeploymentRequest = "PostApplicationDeployment" PostApplicationProcessActionScaleRequest = "PostApplicationProcessActionScale" PostApplicationRequest = "PostApplication" PostApplicationTasksRequest = "PostApplicationTasks" PostBuildRequest = "PostBuild" PostBuildpackBitsRequest = "PostBuildpackBits" PostBuildpackRequest = "PostBuildpack" PostDomainRequest = "PostDomain" PostDropletBitsRequest = "PostDropletBits" PostDropletRequest = "PostDroplet" PostIsolationSegmentRelationshipOrganizationsRequest = "PostIsolationSegmentRelationshipOrganizations" PostIsolationSegmentsRequest = "PostIsolationSegments" PostOrganizationRequest = "PostOrganization" PostOrganizationQuotaRequest = "PostOrganizationQuota" PostOrganizationQuotaApplyRequest = "PostOrganizationQuotaApply" PostPackageRequest = "PostPackage" PostPackageBitsRequest = "PostPackageBits" PostResourceMatchesRequest = "PostResourceMatches" PostRoleRequest = "PostRole" PostRouteRequest = "PostRoute" PostSecurityGroupRequest = "PostSecurityGroup" PostSecurityGroupStagingSpaceRequest = "PostSecurityGroupStagingSpace" PostSecurityGroupRunningSpaceRequest = "PostSecurityGroupRunningSpace" PostServiceBrokerRequest = "PostServiceBroker" PostServicePlanVisibilityRequest = "PostServicePlanVisibility" PostSpaceActionApplyManifestRequest = "PostSpaceActionApplyManifest" PostSpaceRequest = "PostSpace" PostSpaceQuotaRequest = "PostSpaceQuota" PostSpaceQuotaRelationshipsRequest = "PostSpaceQuotaRelationships" PostUserRequest = "PostUser" PutTaskCancelRequest = "PutTaskCancel" UnmapRouteRequest = "UnmapRoute" )
Naming convention:
HTTP method + non-parameter parts of the path + "Request"
If the request returns a single entity by GUID, use the singular (for example /v2/organizations/:organization_guid is GetOrganization).
Variables ¶
var APIRoutes = []Route{}/* 143 elements not displayed */
APIRoutes is a list of routes used by the router to construct request URLs.
Functions ¶
This section is empty.
Types ¶
type Params ¶
Params map path keys to values. For example, if your route has the path pattern:
/person/:person_id/pets/:pet_type
Then a correct Params map would lool like:
router.Params{ "person_id": "123", "pet_type": "cats", }
type Route ¶
type Route struct { // Name is a key specifying which HTTP route the router should associate with // the endpoint at runtime. Name string // Method is any valid HTTP method Method string // Path contains a path pattern Path string // Resource is a key specifying which resource root the router should // associate with the endpoint at runtime. Resource string }
Route defines the property of a Cloud Controller V3 endpoint.
Method can be one of the following:
GET HEAD POST PUT PATCH DELETE CONNECT OPTIONS TRACE
Path conforms to Pat-style pattern matching. The following docs are taken from http://godoc.org/github.com/bmizerany/pat#PatternServeMux
Path Patterns may contain literals or captures. Capture names start with a colon and consist of letters A-Z, a-z, _, and 0-9. The rest of the pattern matches literally. The portion of the URL matching each name ends with an occurrence of the character in the pattern immediately following the name, or a /, whichever comes first. It is possible for a name to match the empty string.
Example pattern with one capture:
/hello/:name
Will match:
/hello/blake /hello/keith
Will not match:
/hello/blake/ /hello/blake/foo /foo /foo/bar
Example 2:
/hello/:name/
Will match:
/hello/blake/ /hello/keith/foo /hello/blake /hello/keith
Will not match:
/foo /foo/bar