update for v1.0.0 of the api spec

README.md

@@ -2,13 +2,13 @@
 
 CollectionsClient - the Ruby gem for the RDA Collections API
 
-API Strawman for RDA Research Data Collections WG
+The RDA Collections API Recommendation is a unified model and interface specification for CRUD operations on data collections, with particular observance of persistent identification and typing aspects. The recommendation allows building collections within diverse domains and then sharing or expanding them across disciplines.
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 1.0.0
 - Package version: 1.0.0
-- Build date: 2017-07-31T09:30:06.774-04:00
+- Build date: 2017-08-29T09:09:42.123-04:00
 - Build package: class io.swagger.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -65,7 +65,7 @@ opts = {
 }
 
 begin
-  #Get a list of all collections
+  #Get a list of all collections provided by this service. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body.
   result = api_instance.collections_get(opts)
   p result
 rescue CollectionsClient::ApiError => e
@@ -80,25 +80,25 @@ All URIs are relative to *https://api.example.org/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
-*CollectionsClient::CollectionsApi* | [**collections_get**](docs/CollectionsApi.md#collections_get) | **GET** /collections | Get a list of all collections
-*CollectionsClient::CollectionsApi* | [**collections_id_capabilities_get**](docs/CollectionsApi.md#collections_id_capabilities_get) | **GET** /collections/{id}/capabilities | Get the capabilities of this collection
-*CollectionsClient::CollectionsApi* | [**collections_id_delete**](docs/CollectionsApi.md#collections_id_delete) | **DELETE** /collections/{id} | Delete a collection
-*CollectionsClient::CollectionsApi* | [**collections_id_get**](docs/CollectionsApi.md#collections_id_get) | **GET** /collections/{id} | Get the properties of a specific collection.
-*CollectionsClient::CollectionsApi* | [**collections_id_ops_find_match_post**](docs/CollectionsApi.md#collections_id_ops_find_match_post) | **POST** /collections/{id}/ops/findMatch | Find member objects in a collection which match the supplied member object
-*CollectionsClient::CollectionsApi* | [**collections_id_ops_flatten_get**](docs/CollectionsApi.md#collections_id_ops_flatten_get) | **GET** /collections/{id}/ops/flatten | Flattens the collection
-*CollectionsClient::CollectionsApi* | [**collections_id_ops_intersection_other_id_get**](docs/CollectionsApi.md#collections_id_ops_intersection_other_id_get) | **GET** /collections/{id}/ops/intersection/{otherId} | Retrieve the members at the intersection of two collections
-*CollectionsClient::CollectionsApi* | [**collections_id_ops_union_other_id_get**](docs/CollectionsApi.md#collections_id_ops_union_other_id_get) | **GET** /collections/{id}/ops/union/{otherId} | Retrieve the union of two collections
-*CollectionsClient::CollectionsApi* | [**collections_id_put**](docs/CollectionsApi.md#collections_id_put) | **PUT** /collections/{id} | Update the properties of a Collection Object
-*CollectionsClient::CollectionsApi* | [**collections_post**](docs/CollectionsApi.md#collections_post) | **POST** /collections | Create a new collection.
-*CollectionsClient::MembersApi* | [**collections_id_members_get**](docs/MembersApi.md#collections_id_members_get) | **GET** /collections/{id}/members | Get the members in a collection
-*CollectionsClient::MembersApi* | [**collections_id_members_mid_delete**](docs/MembersApi.md#collections_id_members_mid_delete) | **DELETE** /collections/{id}/members/{mid} | Remove a collection member item.
-*CollectionsClient::MembersApi* | [**collections_id_members_mid_get**](docs/MembersApi.md#collections_id_members_mid_get) | **GET** /collections/{id}/members/{mid} | Get the properties of a member item in a collection
-*CollectionsClient::MembersApi* | [**collections_id_members_mid_properties_property_delete**](docs/MembersApi.md#collections_id_members_mid_properties_property_delete) | **DELETE** /collections/{id}/members/{mid}/properties/{property} | Delete a named property of a member item in a collection
-*CollectionsClient::MembersApi* | [**collections_id_members_mid_properties_property_get**](docs/MembersApi.md#collections_id_members_mid_properties_property_get) | **GET** /collections/{id}/members/{mid}/properties/{property} | Get a named property of a member item in a collection
-*CollectionsClient::MembersApi* | [**collections_id_members_mid_properties_property_put**](docs/MembersApi.md#collections_id_members_mid_properties_property_put) | **PUT** /collections/{id}/members/{mid}/properties/{property} | Update a named property of a member item in a collection
-*CollectionsClient::MembersApi* | [**collections_id_members_mid_put**](docs/MembersApi.md#collections_id_members_mid_put) | **PUT** /collections/{id}/members/{mid} | Update the properties of a collection member item.
-*CollectionsClient::MembersApi* | [**collections_id_members_post**](docs/MembersApi.md#collections_id_members_post) | **POST** /collections/{id}/members | Add a new member item to this collection
-*CollectionsClient::ServiceApi* | [**features_get**](docs/ServiceApi.md#features_get) | **GET** /features | Gets the service-level features.
+*CollectionsClient::CollectionsApi* | [**collections_get**](docs/CollectionsApi.md#collections_get) | **GET** /collections | Get a list of all collections provided by this service. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_capabilities_get**](docs/CollectionsApi.md#collections_id_capabilities_get) | **GET** /collections/{id}/capabilities | Get the capabilities of this collection. A successful request returns an HTTP 200 response code with a CollectionCapabilities object in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_delete**](docs/CollectionsApi.md#collections_id_delete) | **DELETE** /collections/{id} | Delete a collection. A successful request returns an HTTP 200 response code with an  empty response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_get**](docs/CollectionsApi.md#collections_id_get) | **GET** /collections/{id} | Get the properties of a specific collection. A successful request returns an HTTP 200 response code with the requested CollectionObject in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_ops_find_match_post**](docs/CollectionsApi.md#collections_id_ops_find_match_post) | **POST** /collections/{id}/ops/findMatch | Find member objects in a collection which match the supplied member object. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_ops_flatten_get**](docs/CollectionsApi.md#collections_id_ops_flatten_get) | **GET** /collections/{id}/ops/flatten | Flattens the collection. A successful request returns  an HTTP 200 response code with a MemberResultSet object in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_ops_intersection_other_id_get**](docs/CollectionsApi.md#collections_id_ops_intersection_other_id_get) | **GET** /collections/{id}/ops/intersection/{otherId} | Retrieve the members at the intersection of two collections. A successful request returns  an HTTP 200 response code with a CollectionResultSet object in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_ops_union_other_id_get**](docs/CollectionsApi.md#collections_id_ops_union_other_id_get) | **GET** /collections/{id}/ops/union/{otherId} | Retrieve the union of two collections. A successful request returns  an HTTP 200 response code with a CollectionResultSet object in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_id_put**](docs/CollectionsApi.md#collections_id_put) | **PUT** /collections/{id} | Update the properties of a Collection Object. A successful request returns an HTTP 200 response code with the updated CollectionObject in the response body.
+*CollectionsClient::CollectionsApi* | [**collections_post**](docs/CollectionsApi.md#collections_post) | **POST** /collections | Create one or more new collections. Successful requests will return an HTTP 201 response code with an array of the newly created CollectionObject(s) in the response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_get**](docs/MembersApi.md#collections_id_members_get) | **GET** /collections/{id}/members | Get the members in a collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_mid_delete**](docs/MembersApi.md#collections_id_members_mid_delete) | **DELETE** /collections/{id}/members/{mid} | Remove a collection member item. A successful request returns an HTTP 200 response code wiht an empty response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_mid_get**](docs/MembersApi.md#collections_id_members_mid_get) | **GET** /collections/{id}/members/{mid} | Get the properties of a member item in a collection. A successful request returns an HTTP 200 response code with a MemberItem in the response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_mid_properties_property_delete**](docs/MembersApi.md#collections_id_members_mid_properties_property_delete) | **DELETE** /collections/{id}/members/{mid}/properties/{property} | Delete a named property of a member item in a collection. A successful request returns an HTTP 200 response code and empty response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_mid_properties_property_get**](docs/MembersApi.md#collections_id_members_mid_properties_property_get) | **GET** /collections/{id}/members/{mid}/properties/{property} | Get a named property of a member item in a collection. A successful request returns an HTTP 200 response code and the requested MemberItem in teh response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_mid_properties_property_put**](docs/MembersApi.md#collections_id_members_mid_properties_property_put) | **PUT** /collections/{id}/members/{mid}/properties/{property} | Update a named property of a member item in a collection. A successful request returns an HTTP 200 response code and the updated MemberItem in the response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_mid_put**](docs/MembersApi.md#collections_id_members_mid_put) | **PUT** /collections/{id}/members/{mid} | Update the properties of a collection member item. A successful request returns an HTTP 200 response code with the updated MemberItem in the response body.
+*CollectionsClient::MembersApi* | [**collections_id_members_post**](docs/MembersApi.md#collections_id_members_post) | **POST** /collections/{id}/members | Add one or more new member items to this collection. A successful request returns an  HTTP 201 response code with an array of the new added MemberItems in the response body.
+*CollectionsClient::ServiceApi* | [**features_get**](docs/ServiceApi.md#features_get) | **GET** /features | Gets the service-level features. A successful request returns an HTTP 200 response code with the ServiceFeatures object in the response body.
 
 
 ## Documentation for Models

docs/CollectionCapabilities.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **appends_to_end** | **BOOLEAN** | For an ordered collection, indicates that new items are appended to the end rather than insertable at a specified, possibly invalid, index points. Only valid if isOrdered is true. | [default to true]
 **supports_roles** | **BOOLEAN** | Indicates whether the collection supports assigning roles to its member items. Available roles are determined by the Collection Model type. | [default to false]
 **membership_is_mutable** | **BOOLEAN** | Indicates whether collection membership mutable (i.e. whether members can be added and removed) | [default to true]
-**metadata_is_mutable** | **BOOLEAN** | Indicates whether collection metadata is mutable (i.e. can the metadata of this collection be changed) | [default to true]
+**properties_are_mutable** | **BOOLEAN** | Indicates whether collection properties are mutable (i.e. can the metadata of this collection be changed) | [default to true]
 **restricted_to_type** | **String** | If specified, indicates that the collection is made up of homogenous items of the specified type. Type should be specified using the PID of a registered Data Type or a controlled vocabulary. | 
 **max_length** | **Integer** | The maximum length of the Collection. -1 means length is not restricted. |