github.com/liamawhite/cli-with-i18n@v6.32.1-0.20171122084555-dede0a5c3448+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  	DeleteRouteRequest                     = "DeleteRoute"
    20  	DeleteRunningSecurityGroupSpaceRequest = "DeleteRunningSecurityGroupSpace"
    21  	DeleteSecurityGroupSpaceRequest        = "DeleteSecurityGroupSpace"
    22  	DeleteServiceBindingRequest            = "DeleteServiceBinding"
    23  	DeleteSpaceRequest                     = "DeleteSpaceRequest"
    24  	DeleteStagingSecurityGroupSpaceRequest = "DeleteStagingSecurityGroupSpace"
    25  	GetAppInstancesRequest                 = "GetAppInstances"
    26  	GetAppRequest                          = "GetApp"
    27  	GetAppRoutesRequest                    = "GetAppRoutes"
    28  	GetAppsRequest                         = "GetApps"
    29  	GetAppStatsRequest                     = "GetAppStats"
    30  	GetInfoRequest                         = "GetInfo"
    31  	GetJobRequest                          = "GetJob"
    32  	GetOrganizationPrivateDomainsRequest   = "GetOrganizationPrivateDomains"
    33  	GetOrganizationQuotaDefinitionRequest  = "GetOrganizationQuotaDefinition"
    34  	GetOrganizationRequest                 = "GetOrganization"
    35  	GetOrganizationsRequest                = "GetOrganizations"
    36  	GetPrivateDomainRequest                = "GetPrivateDomain"
    37  	GetRouteAppsRequest                    = "GetRouteApps"
    38  	GetRouteReservedRequest                = "GetRouteReserved"
    39  	GetRouteReservedDeprecatedRequest      = "GetRouteReservedDeprecated"
    40  	GetRouteRouteMappingsRequest           = "GetRouteRouteMappings"
    41  	GetRoutesRequest                       = "GetRoutes"
    42  	GetSecurityGroupRunningSpacesRequest   = "GetSecurityGroupRunningSpaces"
    43  	GetSecurityGroupsRequest               = "GetSecurityGroups"
    44  	GetSecurityGroupStagingSpacesRequest   = "GetSecurityGroupStagingSpaces"
    45  	GetServiceBindingsRequest              = "GetServiceBindings"
    46  	GetServiceInstanceRequest              = "GetServiceInstance"
    47  	GetServiceInstancesRequest             = "GetServiceInstances"
    48  	GetSharedDomainRequest                 = "GetSharedDomain"
    49  	GetSharedDomainsRequest                = "GetSharedDomains"
    50  	GetSpaceQuotaDefinitionRequest         = "GetSpaceQuotaDefinition"
    51  	GetSpaceRoutesRequest                  = "GetSpaceRoutes"
    52  	GetSpaceRunningSecurityGroupsRequest   = "GetSpaceRunningSecurityGroups"
    53  	GetSpaceServiceInstancesRequest        = "GetSpaceServiceInstances"
    54  	GetSpacesRequest                       = "GetSpaces"
    55  	GetSpaceStagingSecurityGroupsRequest   = "GetSpaceStagingSecurityGroups"
    56  	GetStackRequest                        = "GetStack"
    57  	GetStacksRequest                       = "GetStacks"
    58  	GetUsersRequest                        = "GetUsers"
    59  	PostAppRequest                         = "PostApp"
    60  	PostAppRestageRequest                  = "PostAppRestage"
    61  	PostRouteRequest                       = "PostRoute"
    62  	PostServiceBindingRequest              = "PostServiceBinding"
    63  	PostUserRequest                        = "PostUser"
    64  	PutAppBitsRequest                      = "PutAppBits"
    65  	PutAppRequest                          = "PutApp"
    66  	PutBindRouteAppRequest                 = "PutBindRouteApp"
    67  	PutResourceMatch                       = "PutResourceMatch"
    68  	PutRunningSecurityGroupSpaceRequest    = "PutRunningSecurityGroupSpace"
    69  	PutStagingSecurityGroupSpaceRequest    = "PutStagingSecurityGroupSpace"
    70  )
    71  
    72  // APIRoutes is a list of routes used by the rata library to construct request
    73  // URLs.
    74  var APIRoutes = rata.Routes{
    75  	{Path: "/v2/apps", Method: http.MethodGet, Name: GetAppsRequest},
    76  	{Path: "/v2/apps", Method: http.MethodPost, Name: PostAppRequest},
    77  	{Path: "/v2/apps/:app_guid", Method: http.MethodGet, Name: GetAppRequest},
    78  	{Path: "/v2/apps/:app_guid", Method: http.MethodPut, Name: PutAppRequest},
    79  	{Path: "/v2/apps/:app_guid/bits", Method: http.MethodPut, Name: PutAppBitsRequest},
    80  	{Path: "/v2/apps/:app_guid/instances", Method: http.MethodGet, Name: GetAppInstancesRequest},
    81  	{Path: "/v2/apps/:app_guid/restage", Method: http.MethodPost, Name: PostAppRestageRequest},
    82  	{Path: "/v2/apps/:app_guid/routes", Method: http.MethodGet, Name: GetAppRoutesRequest},
    83  	{Path: "/v2/apps/:app_guid/stats", Method: http.MethodGet, Name: GetAppStatsRequest},
    84  	{Path: "/v2/info", Method: http.MethodGet, Name: GetInfoRequest},
    85  	{Path: "/v2/jobs/:job_guid", Method: http.MethodGet, Name: GetJobRequest},
    86  	{Path: "/v2/organizations", Method: http.MethodGet, Name: GetOrganizationsRequest},
    87  	{Path: "/v2/organizations/:organization_guid", Method: http.MethodDelete, Name: DeleteOrganizationRequest},
    88  	{Path: "/v2/organizations/:organization_guid", Method: http.MethodGet, Name: GetOrganizationRequest},
    89  	{Path: "/v2/organizations/:organization_guid/private_domains", Method: http.MethodGet, Name: GetOrganizationPrivateDomainsRequest},
    90  	{Path: "/v2/private_domains/:private_domain_guid", Method: http.MethodGet, Name: GetPrivateDomainRequest},
    91  	{Path: "/v2/quota_definitions/:organization_quota_guid", Method: http.MethodGet, Name: GetOrganizationQuotaDefinitionRequest},
    92  	{Path: "/v2/resource_match", Method: http.MethodPut, Name: PutResourceMatch},
    93  	{Path: "/v2/routes", Method: http.MethodGet, Name: GetRoutesRequest},
    94  	{Path: "/v2/routes", Method: http.MethodPost, Name: PostRouteRequest},
    95  	{Path: "/v2/routes/:route_guid", Method: http.MethodDelete, Name: DeleteRouteRequest},
    96  	{Path: "/v2/routes/:route_guid/apps", Method: http.MethodGet, Name: GetRouteAppsRequest},
    97  	{Path: "/v2/routes/:route_guid/apps/:app_guid", Method: http.MethodPut, Name: PutBindRouteAppRequest},
    98  	{Path: "/v2/routes/:route_guid/route_mappings", Method: http.MethodGet, Name: GetRouteRouteMappingsRequest},
    99  	{Path: "/v2/routes/reserved/domain/:domain_guid", Method: http.MethodGet, Name: GetRouteReservedRequest},
   100  	{Path: "/v2/routes/reserved/domain/:domain_guid/host/:host", Method: http.MethodGet, Name: GetRouteReservedDeprecatedRequest},
   101  	{Path: "/v2/security_groups", Method: http.MethodGet, Name: GetSecurityGroupsRequest},
   102  	{Path: "/v2/security_groups/:security_group_guid/spaces", Method: http.MethodGet, Name: GetSecurityGroupRunningSpacesRequest},
   103  	{Path: "/v2/security_groups/:security_group_guid/spaces/:space_guid", Method: http.MethodDelete, Name: DeleteRunningSecurityGroupSpaceRequest},
   104  	{Path: "/v2/security_groups/:security_group_guid/spaces/:space_guid", Method: http.MethodPut, Name: PutRunningSecurityGroupSpaceRequest},
   105  	{Path: "/v2/security_groups/:security_group_guid/staging_spaces", Method: http.MethodGet, Name: GetSecurityGroupStagingSpacesRequest},
   106  	{Path: "/v2/security_groups/:security_group_guid/staging_spaces/:space_guid", Method: http.MethodDelete, Name: DeleteStagingSecurityGroupSpaceRequest},
   107  	{Path: "/v2/security_groups/:security_group_guid/staging_spaces/:space_guid", Method: http.MethodPut, Name: PutStagingSecurityGroupSpaceRequest},
   108  	{Path: "/v2/service_bindings", Method: http.MethodGet, Name: GetServiceBindingsRequest},
   109  	{Path: "/v2/service_bindings", Method: http.MethodPost, Name: PostServiceBindingRequest},
   110  	{Path: "/v2/service_bindings/:service_binding_guid", Method: http.MethodDelete, Name: DeleteServiceBindingRequest},
   111  	{Path: "/v2/service_instances", Method: http.MethodGet, Name: GetServiceInstancesRequest},
   112  	{Path: "/v2/service_instances/:service_instance_guid", Method: http.MethodGet, Name: GetServiceInstanceRequest},
   113  	{Path: "/v2/shared_domains", Method: http.MethodGet, Name: GetSharedDomainsRequest},
   114  	{Path: "/v2/shared_domains/:shared_domain_guid", Method: http.MethodGet, Name: GetSharedDomainRequest},
   115  	{Path: "/v2/space_quota_definitions/:space_quota_guid", Method: http.MethodGet, Name: GetSpaceQuotaDefinitionRequest},
   116  	{Path: "/v2/spaces", Method: http.MethodGet, Name: GetSpacesRequest},
   117  	{Path: "/v2/spaces/:guid/service_instances", Method: http.MethodGet, Name: GetSpaceServiceInstancesRequest},
   118  	{Path: "/v2/spaces/:space_guid", Method: http.MethodDelete, Name: DeleteSpaceRequest},
   119  	{Path: "/v2/spaces/:space_guid/routes", Method: http.MethodGet, Name: GetSpaceRoutesRequest},
   120  	{Path: "/v2/spaces/:space_guid/security_groups", Method: http.MethodGet, Name: GetSpaceRunningSecurityGroupsRequest},
   121  	{Path: "/v2/spaces/:space_guid/staging_security_groups", Method: http.MethodGet, Name: GetSpaceStagingSecurityGroupsRequest},
   122  	{Path: "/v2/stacks", Method: http.MethodGet, Name: GetStacksRequest},
   123  	{Path: "/v2/stacks/:stack_guid", Method: http.MethodGet, Name: GetStackRequest},
   124  	{Path: "/v2/users", Method: http.MethodPost, Name: PostUserRequest},
   125  }