github.com/dcarley/cf-cli@v6.24.1-0.20170220111324-4225ff346898+incompatible/plugin/plugin_examples/CHANGELOG.md (about)

     1  [Go here for documentation of the plugin API](https://github.com/cloudfoundry/cli/blob/master/plugin/plugin_examples/DOC.md)
     2  
     3  # Changes in v6.24.0
     4  - API `LoggregatorEndpoint()` is deprecated and now always returns the empty string. Use `DopplerEndpoint()` instead to obtain logs.
     5  
     6  # Changes in v6.17.0
     7  - `-v` is now a global flag to enable verbose logging of API calls, equivalent to `CF_TRACE=true`. This means that the `-v` flag will no longer be passed to plugins.
     8  
     9  # Changes in v6.14.0
    10  - API `AccessToken()` now provides a refreshed o-auth token.
    11  - [Examples](https://github.com/cloudfoundry/cli/tree/master/plugin/plugin_examples#test-driven-development-tdd) on how to use fake `CliConnection` and test RPC server for TDD development.
    12  - Fix Plugin API file descriptors leakage.
    13  - Fix bug where some CLI versions does not respect `PluginMetadata.MinCliVersion`.
    14  - The field `PackageUpdatedAt` returned by `GetApp()` API is now populated.
    15  
    16  # Changes in v6.12.0
    17  - New API:
    18  ```go
    19  GetApp(string) (plugin_models.GetAppModel, error)
    20  GetApps() ([]plugin_models.GetAppsModel, error)
    21  GetOrgs() ([]plugin_models.GetOrgs_Model, error)
    22  GetSpaces() ([]plugin_models.GetSpaces_Model, error)
    23  GetOrgUsers(string, ...string) ([]plugin_models.GetOrgUsers_Model, error)
    24  GetSpaceUsers(string, string) ([]plugin_models.GetSpaceUsers_Model, error)
    25  GetServices() ([]plugin_models.GetServices_Model, error)
    26  GetService(string) (plugin_models.GetService_Model, error)
    27  GetOrg(string) (plugin_models.GetOrg_Model, error)
    28  GetSpace(string) (plugin_models.GetSpace_Model, error)
    29  ```
    30  - Allow minimum CLI version required to be specified in plugin. Example:
    31  ```go
    32  func (c *cmd) GetMetadata() plugin.PluginMetadata {
    33  	return plugin.PluginMetadata{
    34  		Name: "Test1",
    35  		MinCliVersion: plugin.VersionType{
    36  			Major: 6,
    37  			Minor: 12,
    38  			Build: 0,
    39  		},
    40  	}
    41  }
    42  ```
    43  
    44  # Changes in v6.11.2
    45  Added the following commands to cli_connection.go:
    46  ```go
    47    - GetCurrentOrg()  
    48    - GetCurrentSpace()  
    49    - Username()  
    50    - UserEmail()  
    51    - UserGuid()  
    52    - HasOrganization()  
    53    - HasSpace()  
    54    - IsLoggedIn()  
    55    - IsSSLDisabled()  
    56    - ApiEndpoint()  
    57    - HasAPIEndpoint()  
    58    - ApiVersion()  
    59    - LoggregatorEndpoint()  
    60    - DopplerEndpoint()  
    61    - AccessToken()  
    62  ```
    63  
    64  # Changes in v6.11.0
    65  -Plugins now have a hook-in that is called when the plugin is uninstalled, allowing cleanup of files.
    66  
    67  # Changes in v6.10.0
    68  [CF-Community Plugin Repository](https://github.com/cloudfoundry-incubator/cli-plugin-repo) introduced.
    69  - Plugin developers can submit any open-source plugins
    70  - Plugins in the community repo can be browsed and installed from the CLI
    71  
    72  # Changes in v6.9.0
    73  - Plugins can now have versions, i.e. 1.2.3, [code example](https://github.com/cloudfoundry/cli/blob/master/plugin/plugin_examples/basic_plugin.go)
    74  - `cf plugins` now displays plugin versions
    75  - `-h` and `--help` flags work with plugin commands. e.g. `cf <plugin-command> -h`. [code example](https://github.com/cloudfoundry/cli/blob/master/plugin/plugin_examples/echo.go)
    76  - Allow `cf help <plugin-command>`
    77  
    78  # Changes in v6.8.0
    79  - Plugin commands can now have aliases
    80  - Help text for plugins now listed in 'cf plugins'
    81  
    82  # Changes in v6.7.0
    83  - Plugins introduced