Sign in
registrations

Submit an adapter registration

Changed on

Store one adapter repository as a tracked registration request. The repository may be a local path or remote URL and should contain a root-level croissant.jsonld file. Processing happens later through the process endpoint or a registry refresh.

post/api/v1/registrations

Request

  • The document declares no server URL.
  • Auth: none declared

Cookies

bcr_sessionstring nullable

Request body

repository_locationstring required

Local repository path or supported remote repository URL containing a root-level croissant.jsonld file.

license_valuestring nullable

Optional submitted adapter license text.

doistring nullable

Optional submitted DOI text.

cff_urlstring nullable

Optional submitted Citation File Format URL.

Example request

{
  "cff_url": "https://gitlab.example.org/biocypher/collectri/-/raw/main/CITATION.cff",
  "doi": "10.5281/zenodo.1234567",
  "license_value": "MIT",
  "repository_location": "https://gitlab.example.org/biocypher/collectri"
}

Response

Successful Response

registration_idstring required
adapter_namestring required
adapter_idstring required
repository_locationstring required
status'SUBMITTED' | 'VALID' | 'INVALID' required

Tracked states for a stored registration request.

created_atstring date-time required
license_valuestring nullable
doistring nullable
cff_urlstring nullable
submitted_by_github_user_idstring nullable

Changes