diff --git a/README.md b/README.md index f206112..5fd4275 100644 --- a/README.md +++ b/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 diff --git a/docs/CollectionCapabilities.md b/docs/CollectionCapabilities.md index c25e2e7..7c860a5 100644 --- a/docs/CollectionCapabilities.md +++ b/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. | diff --git a/docs/CollectionsApi.md b/docs/CollectionsApi.md index 0e3c904..6e66e3b 100644 --- a/docs/CollectionsApi.md +++ b/docs/CollectionsApi.md @@ -4,22 +4,22 @@ All URIs are relative to *https://api.example.org/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**collections_get**](CollectionsApi.md#collections_get) | **GET** /collections | Get a list of all collections -[**collections_id_capabilities_get**](CollectionsApi.md#collections_id_capabilities_get) | **GET** /collections/{id}/capabilities | Get the capabilities of this collection -[**collections_id_delete**](CollectionsApi.md#collections_id_delete) | **DELETE** /collections/{id} | Delete a collection -[**collections_id_get**](CollectionsApi.md#collections_id_get) | **GET** /collections/{id} | Get the properties of a specific collection. -[**collections_id_ops_find_match_post**](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 -[**collections_id_ops_flatten_get**](CollectionsApi.md#collections_id_ops_flatten_get) | **GET** /collections/{id}/ops/flatten | Flattens the collection -[**collections_id_ops_intersection_other_id_get**](CollectionsApi.md#collections_id_ops_intersection_other_id_get) | **GET** /collections/{id}/ops/intersection/{otherId} | Retrieve the members at the intersection of two collections -[**collections_id_ops_union_other_id_get**](CollectionsApi.md#collections_id_ops_union_other_id_get) | **GET** /collections/{id}/ops/union/{otherId} | Retrieve the union of two collections -[**collections_id_put**](CollectionsApi.md#collections_id_put) | **PUT** /collections/{id} | Update the properties of a Collection Object -[**collections_post**](CollectionsApi.md#collections_post) | **POST** /collections | Create a new collection. +[**collections_get**](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. +[**collections_id_capabilities_get**](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. +[**collections_id_delete**](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. +[**collections_id_get**](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. +[**collections_id_ops_find_match_post**](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. +[**collections_id_ops_flatten_get**](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. +[**collections_id_ops_intersection_other_id_get**](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. +[**collections_id_ops_union_other_id_get**](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. +[**collections_id_put**](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. +[**collections_post**](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. # **collections_get** > CollectionResultSet collections_get(opts) -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. This request returns a list of the collections provided by this service. This may be a complete list, or if the service features include support for pagination, the cursors in the response may be used to iterate backwards and forwards through pages of partial results. Query parameters may be used to supply filtering criteria for the response. When combining filters of different types, the boolean AND will be used. When combining multiple instances of filters of the same type, the boolean OR will be used. @@ -38,7 +38,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 @@ -73,7 +73,7 @@ No authorization required # **collections_id_capabilities_get** > CollectionCapabilities collections_id_capabilities_get(id) -Get the capabilities of this collection +Get the capabilities of this collection. A successful request returns an HTTP 200 response code with a CollectionCapabilities object in the response body. This request returns the capabilities metadata for the collection identified by the supplied id. The collection capabilities describe the actions and operations that are available for this collection. @@ -88,7 +88,7 @@ id = "id_example" # String | Identifier for the collection begin - #Get the capabilities of this collection + #Get the capabilities of this collection. A successful request returns an HTTP 200 response code with a CollectionCapabilities object in the response body. result = api_instance.collections_id_capabilities_get(id) p result rescue CollectionsClient::ApiError => e @@ -120,7 +120,7 @@ No authorization required # **collections_id_delete** > collections_id_delete(id) -Delete a collection +Delete a collection. A successful request returns an HTTP 200 response code with an empty response body. This request deletes the collection idenified by the provided id from the collection store. The response may differ depending upon whether or not the service features include support for synchronous actions. @@ -140,7 +140,7 @@ id = "id_example" # String | identifier for the collection begin - #Delete a collection + #Delete a collection. A successful request returns an HTTP 200 response code with an empty response body. api_instance.collections_id_delete(id) rescue CollectionsClient::ApiError => e puts "Exception when calling CollectionsApi->collections_id_delete: #{e}" @@ -171,7 +171,7 @@ nil (empty response body) # **collections_id_get** > CollectionObject collections_id_get(id) -Get the properties of a specific collection. +Get the properties of a specific collection. A successful request returns an HTTP 200 response code with the requested CollectionObject in the response body. This request returns the Collection Object Properties for the collection identified by the provided id. @@ -186,7 +186,7 @@ id = "id_example" # String | Identifier for the collection begin - #Get the properties of a specific collection. + #Get the properties of a specific collection. A successful request returns an HTTP 200 response code with the requested CollectionObject in the response body. result = api_instance.collections_id_get(id) p result rescue CollectionsClient::ApiError => e @@ -218,7 +218,7 @@ No authorization required # **collections_id_ops_find_match_post** > MemberResultSet collections_id_ops_find_match_post(id, member_properties, opts) -Find member objects in a collection which match the supplied member object +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. This request accepts as input the complete or partial properties of a member object and returns a ResultSet containing any objects which were deemed to 'match' the supplied properties among the members of the identified collection. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. @@ -243,7 +243,7 @@ opts = { } begin - #Find member objects in a collection which match the supplied member object + #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. result = api_instance.collections_id_ops_find_match_post(id, member_properties, opts) p result rescue CollectionsClient::ApiError => e @@ -277,7 +277,7 @@ Name | Type | Description | Notes # **collections_id_ops_flatten_get** > MemberResultSet collections_id_ops_flatten_get(id, opts) -Flattens the collection +Flattens the collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. This request returns a resultset which is a flattened representation of a collection of collections into a single collection. @@ -300,7 +300,7 @@ opts = { } begin - #Flattens the collection + #Flattens the collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. result = api_instance.collections_id_ops_flatten_get(id, opts) p result rescue CollectionsClient::ApiError => e @@ -333,7 +333,7 @@ Name | Type | Description | Notes # **collections_id_ops_intersection_other_id_get** > MemberResultSet collections_id_ops_intersection_other_id_get(id, other_id, opts) -Retrieve the members at the intersection of two collections +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. This request returns a resultset containing the members at the intersection of two collections. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. The response may be an empty set. @@ -358,7 +358,7 @@ opts = { } begin - #Retrieve the members at the intersection of two collections + #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. result = api_instance.collections_id_ops_intersection_other_id_get(id, other_id, opts) p result rescue CollectionsClient::ApiError => e @@ -392,7 +392,7 @@ Name | Type | Description | Notes # **collections_id_ops_union_other_id_get** > MemberResultSet collections_id_ops_union_other_id_get(id, other_id, opts) -Retrieve the union of two collections +Retrieve the union of two collections. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body. This request returns a resultset containing the members at the union of two collections. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. The response may be an empty set. @@ -417,7 +417,7 @@ opts = { } begin - #Retrieve the union of two collections + #Retrieve the union of two collections. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body. result = api_instance.collections_id_ops_union_other_id_get(id, other_id, opts) p result rescue CollectionsClient::ApiError => e @@ -451,7 +451,7 @@ Name | Type | Description | Notes # **collections_id_put** > CollectionObject collections_id_put(id, content) -Update the properties of a Collection Object +Update the properties of a Collection Object. A successful request returns an HTTP 200 response code with the updated CollectionObject in the response body. This request updates the properties of the collection identified by the provided id. The updated collection properties must be supplied in the body of the request. The response may differ depending upon whether or not the service features include support for syncrhonous actions. @@ -473,7 +473,7 @@ content = CollectionsClient::CollectionObject.new # CollectionObject | The prope begin - #Update the properties of a Collection Object + #Update the properties of a Collection Object. A successful request returns an HTTP 200 response code with the updated CollectionObject in the response body. result = api_instance.collections_id_put(id, content) p result rescue CollectionsClient::ApiError => e @@ -506,9 +506,9 @@ Name | Type | Description | Notes # **collections_post** > Array<CollectionObject> collections_post(content) -Create a new collection. +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. -This request adds a new collection to the collection store. The Collection Object properties must be supplied in the body of the request. +This request adds one or more new collections to the collection store. The Collection Objects to be created must be supplied in the body of the request. ### Example ```ruby @@ -526,7 +526,7 @@ content = [CollectionsClient::CollectionObject.new] # Array | begin - #Create a new collection. + #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. result = api_instance.collections_post(content) p result rescue CollectionsClient::ApiError => e diff --git a/docs/MembersApi.md b/docs/MembersApi.md index a37223c..fe52e13 100644 --- a/docs/MembersApi.md +++ b/docs/MembersApi.md @@ -4,20 +4,20 @@ All URIs are relative to *https://api.example.org/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**collections_id_members_get**](MembersApi.md#collections_id_members_get) | **GET** /collections/{id}/members | Get the members in a collection -[**collections_id_members_mid_delete**](MembersApi.md#collections_id_members_mid_delete) | **DELETE** /collections/{id}/members/{mid} | Remove a collection member item. -[**collections_id_members_mid_get**](MembersApi.md#collections_id_members_mid_get) | **GET** /collections/{id}/members/{mid} | Get the properties of a member item in a collection -[**collections_id_members_mid_properties_property_delete**](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 -[**collections_id_members_mid_properties_property_get**](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 -[**collections_id_members_mid_properties_property_put**](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 -[**collections_id_members_mid_put**](MembersApi.md#collections_id_members_mid_put) | **PUT** /collections/{id}/members/{mid} | Update the properties of a collection member item. -[**collections_id_members_post**](MembersApi.md#collections_id_members_post) | **POST** /collections/{id}/members | Add a new member item to this collection +[**collections_id_members_get**](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. +[**collections_id_members_mid_delete**](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. +[**collections_id_members_mid_get**](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. +[**collections_id_members_mid_properties_property_delete**](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. +[**collections_id_members_mid_properties_property_get**](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. +[**collections_id_members_mid_properties_property_put**](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. +[**collections_id_members_mid_put**](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. +[**collections_id_members_post**](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. # **collections_id_members_get** > MemberResultSet collections_id_members_get(id, opts) -Get the members in a collection +Get the members in a collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. This request returns the list of members contained in a collection. This may be a complete list, or if the service features include support for pagination, the cursors in the response may be used to iterate backwards and forwards through pages of partial results. Query parameters may be used to supply filtering criteria for the response. When combining filters of different types, the boolean AND will be used. When combining multiple instances of filters of the same type, the boolean OR will be used. @@ -40,7 +40,7 @@ opts = { } begin - #Get the members in a collection + #Get the members in a collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. result = api_instance.collections_id_members_get(id, opts) p result rescue CollectionsClient::ApiError => e @@ -78,7 +78,7 @@ No authorization required # **collections_id_members_mid_delete** > collections_id_members_mid_delete(id, mid) -Remove a collection member item. +Remove a collection member item. A successful request returns an HTTP 200 response code wiht an empty response body. Removes a member item from a collection. The response may differ depending upon whether or not the service features include support for asynchronous actions. @@ -100,7 +100,7 @@ mid = "mid_example" # String | Identifier for the collection member begin - #Remove a collection member item. + #Remove a collection member item. A successful request returns an HTTP 200 response code wiht an empty response body. api_instance.collections_id_members_mid_delete(id, mid) rescue CollectionsClient::ApiError => e puts "Exception when calling MembersApi->collections_id_members_mid_delete: #{e}" @@ -132,7 +132,7 @@ nil (empty response body) # **collections_id_members_mid_get** > MemberItem collections_id_members_mid_get(id, mid) -Get the properties of a member item in a collection +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. This request retrieves the properties of a specific member item from a collection @@ -149,7 +149,7 @@ mid = "mid_example" # String | Identifier for the collection member item. begin - #Get the properties of a member item in a collection + #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. result = api_instance.collections_id_members_mid_get(id, mid) p result rescue CollectionsClient::ApiError => e @@ -182,7 +182,7 @@ No authorization required # **collections_id_members_mid_properties_property_delete** > collections_id_members_mid_properties_property_delete(id, mid, property) -Delete a named property of a member item in a collection +Delete a named property of a member item in a collection. A successful request returns an HTTP 200 response code and empty response body. This request deletes a specific named property of a specific member item from a collection @@ -201,7 +201,7 @@ property = "property_example" # String | the name of a property to update begin - #Delete a named property of a member item in a collection + #Delete a named property of a member item in a collection. A successful request returns an HTTP 200 response code and empty response body. api_instance.collections_id_members_mid_properties_property_delete(id, mid, property) rescue CollectionsClient::ApiError => e puts "Exception when calling MembersApi->collections_id_members_mid_properties_property_delete: #{e}" @@ -234,7 +234,7 @@ No authorization required # **collections_id_members_mid_properties_property_get** > MemberItem collections_id_members_mid_properties_property_get(id, mid, property) -Get a named property of a member item in a collection +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. This request retrieves a specific named property of a specific member item from a collection @@ -253,7 +253,7 @@ property = "property_example" # String | the name of a property to retrieve (e.g begin - #Get a named property of a member item in a collection + #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. result = api_instance.collections_id_members_mid_properties_property_get(id, mid, property) p result rescue CollectionsClient::ApiError => e @@ -287,7 +287,7 @@ No authorization required # **collections_id_members_mid_properties_property_put** > MemberItem collections_id_members_mid_properties_property_put(id, mid, property, content) -Update a named property of a member item in a collection +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. This request updates a specific named property of a specific member item from a collection @@ -308,7 +308,7 @@ content = "content_example" # String | new property value begin - #Update a named property of a member item in a collection + #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. result = api_instance.collections_id_members_mid_properties_property_put(id, mid, property, content) p result rescue CollectionsClient::ApiError => e @@ -343,7 +343,7 @@ No authorization required # **collections_id_members_mid_put** > MemberItem collections_id_members_mid_put(id, mid, content) -Update the properties of a collection member item. +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. This request updates the properties of a collection member item. The updated member properties must be supplied in the body of the request. The response may differ depending upon whether or not the service features include support for asynchronous actions. @@ -367,7 +367,7 @@ content = CollectionsClient::CollectionObject.new # CollectionObject | collectio begin - #Update the properties of a collection member item. + #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. result = api_instance.collections_id_members_mid_put(id, mid, content) p result rescue CollectionsClient::ApiError => e @@ -401,7 +401,7 @@ Name | Type | Description | Notes # **collections_id_members_post** > Array<MemberItem> collections_id_members_post(id, content) -Add a new member item to this collection +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. This request adds a new member item to a collection. If the service features include support for PID assignment to member items, then if no id is supplied for the item it will be assigned automatically. @@ -423,7 +423,7 @@ content = [CollectionsClient::MemberItem.new] # Array | The properti begin - #Add a new member item to this collection + #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. result = api_instance.collections_id_members_post(id, content) p result rescue CollectionsClient::ApiError => e diff --git a/docs/ServiceApi.md b/docs/ServiceApi.md index 144e3dc..b6695e6 100644 --- a/docs/ServiceApi.md +++ b/docs/ServiceApi.md @@ -4,13 +4,13 @@ All URIs are relative to *https://api.example.org/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**features_get**](ServiceApi.md#features_get) | **GET** /features | Gets the service-level features. +[**features_get**](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. # **features_get** > ServiceFeatures features_get -Gets the service-level features. +Gets the service-level features. A successful request returns an HTTP 200 response code with the ServiceFeatures object in the response body. This request returns the service-level features. Examples of service-level features might include whether or not the service supports assignment of PIDs for collection members, whether it supports pagination and cursors, whether it enforces access controls, etc. @@ -22,7 +22,7 @@ require 'rda-collections-client' api_instance = CollectionsClient::ServiceApi.new begin - #Gets the service-level features. + #Gets the service-level features. A successful request returns an HTTP 200 response code with the ServiceFeatures object in the response body. result = api_instance.features_get p result rescue CollectionsClient::ApiError => e diff --git a/lib/rda-collections-client.rb b/lib/rda-collections-client.rb index 3f77cca..72d3f37 100644 --- a/lib/rda-collections-client.rb +++ b/lib/rda-collections-client.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/api/collections_api.rb b/lib/rda-collections-client/api/collections_api.rb index 5f6a9fa..72d42d1 100644 --- a/lib/rda-collections-client/api/collections_api.rb +++ b/lib/rda-collections-client/api/collections_api.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 @@ -31,7 +31,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end - # 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. # This request returns a list of the collections provided by this service. This may be a complete list, or if the service features include support for pagination, the cursors in the response may be used to iterate backwards and forwards through pages of partial results. Query parameters may be used to supply filtering criteria for the response. When combining filters of different types, the boolean AND will be used. When combining multiple instances of filters of the same type, the boolean OR will be used. # @param [Hash] opts the optional parameters # @option opts [String] :f_model_type Filter response by the modelType property of the collection. @@ -44,7 +44,7 @@ def collections_get(opts = {}) return data end - # 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. # This request returns a list of the collections provided by this service. This may be a complete list, or if the service features include support for pagination, the cursors in the response may be used to iterate backwards and forwards through pages of partial results. Query parameters may be used to supply filtering criteria for the response. When combining filters of different types, the boolean AND will be used. When combining multiple instances of filters of the same type, the boolean OR will be used. # @param [Hash] opts the optional parameters # @option opts [String] :f_model_type Filter response by the modelType property of the collection. @@ -96,7 +96,7 @@ def collections_get_with_http_info(opts = {}) return data, status_code, headers end - # Get the capabilities of this collection + # Get the capabilities of this collection. A successful request returns an HTTP 200 response code with a CollectionCapabilities object in the response body. # This request returns the capabilities metadata for the collection identified by the supplied id. The collection capabilities describe the actions and operations that are available for this collection. # @param id Identifier for the collection # @param [Hash] opts the optional parameters @@ -106,7 +106,7 @@ def collections_id_capabilities_get(id, opts = {}) return data end - # Get the capabilities of this collection + # Get the capabilities of this collection. A successful request returns an HTTP 200 response code with a CollectionCapabilities object in the response body. # This request returns the capabilities metadata for the collection identified by the supplied id. The collection capabilities describe the actions and operations that are available for this collection. # @param id Identifier for the collection # @param [Hash] opts the optional parameters @@ -153,7 +153,7 @@ def collections_id_capabilities_get_with_http_info(id, opts = {}) return data, status_code, headers end - # Delete a collection + # Delete a collection. A successful request returns an HTTP 200 response code with an empty response body. # This request deletes the collection idenified by the provided id from the collection store. The response may differ depending upon whether or not the service features include support for synchronous actions. # @param id identifier for the collection # @param [Hash] opts the optional parameters @@ -163,7 +163,7 @@ def collections_id_delete(id, opts = {}) return nil end - # Delete a collection + # Delete a collection. A successful request returns an HTTP 200 response code with an empty response body. # This request deletes the collection idenified by the provided id from the collection store. The response may differ depending upon whether or not the service features include support for synchronous actions. # @param id identifier for the collection # @param [Hash] opts the optional parameters @@ -209,7 +209,7 @@ def collections_id_delete_with_http_info(id, opts = {}) return data, status_code, headers end - # Get the properties of a specific collection. + # Get the properties of a specific collection. A successful request returns an HTTP 200 response code with the requested CollectionObject in the response body. # This request returns the Collection Object Properties for the collection identified by the provided id. # @param id Identifier for the collection # @param [Hash] opts the optional parameters @@ -219,7 +219,7 @@ def collections_id_get(id, opts = {}) return data end - # Get the properties of a specific collection. + # Get the properties of a specific collection. A successful request returns an HTTP 200 response code with the requested CollectionObject in the response body. # This request returns the Collection Object Properties for the collection identified by the provided id. # @param id Identifier for the collection # @param [Hash] opts the optional parameters @@ -266,7 +266,7 @@ def collections_id_get_with_http_info(id, opts = {}) return data, status_code, headers end - # Find member objects in a collection which match the supplied member object + # 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. # This request accepts as input the complete or partial properties of a member object and returns a ResultSet containing any objects which were deemed to 'match' the supplied properties among the members of the identified collection. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. # @param id identifier for the collection # @param member_properties the member item properties to use when matching @@ -278,7 +278,7 @@ def collections_id_ops_find_match_post(id, member_properties, opts = {}) return data end - # Find member objects in a collection which match the supplied member object + # 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. # This request accepts as input the complete or partial properties of a member object and returns a ResultSet containing any objects which were deemed to 'match' the supplied properties among the members of the identified collection. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. # @param id identifier for the collection # @param member_properties the member item properties to use when matching @@ -330,7 +330,7 @@ def collections_id_ops_find_match_post_with_http_info(id, member_properties, opt return data, status_code, headers end - # Flattens the collection + # Flattens the collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. # This request returns a resultset which is a flattened representation of a collection of collections into a single collection. # @param id Identifier for the collection to be flattened # @param [Hash] opts the optional parameters @@ -341,7 +341,7 @@ def collections_id_ops_flatten_get(id, opts = {}) return data end - # Flattens the collection + # Flattens the collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. # This request returns a resultset which is a flattened representation of a collection of collections into a single collection. # @param id Identifier for the collection to be flattened # @param [Hash] opts the optional parameters @@ -390,7 +390,7 @@ def collections_id_ops_flatten_get_with_http_info(id, opts = {}) return data, status_code, headers end - # Retrieve the members at the intersection of two collections + # 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. # This request returns a resultset containing the members at the intersection of two collections. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. The response may be an empty set. # @param id Identifier for the first collection in the operation # @param other_id Identifier for the second collection in the operation @@ -402,7 +402,7 @@ def collections_id_ops_intersection_other_id_get(id, other_id, opts = {}) return data end - # Retrieve the members at the intersection of two collections + # 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. # This request returns a resultset containing the members at the intersection of two collections. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. The response may be an empty set. # @param id Identifier for the first collection in the operation # @param other_id Identifier for the second collection in the operation @@ -454,7 +454,7 @@ def collections_id_ops_intersection_other_id_get_with_http_info(id, other_id, op return data, status_code, headers end - # Retrieve the union of two collections + # Retrieve the union of two collections. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body. # This request returns a resultset containing the members at the union of two collections. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. The response may be an empty set. # @param id Identifier for the first collection in the operation # @param other_id Identifier for the second collection in the operation @@ -466,7 +466,7 @@ def collections_id_ops_union_other_id_get(id, other_id, opts = {}) return data end - # Retrieve the union of two collections + # Retrieve the union of two collections. A successful request returns an HTTP 200 response code with a CollectionResultSet object in the response body. # This request returns a resultset containing the members at the union of two collections. If the service features include support for pagination, a cursor may be supplied to iterate backwards and forwards through paged results from prior executions of this query. The response may be an empty set. # @param id Identifier for the first collection in the operation # @param other_id Identifier for the second collection in the operation @@ -518,7 +518,7 @@ def collections_id_ops_union_other_id_get_with_http_info(id, other_id, opts = {} return data, status_code, headers end - # Update the properties of a Collection Object + # Update the properties of a Collection Object. A successful request returns an HTTP 200 response code with the updated CollectionObject in the response body. # This request updates the properties of the collection identified by the provided id. The updated collection properties must be supplied in the body of the request. The response may differ depending upon whether or not the service features include support for syncrhonous actions. # @param id Persistent identifier for the collection # @param content The properties of the collection to be updated. @@ -529,7 +529,7 @@ def collections_id_put(id, content, opts = {}) return data end - # Update the properties of a Collection Object + # Update the properties of a Collection Object. A successful request returns an HTTP 200 response code with the updated CollectionObject in the response body. # This request updates the properties of the collection identified by the provided id. The updated collection properties must be supplied in the body of the request. The response may differ depending upon whether or not the service features include support for syncrhonous actions. # @param id Persistent identifier for the collection # @param content The properties of the collection to be updated. @@ -579,8 +579,8 @@ def collections_id_put_with_http_info(id, content, opts = {}) return data, status_code, headers end - # Create a new collection. - # This request adds a new collection to the collection store. The Collection Object properties must be supplied in the body of the request. + # 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. + # This request adds one or more new collections to the collection store. The Collection Objects to be created must be supplied in the body of the request. # @param content The properties of the collection. # @param [Hash] opts the optional parameters # @return [Array] @@ -589,8 +589,8 @@ def collections_post(content, opts = {}) return data end - # Create a new collection. - # This request adds a new collection to the collection store. The Collection Object properties must be supplied in the body of the request. + # 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. + # This request adds one or more new collections to the collection store. The Collection Objects to be created must be supplied in the body of the request. # @param content The properties of the collection. # @param [Hash] opts the optional parameters # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers diff --git a/lib/rda-collections-client/api/members_api.rb b/lib/rda-collections-client/api/members_api.rb index c09d094..da3cbc2 100644 --- a/lib/rda-collections-client/api/members_api.rb +++ b/lib/rda-collections-client/api/members_api.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 @@ -31,7 +31,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end - # Get the members in a collection + # Get the members in a collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. # This request returns the list of members contained in a collection. This may be a complete list, or if the service features include support for pagination, the cursors in the response may be used to iterate backwards and forwards through pages of partial results. Query parameters may be used to supply filtering criteria for the response. When combining filters of different types, the boolean AND will be used. When combining multiple instances of filters of the same type, the boolean OR will be used. # @param id Identifier for the collection # @param [Hash] opts the optional parameters @@ -47,7 +47,7 @@ def collections_id_members_get(id, opts = {}) return data end - # Get the members in a collection + # Get the members in a collection. A successful request returns an HTTP 200 response code with a MemberResultSet object in the response body. # This request returns the list of members contained in a collection. This may be a complete list, or if the service features include support for pagination, the cursors in the response may be used to iterate backwards and forwards through pages of partial results. Query parameters may be used to supply filtering criteria for the response. When combining filters of different types, the boolean AND will be used. When combining multiple instances of filters of the same type, the boolean OR will be used. # @param id Identifier for the collection # @param [Hash] opts the optional parameters @@ -106,7 +106,7 @@ def collections_id_members_get_with_http_info(id, opts = {}) return data, status_code, headers end - # Remove a collection member item. + # Remove a collection member item. A successful request returns an HTTP 200 response code wiht an empty response body. # Removes a member item from a collection. The response may differ depending upon whether or not the service features include support for asynchronous actions. # @param id Persistent identifier for the collection # @param mid Identifier for the collection member @@ -117,7 +117,7 @@ def collections_id_members_mid_delete(id, mid, opts = {}) return nil end - # Remove a collection member item. + # Remove a collection member item. A successful request returns an HTTP 200 response code wiht an empty response body. # Removes a member item from a collection. The response may differ depending upon whether or not the service features include support for asynchronous actions. # @param id Persistent identifier for the collection # @param mid Identifier for the collection member @@ -166,7 +166,7 @@ def collections_id_members_mid_delete_with_http_info(id, mid, opts = {}) return data, status_code, headers end - # Get the properties of a member item in a collection + # 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. # This request retrieves the properties of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -177,7 +177,7 @@ def collections_id_members_mid_get(id, mid, opts = {}) return data end - # Get the properties of a member item in a collection + # 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. # This request retrieves the properties of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -227,7 +227,7 @@ def collections_id_members_mid_get_with_http_info(id, mid, opts = {}) return data, status_code, headers end - # Delete a named property of a member item in a collection + # Delete a named property of a member item in a collection. A successful request returns an HTTP 200 response code and empty response body. # This request deletes a specific named property of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -239,7 +239,7 @@ def collections_id_members_mid_properties_property_delete(id, mid, property, opt return nil end - # Delete a named property of a member item in a collection + # Delete a named property of a member item in a collection. A successful request returns an HTTP 200 response code and empty response body. # This request deletes a specific named property of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -291,7 +291,7 @@ def collections_id_members_mid_properties_property_delete_with_http_info(id, mid return data, status_code, headers end - # Get a named property of a member item in a collection + # 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. # This request retrieves a specific named property of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -303,7 +303,7 @@ def collections_id_members_mid_properties_property_get(id, mid, property, opts = return data end - # Get a named property of a member item in a collection + # 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. # This request retrieves a specific named property of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -356,7 +356,7 @@ def collections_id_members_mid_properties_property_get_with_http_info(id, mid, p return data, status_code, headers end - # Update a named property of a member item in a collection + # 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. # This request updates a specific named property of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -369,7 +369,7 @@ def collections_id_members_mid_properties_property_put(id, mid, property, conten return data end - # Update a named property of a member item in a collection + # 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. # This request updates a specific named property of a specific member item from a collection # @param id Identifier for the collection # @param mid Identifier for the collection member item. @@ -425,7 +425,7 @@ def collections_id_members_mid_properties_property_put_with_http_info(id, mid, p return data, status_code, headers end - # Update the properties of a collection member item. + # 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. # This request updates the properties of a collection member item. The updated member properties must be supplied in the body of the request. The response may differ depending upon whether or not the service features include support for asynchronous actions. # @param id Identifier for the collection # @param mid Identifier for the collection member @@ -437,7 +437,7 @@ def collections_id_members_mid_put(id, mid, content, opts = {}) return data end - # Update the properties of a collection member item. + # 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. # This request updates the properties of a collection member item. The updated member properties must be supplied in the body of the request. The response may differ depending upon whether or not the service features include support for asynchronous actions. # @param id Identifier for the collection # @param mid Identifier for the collection member @@ -490,7 +490,7 @@ def collections_id_members_mid_put_with_http_info(id, mid, content, opts = {}) return data, status_code, headers end - # Add a new member item to this collection + # 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. # This request adds a new member item to a collection. If the service features include support for PID assignment to member items, then if no id is supplied for the item it will be assigned automatically. # @param id Identifier for the collection # @param content The properties of the member item to add to the collection. Id may be required. @@ -501,7 +501,7 @@ def collections_id_members_post(id, content, opts = {}) return data end - # Add a new member item to this collection + # 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. # This request adds a new member item to a collection. If the service features include support for PID assignment to member items, then if no id is supplied for the item it will be assigned automatically. # @param id Identifier for the collection # @param content The properties of the member item to add to the collection. Id may be required. diff --git a/lib/rda-collections-client/api/service_api.rb b/lib/rda-collections-client/api/service_api.rb index f4cd4f4..38cb8f6 100644 --- a/lib/rda-collections-client/api/service_api.rb +++ b/lib/rda-collections-client/api/service_api.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 @@ -31,7 +31,7 @@ def initialize(api_client = ApiClient.default) @api_client = api_client end - # Gets the service-level features. + # Gets the service-level features. A successful request returns an HTTP 200 response code with the ServiceFeatures object in the response body. # This request returns the service-level features. Examples of service-level features might include whether or not the service supports assignment of PIDs for collection members, whether it supports pagination and cursors, whether it enforces access controls, etc. # @param [Hash] opts the optional parameters # @return [ServiceFeatures] @@ -40,7 +40,7 @@ def features_get(opts = {}) return data end - # Gets the service-level features. + # Gets the service-level features. A successful request returns an HTTP 200 response code with the ServiceFeatures object in the response body. # This request returns the service-level features. Examples of service-level features might include whether or not the service supports assignment of PIDs for collection members, whether it supports pagination and cursors, whether it enforces access controls, etc. # @param [Hash] opts the optional parameters # @return [Array<(ServiceFeatures, Fixnum, Hash)>] ServiceFeatures data, response status code and response headers diff --git a/lib/rda-collections-client/api_client.rb b/lib/rda-collections-client/api_client.rb index 1711801..b34aa67 100644 --- a/lib/rda-collections-client/api_client.rb +++ b/lib/rda-collections-client/api_client.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/api_error.rb b/lib/rda-collections-client/api_error.rb index 8707a53..9a03a10 100644 --- a/lib/rda-collections-client/api_error.rb +++ b/lib/rda-collections-client/api_error.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/configuration.rb b/lib/rda-collections-client/configuration.rb index 6d69dc7..9cd7f41 100644 --- a/lib/rda-collections-client/configuration.rb +++ b/lib/rda-collections-client/configuration.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/collection_capabilities.rb b/lib/rda-collections-client/models/collection_capabilities.rb index 7d1c3b0..7cee7a4 100644 --- a/lib/rda-collections-client/models/collection_capabilities.rb +++ b/lib/rda-collections-client/models/collection_capabilities.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 @@ -38,8 +38,8 @@ class CollectionCapabilities # Indicates whether collection membership mutable (i.e. whether members can be added and removed) attr_accessor :membership_is_mutable - # Indicates whether collection metadata is mutable (i.e. can the metadata of this collection be changed) - attr_accessor :metadata_is_mutable + # Indicates whether collection properties are mutable (i.e. can the metadata of this collection be changed) + attr_accessor :properties_are_mutable # 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. attr_accessor :restricted_to_type @@ -55,7 +55,7 @@ def self.attribute_map :'appends_to_end' => :'appendsToEnd', :'supports_roles' => :'supportsRoles', :'membership_is_mutable' => :'membershipIsMutable', - :'metadata_is_mutable' => :'metadataIsMutable', + :'properties_are_mutable' => :'propertiesAreMutable', :'restricted_to_type' => :'restrictedToType', :'max_length' => :'maxLength' } @@ -68,7 +68,7 @@ def self.swagger_types :'appends_to_end' => :'BOOLEAN', :'supports_roles' => :'BOOLEAN', :'membership_is_mutable' => :'BOOLEAN', - :'metadata_is_mutable' => :'BOOLEAN', + :'properties_are_mutable' => :'BOOLEAN', :'restricted_to_type' => :'String', :'max_length' => :'Integer' } @@ -106,10 +106,10 @@ def initialize(attributes = {}) self.membership_is_mutable = true end - if attributes.has_key?(:'metadataIsMutable') - self.metadata_is_mutable = attributes[:'metadataIsMutable'] + if attributes.has_key?(:'propertiesAreMutable') + self.properties_are_mutable = attributes[:'propertiesAreMutable'] else - self.metadata_is_mutable = true + self.properties_are_mutable = true end if attributes.has_key?(:'restrictedToType') @@ -136,7 +136,7 @@ def valid? return false if @appends_to_end.nil? return false if @supports_roles.nil? return false if @membership_is_mutable.nil? - return false if @metadata_is_mutable.nil? + return false if @properties_are_mutable.nil? return false if @restricted_to_type.nil? return false if @max_length.nil? return true @@ -151,7 +151,7 @@ def ==(o) appends_to_end == o.appends_to_end && supports_roles == o.supports_roles && membership_is_mutable == o.membership_is_mutable && - metadata_is_mutable == o.metadata_is_mutable && + properties_are_mutable == o.properties_are_mutable && restricted_to_type == o.restricted_to_type && max_length == o.max_length end @@ -165,7 +165,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [is_ordered, appends_to_end, supports_roles, membership_is_mutable, metadata_is_mutable, restricted_to_type, max_length].hash + [is_ordered, appends_to_end, supports_roles, membership_is_mutable, properties_are_mutable, restricted_to_type, max_length].hash end # Builds the object from hash diff --git a/lib/rda-collections-client/models/collection_item_mapping_metadata.rb b/lib/rda-collections-client/models/collection_item_mapping_metadata.rb index cfd4c8f..3237401 100644 --- a/lib/rda-collections-client/models/collection_item_mapping_metadata.rb +++ b/lib/rda-collections-client/models/collection_item_mapping_metadata.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/collection_object.rb b/lib/rda-collections-client/models/collection_object.rb index ba29ca3..a84b209 100644 --- a/lib/rda-collections-client/models/collection_object.rb +++ b/lib/rda-collections-client/models/collection_object.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/collection_operations.rb b/lib/rda-collections-client/models/collection_operations.rb index 4766fa4..1631011 100644 --- a/lib/rda-collections-client/models/collection_operations.rb +++ b/lib/rda-collections-client/models/collection_operations.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/collection_properties.rb b/lib/rda-collections-client/models/collection_properties.rb index feb51f5..448ed57 100644 --- a/lib/rda-collections-client/models/collection_properties.rb +++ b/lib/rda-collections-client/models/collection_properties.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/collection_result_set.rb b/lib/rda-collections-client/models/collection_result_set.rb index b23049a..38bb854 100644 --- a/lib/rda-collections-client/models/collection_result_set.rb +++ b/lib/rda-collections-client/models/collection_result_set.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/error.rb b/lib/rda-collections-client/models/error.rb index 240e8e4..c657c86 100644 --- a/lib/rda-collections-client/models/error.rb +++ b/lib/rda-collections-client/models/error.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/member_item.rb b/lib/rda-collections-client/models/member_item.rb index 85fff9c..6cf92b9 100644 --- a/lib/rda-collections-client/models/member_item.rb +++ b/lib/rda-collections-client/models/member_item.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/member_result_set.rb b/lib/rda-collections-client/models/member_result_set.rb index 1a4d206..d8f850d 100644 --- a/lib/rda-collections-client/models/member_result_set.rb +++ b/lib/rda-collections-client/models/member_result_set.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/models/service_features.rb b/lib/rda-collections-client/models/service_features.rb index a22022c..c29efca 100644 --- a/lib/rda-collections-client/models/service_features.rb +++ b/lib/rda-collections-client/models/service_features.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 diff --git a/lib/rda-collections-client/version.rb b/lib/rda-collections-client/version.rb index 91968fa..2e19605 100644 --- a/lib/rda-collections-client/version.rb +++ b/lib/rda-collections-client/version.rb @@ -1,7 +1,7 @@ =begin #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. OpenAPI spec version: 1.0.0 @@ -22,5 +22,5 @@ =end module CollectionsClient - VERSION = "1.0.0" + VERSION = "1.0.1" end diff --git a/rda-collections-client.gemspec b/rda-collections-client.gemspec index a4b9495..cc5e3a8 100644 --- a/rda-collections-client.gemspec +++ b/rda-collections-client.gemspec @@ -3,7 +3,7 @@ =begin #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. OpenAPI spec version: 1.0.0 @@ -35,6 +35,7 @@ Gem::Specification.new do |s| s.homepage = "https://github.com/RDACollectionsWG/ruby-collections-client" s.summary = "A ruby wrapper for the RDA Collections API Client" s.description = "This gem maps to the RDA Collections swagger API" + s.description = "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." s.license = "Apache 2.0" s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'