github.com/willmadison/cli@v6.40.1-0.20181018160101-29d5937903ff+incompatible/api/cloudcontroller/ccv2/internal/api_routes.go (about)

     1  package internal
     2  
     3  import (
     4  	"net/http"
     5  
     6  	"github.com/tedsuo/rata"
     7  )
     8  
     9  // Naming convention:
    10  //
    11  // Method + non-parameter parts of the path
    12  //
    13  // If the request returns a single entity by GUID, use the singular (for example
    14  // /v2/organizations/:organization_guid is GetOrganization).
    15  //
    16  // The const name should always be the const value + Request.
    17  const (
    18  	DeleteOrganizationRequest                            = "DeleteOrganization"
    19  	DeleteRouteAppRequest                                = "DeleteRouteApp"
    20  	DeleteRouteRequest                                   = "DeleteRoute"
    21  	DeleteSecurityGroupSpaceRequest                      = "DeleteSecurityGroupSpace"
    22  	DeleteSecurityGroupStagingSpaceRequest               = "DeleteSecurityGroupStagingSpace"
    23  	DeleteServiceBindingRequest                          = "DeleteServiceBinding"
    24  	DeleteSpaceRequest                                   = "DeleteSpace"
    25  	GetAppInstancesRequest                               = "GetAppInstances"
    26  	GetAppRequest                                        = "GetApp"
    27  	GetAppRoutesRequest                                  = "GetAppRoutes"
    28  	GetAppsRequest                                       = "GetApps"
    29  	GetAppStatsRequest                                   = "GetAppStats"
    30  	GetBuildpacksRequest                                 = "GetBuildpacks"
    31  	GetConfigFeatureFlagsRequest                         = "GetConfigFeatureFlags"
    32  	GetEventsRequest                                     = "GetEvents"
    33  	GetInfoRequest                                       = "GetInfo"
    34  	GetJobRequest                                        = "GetJob"
    35  	GetOrganizationPrivateDomainsRequest                 = "GetOrganizationPrivateDomains"
    36  	GetOrganizationQuotaDefinitionsRequest               = "GetOrganizationQuotaDefinitions"
    37  	GetOrganizationQuotaDefinitionRequest                = "GetOrganizationQuotaDefinition"
    38  	GetOrganizationRequest                               = "GetOrganization"
    39  	GetOrganizationsRequest                              = "GetOrganizations"
    40  	GetPrivateDomainRequest                              = "GetPrivateDomain"
    41  	GetPrivateDomainsRequest                             = "GetPrivateDomains"
    42  	GetRouteAppsRequest                                  = "GetRouteApps"
    43  	GetRouteMappingRequest                               = "GetRouteMapping"
    44  	GetRouteMappingsRequest                              = "GetRouteMappings"
    45  	GetRouteRequest                                      = "GetRoute"
    46  	GetRouteReservedDeprecatedRequest                    = "GetRouteReservedDeprecated"
    47  	GetRouteReservedRequest                              = "GetRouteReserved"
    48  	GetRouteRouteMappingsRequest                         = "GetRouteRouteMappings"
    49  	GetRoutesRequest                                     = "GetRoutes"
    50  	GetSecurityGroupSpacesRequest                        = "GetSecurityGroupSpaces"
    51  	GetSecurityGroupsRequest                             = "GetSecurityGroups"
    52  	GetSecurityGroupStagingSpacesRequest                 = "GetSecurityGroupStagingSpaces"
    53  	GetServiceBindingRequest                             = "GetServiceBinding"
    54  	GetServiceBindingsRequest                            = "GetServiceBindings"
    55  	GetServiceBrokersRequest                             = "GetServiceBrokers"
    56  	GetServiceInstanceRequest                            = "GetServiceInstance"
    57  	GetServiceInstanceServiceBindingsRequest             = "GetServiceInstanceServiceBindings"
    58  	GetServiceInstanceSharedFromRequest                  = "GetServiceInstanceSharedFrom"
    59  	GetServiceInstanceSharedToRequest                    = "GetServiceInstanceSharedTo"
    60  	GetServiceInstancesRequest                           = "GetServiceInstances"
    61  	GetServicePlanRequest                                = "GetServicePlan"
    62  	GetServicePlansRequest                               = "GetServicePlans"
    63  	GetServicePlanVisibilitiesRequest                    = "GetServicePlanVisibilities"
    64  	GetServiceRequest                                    = "GetService"
    65  	GetServicesRequest                                   = "GetServices"
    66  	GetSharedDomainRequest                               = "GetSharedDomain"
    67  	GetSharedDomainsRequest                              = "GetSharedDomains"
    68  	GetOrganizationSpaceQuotasRequest                    = "GetOrganizationSpaceQuotas"
    69  	GetSpaceQuotaDefinitionRequest                       = "GetSpaceQuotaDefinition"
    70  	GetSpaceRoutesRequest                                = "GetSpaceRoutes"
    71  	GetSpaceSecurityGroupsRequest                        = "GetSpaceSecurityGroups"
    72  	GetSpaceServiceInstancesRequest                      = "GetSpaceServiceInstances"
    73  	GetSpacesRequest                                     = "GetSpaces"
    74  	GetSpaceStagingSecurityGroupsRequest                 = "GetSpaceStagingSecurityGroups"
    75  	GetStackRequest                                      = "GetStack"
    76  	GetStacksRequest                                     = "GetStacks"
    77  	GetUserProvidedServiceInstanceServiceBindingsRequest = "GetUserProvidedServiceInstanceServiceBindings"
    78  	GetUserProvidedServiceInstancesRequest               = "GetUserProvidedServiceInstances"
    79  	GetUsersRequest                                      = "GetUsers"
    80  	PostAppRequest                                       = "PostApp"
    81  	PostAppRestageRequest                                = "PostAppRestage"
    82  	PostBuildpackRequest                                 = "PostBuildpack"
    83  	PostOrganizationRequest                              = "PostOrganization"
    84  	PostRouteRequest                                     = "PostRoute"
    85  	PostServiceBindingRequest                            = "PostServiceBinding"
    86  	PostServiceKeyRequest                                = "PostServiceKey"
    87  	PostSpaceRequest                                     = "PostSpace"
    88  	PostUserRequest                                      = "PostUser"
    89  	PutAppBitsRequest                                    = "PutAppBits"
    90  	PutAppRequest                                        = "PutApp"
    91  	PutBuildpackRequest                                  = "PutBuildpack"
    92  	PutBuildpackBitsRequest                              = "PutBuildpackBits"
    93  	PutDropletRequest                                    = "PutDroplet"
    94  	PutOrganizationManagerByUsernameRequest              = "PutOrganizationManagerByUsername"
    95  	PutOrganizationManagerRequest                        = "PutOrganizationManager"
    96  	PutOrganizationUserRequest                           = "PutOrganizationUser"
    97  	PutOrganizationUserByUsernameRequest                 = "PutOrganizationUserByUsername"
    98  	PutResourceMatchRequest                              = "PutResourceMatch"
    99  	PutRouteAppRequest                                   = "PutRouteApp"
   100  	PutSpaceQuotaRequest                                 = "PutSpaceQuotaRequest"
   101  	PutSpaceDeveloperRequest                             = "PutSpaceDeveloper"
   102  	PutSpaceDeveloperByUsernameRequest                   = "PutSpaceDeveloperByUsername"
   103  	PutSpaceManagerRequest                               = "PutSpaceManager"
   104  	PutSpaceManagerByUsernameRequest                     = "PutSpaceManagerByUsername"
   105  	PutSecurityGroupSpaceRequest                         = "PutSecurityGroupSpace"
   106  	PutSecurityGroupStagingSpaceRequest                  = "PutSecurityGroupStagingSpace"
   107  )
   108  
   109  // APIRoutes is a list of routes used by the rata library to construct request
   110  // URLs.
   111  var APIRoutes = rata.Routes{
   112  	{Path: "/v2/apps", Method: http.MethodGet, Name: GetAppsRequest},
   113  	{Path: "/v2/apps", Method: http.MethodPost, Name: PostAppRequest},
   114  	{Path: "/v2/apps/:app_guid", Method: http.MethodGet, Name: GetAppRequest},
   115  	{Path: "/v2/apps/:app_guid", Method: http.MethodPut, Name: PutAppRequest},
   116  	{Path: "/v2/apps/:app_guid/bits", Method: http.MethodPut, Name: PutAppBitsRequest},
   117  	{Path: "/v2/apps/:app_guid/droplet/upload", Method: http.MethodPut, Name: PutDropletRequest},
   118  	{Path: "/v2/apps/:app_guid/instances", Method: http.MethodGet, Name: GetAppInstancesRequest},
   119  	{Path: "/v2/apps/:app_guid/restage", Method: http.MethodPost, Name: PostAppRestageRequest},
   120  	{Path: "/v2/apps/:app_guid/routes", Method: http.MethodGet, Name: GetAppRoutesRequest},
   121  	{Path: "/v2/apps/:app_guid/stats", Method: http.MethodGet, Name: GetAppStatsRequest},
   122  	{Path: "/v2/buildpacks", Method: http.MethodPost, Name: PostBuildpackRequest},
   123  	{Path: "/v2/buildpacks", Method: http.MethodGet, Name: GetBuildpacksRequest},
   124  	{Path: "/v2/buildpacks/:buildpack_guid", Method: http.MethodPut, Name: PutBuildpackRequest},
   125  	{Path: "/v2/buildpacks/:buildpack_guid/bits", Method: http.MethodPut, Name: PutBuildpackBitsRequest},
   126  	{Path: "/v2/config/feature_flags", Method: http.MethodGet, Name: GetConfigFeatureFlagsRequest},
   127  	{Path: "/v2/events", Method: http.MethodGet, Name: GetEventsRequest},
   128  	{Path: "/v2/info", Method: http.MethodGet, Name: GetInfoRequest},
   129  	{Path: "/v2/jobs/:job_guid", Method: http.MethodGet, Name: GetJobRequest},
   130  	{Path: "/v2/organizations", Method: http.MethodGet, Name: GetOrganizationsRequest},
   131  	{Path: "/v2/organizations", Method: http.MethodPost, Name: PostOrganizationRequest},
   132  	{Path: "/v2/organizations/:organization_guid", Method: http.MethodDelete, Name: DeleteOrganizationRequest},
   133  	{Path: "/v2/organizations/:organization_guid", Method: http.MethodGet, Name: GetOrganizationRequest},
   134  	{Path: "/v2/organizations/:organization_guid/managers", Method: http.MethodPut, Name: PutOrganizationManagerByUsernameRequest},
   135  	{Path: "/v2/organizations/:organization_guid/managers/:manager_guid", Method: http.MethodPut, Name: PutOrganizationManagerRequest},
   136  	{Path: "/v2/organizations/:organization_guid/private_domains", Method: http.MethodGet, Name: GetOrganizationPrivateDomainsRequest},
   137  	{Path: "/v2/organizations/:organization_guid/users", Method: http.MethodPut, Name: PutOrganizationUserByUsernameRequest},
   138  	{Path: "/v2/organizations/:organization_guid/users/:user_guid", Method: http.MethodPut, Name: PutOrganizationUserRequest},
   139  	{Path: "/v2/private_domains", Method: http.MethodGet, Name: GetPrivateDomainsRequest},
   140  	{Path: "/v2/private_domains/:private_domain_guid", Method: http.MethodGet, Name: GetPrivateDomainRequest},
   141  	{Path: "/v2/quota_definitions/:organization_quota_guid", Method: http.MethodGet, Name: GetOrganizationQuotaDefinitionRequest},
   142  	{Path: "/v2/quota_definitions", Method: http.MethodGet, Name: GetOrganizationQuotaDefinitionsRequest},
   143  	{Path: "/v2/resource_match", Method: http.MethodPut, Name: PutResourceMatchRequest},
   144  	{Path: "/v2/route_mappings", Method: http.MethodGet, Name: GetRouteMappingsRequest},
   145  	{Path: "/v2/route_mappings/:route_mapping_guid", Method: http.MethodGet, Name: GetRouteMappingRequest},
   146  	{Path: "/v2/routes", Method: http.MethodGet, Name: GetRoutesRequest},
   147  	{Path: "/v2/routes", Method: http.MethodPost, Name: PostRouteRequest},
   148  	{Path: "/v2/routes/:route_guid", Method: http.MethodDelete, Name: DeleteRouteRequest},
   149  	{Path: "/v2/routes/:route_guid", Method: http.MethodGet, Name: GetRouteRequest},
   150  	{Path: "/v2/routes/:route_guid/apps", Method: http.MethodGet, Name: GetRouteAppsRequest},
   151  	{Path: "/v2/routes/:route_guid/apps/:app_guid", Method: http.MethodDelete, Name: DeleteRouteAppRequest},
   152  	{Path: "/v2/routes/:route_guid/apps/:app_guid", Method: http.MethodPut, Name: PutRouteAppRequest},
   153  	{Path: "/v2/routes/:route_guid/route_mappings", Method: http.MethodGet, Name: GetRouteRouteMappingsRequest},
   154  	{Path: "/v2/routes/reserved/domain/:domain_guid", Method: http.MethodGet, Name: GetRouteReservedRequest},
   155  	{Path: "/v2/routes/reserved/domain/:domain_guid/host/:host", Method: http.MethodGet, Name: GetRouteReservedDeprecatedRequest},
   156  	{Path: "/v2/security_groups", Method: http.MethodGet, Name: GetSecurityGroupsRequest},
   157  	{Path: "/v2/security_groups/:security_group_guid/spaces", Method: http.MethodGet, Name: GetSecurityGroupSpacesRequest},
   158  	{Path: "/v2/security_groups/:security_group_guid/spaces/:space_guid", Method: http.MethodDelete, Name: DeleteSecurityGroupSpaceRequest},
   159  	{Path: "/v2/security_groups/:security_group_guid/spaces/:space_guid", Method: http.MethodPut, Name: PutSecurityGroupSpaceRequest},
   160  	{Path: "/v2/security_groups/:security_group_guid/staging_spaces", Method: http.MethodGet, Name: GetSecurityGroupStagingSpacesRequest},
   161  	{Path: "/v2/security_groups/:security_group_guid/staging_spaces/:space_guid", Method: http.MethodDelete, Name: DeleteSecurityGroupStagingSpaceRequest},
   162  	{Path: "/v2/security_groups/:security_group_guid/staging_spaces/:space_guid", Method: http.MethodPut, Name: PutSecurityGroupStagingSpaceRequest},
   163  	{Path: "/v2/service_bindings", Method: http.MethodGet, Name: GetServiceBindingsRequest},
   164  	{Path: "/v2/service_bindings", Method: http.MethodPost, Name: PostServiceBindingRequest},
   165  	{Path: "/v2/service_bindings/:service_binding_guid", Method: http.MethodDelete, Name: DeleteServiceBindingRequest},
   166  	{Path: "/v2/service_bindings/:service_binding_guid", Method: http.MethodGet, Name: GetServiceBindingRequest},
   167  	{Path: "/v2/service_brokers", Method: http.MethodGet, Name: GetServiceBrokersRequest},
   168  	{Path: "/v2/service_instances", Method: http.MethodGet, Name: GetServiceInstancesRequest},
   169  	{Path: "/v2/service_instances/:service_instance_guid", Method: http.MethodGet, Name: GetServiceInstanceRequest},
   170  	{Path: "/v2/service_instances/:service_instance_guid/service_bindings", Method: http.MethodGet, Name: GetServiceInstanceServiceBindingsRequest},
   171  	{Path: "/v2/service_instances/:service_instance_guid/shared_from", Method: http.MethodGet, Name: GetServiceInstanceSharedFromRequest},
   172  	{Path: "/v2/service_instances/:service_instance_guid/shared_to", Method: http.MethodGet, Name: GetServiceInstanceSharedToRequest},
   173  	{Path: "/v2/service_keys", Method: http.MethodPost, Name: PostServiceKeyRequest},
   174  	{Path: "/v2/service_plan_visibilities", Method: http.MethodGet, Name: GetServicePlanVisibilitiesRequest},
   175  	{Path: "/v2/service_plans", Method: http.MethodGet, Name: GetServicePlansRequest},
   176  	{Path: "/v2/service_plans/:service_plan_guid", Method: http.MethodGet, Name: GetServicePlanRequest},
   177  	{Path: "/v2/services", Method: http.MethodGet, Name: GetServicesRequest},
   178  	{Path: "/v2/services/:service_guid", Method: http.MethodGet, Name: GetServiceRequest},
   179  	{Path: "/v2/shared_domains", Method: http.MethodGet, Name: GetSharedDomainsRequest},
   180  	{Path: "/v2/shared_domains/:shared_domain_guid", Method: http.MethodGet, Name: GetSharedDomainRequest},
   181  	{Path: "/v2/organizations/:organization_guid/space_quota_definitions", Method: http.MethodGet, Name: GetOrganizationSpaceQuotasRequest},
   182  	{Path: "/v2/space_quota_definitions/:space_quota_guid/spaces/:space_guid", Method: http.MethodPut, Name: PutSpaceQuotaRequest},
   183  	{Path: "/v2/space_quota_definitions/:space_quota_guid", Method: http.MethodGet, Name: GetSpaceQuotaDefinitionRequest},
   184  	{Path: "/v2/spaces", Method: http.MethodGet, Name: GetSpacesRequest},
   185  	{Path: "/v2/spaces", Method: http.MethodPost, Name: PostSpaceRequest},
   186  	{Path: "/v2/spaces/:space_guid/developers", Method: http.MethodPut, Name: PutSpaceDeveloperByUsernameRequest},
   187  	{Path: "/v2/spaces/:space_guid/developers/:developer_guid", Method: http.MethodPut, Name: PutSpaceDeveloperRequest},
   188  	{Path: "/v2/spaces/:guid/service_instances", Method: http.MethodGet, Name: GetSpaceServiceInstancesRequest},
   189  	{Path: "/v2/spaces/:space_guid", Method: http.MethodDelete, Name: DeleteSpaceRequest},
   190  	{Path: "/v2/spaces/:space_guid/routes", Method: http.MethodGet, Name: GetSpaceRoutesRequest},
   191  	{Path: "/v2/spaces/:space_guid/security_groups", Method: http.MethodGet, Name: GetSpaceSecurityGroupsRequest},
   192  	{Path: "/v2/spaces/:space_guid/staging_security_groups", Method: http.MethodGet, Name: GetSpaceStagingSecurityGroupsRequest},
   193  	{Path: "/v2/spaces/:space_guid/managers", Method: http.MethodPut, Name: PutSpaceManagerByUsernameRequest},
   194  	{Path: "/v2/spaces/:space_guid/managers/:manager_guid", Method: http.MethodPut, Name: PutSpaceManagerRequest},
   195  	{Path: "/v2/stacks", Method: http.MethodGet, Name: GetStacksRequest},
   196  	{Path: "/v2/stacks/:stack_guid", Method: http.MethodGet, Name: GetStackRequest},
   197  	{Path: "/v2/user_provided_service_instances", Method: http.MethodGet, Name: GetUserProvidedServiceInstancesRequest},
   198  	{Path: "/v2/user_provided_service_instances/:user_provided_service_instance_guid/service_bindings", Method: http.MethodGet, Name: GetUserProvidedServiceInstanceServiceBindingsRequest},
   199  	{Path: "/v2/users", Method: http.MethodPost, Name: PostUserRequest},
   200  }