ror-community / ror-roadmap

Central information about what is happening at ROR and how to contribute feedback
10 stars 2 forks source link

[FEATURE] API v2: Record creation endpoint #204

Open lizkrznarich opened 1 year ago

lizkrznarich commented 1 year ago

Describe the problem you would like to solve As part of https://github.com/ror-community/ror-roadmap/issues/122, add API functionality to ROR API that supports generating new or updated record files based on data submitted to the API.

Describe the solution you'd like Functionality should behave as follows:

  1. User submits a JSON object to API endpoint with no value in ROR ID field. JSON object must include all required fields except Location fields populated with Geonames data. Relationships can be included or not; any included relationships will only be validated against the schema, and not additional rules such as requiring inverse relationships.
  2. JSON is validated against ROR schema v2
  3. If JSON is valid, location information is retrieved from Geonames API, a new ROR ID is generated and API returns a file object with name [ROR ID].json
  4. If JSON is invalid, API returns an error message listing validation errors

Who would benefit from this feature? ROR curation team

Additional information See full specification for more details