Data

Tools

Indexes

Applications

Experiments

Open Source Science

top-api

REST API of the TOP Framework

https://github.com/onto-med/top-api

Science Score: 54.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

openapi-specification phenotyping
Last synced: 6 months ago · JSON representation ·

Repository

REST API of the TOP Framework

Basic Info
Statistics
  • Stars: 0
  • Watchers: 3
  • Forks: 1
  • Open Issues: 2
  • Releases: 69
Topics
openapi-specification phenotyping
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

TOP API

This repository contains the OpenAPI 3 specification of the TOP framework. Please see top-deployment for an onverall description of the framework. The schema file is located at schemas/top-api.yml

DOI Swagger UI

Publish snapshots Publish packages and create release

Usage

Spring Boot Skeleton

  1. Add maven dependency xml <dependency> <groupId>care.smith.top</groupId> <artifactId>top-api</artifactId> <version><!-- the version number --></version> </dependency>
  2. Add annotation @ComponentScan("care.smith.top.backend") to your application class.
  3. Create implementations for the delegate interfaces in care.smith.top.backend.api (e.g., EntityApiDelegate).

Because the Maven package is hosted at GitHub Packages, you need to make some modifications to your Maven installation in order to download and install the package. Please follow the Authenticating to GitHub Packages instructions.

Typescript Axios

  1. Add the file .npmrc to the project folder, with the following content: properties @onto-med:registry=https://npm.pkg.github.com
  2. Authenticate to GitHub Packages (you will be prompted for username and password aka. personal access token, see Authenticating to GitHub Packages): sh npm login --scope=@onto-med --registry=https://npm.pkg.github.com
  3. Add @onto-med/top-api as dependency, e.g.: sh yarn add @onto-med/top-api

Contribution and Development

Please see our Contributing Guide.

License

The code in this repository and the packages care.smith.top:top-api and @onto-med/top-api are licensed under MIT.

Owner

  • Name: Onto-Med Research Group
  • Login: Onto-Med
  • Kind: organization
  • Location: Leipzig

The Onto-Med Research Group conducts basic research in formal ontology, designs formal tools and develops top level, domain and core ontologies.

Citation (CITATION.cff) 

# CFF: https://citation-file-format.github.io/

cff-version: 1.2.0
message: If you use the content of this repository, please cite it as below.
title: TOP API
abstract: The API of the TOP framework is described with an OpenAPI 3 specification.
doi: 10.5281/zenodo.7788493
repository-code: 'https://github.com/Onto-Med/top-api'
url: 'https://onto-med.github.io/top-api/'
keywords:
  - phenotyping
  - openapi-specification
license: MIT
authors:
- family-names: Beger
  given-names: Christoph
  orcid: 'https://orcid.org/0000-0002-1166-0368'
  affiliation: Leipzig University
- family-names: Matthies
  given-names: Franz
  orcid: 'https://orcid.org/0000-0001-7196-506X'
  affiliation: Leipzig University
- family-names: Schäfermeier
  given-names: Ralph
  orcid: 'https://orcid.org/0000-0002-4349-6726'
  affiliation: Leipzig University
- family-names: Höffner
  given-names: Konrad
  orcid: 'https://orcid.org/0000-0001-7358-3217'
  affiliation: Leipzig University
- family-names: Uciteli
  given-names: Alexandr
  orcid: 'https://orcid.org/0000-0001-9558-5352'
  affiliation: Leipzig University

GitHub Events

Total
  • Create event: 12
  • Issues event: 2
  • Release event: 6
  • Delete event: 7
  • Issue comment event: 6
  • Push event: 44
  • Pull request review event: 3
  • Pull request review comment event: 2
  • Pull request event: 15
Last Year
  • Create event: 12
  • Issues event: 2
  • Release event: 6
  • Delete event: 7
  • Issue comment event: 6
  • Push event: 44
  • Pull request review event: 3
  • Pull request review comment event: 2
  • Pull request event: 15

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 9
  • Average time to close issues: over 1 year
  • Average time to close pull requests: 3 days
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.44
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 9
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Issue authors: 0
  • Pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.44
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • fmatthies (3)
  • ChristophB (3)
Pull Request Authors
  • fmatthies (9)
  • ChristophB (9)
  • RalphBln (2)
  • dependabot[bot] (1)
  • KonradHoeffner (1)
Top Labels
Issue Labels
enhancement (3)
Pull Request Labels
dependencies (1) enhancement (1)

Dependencies

pom.xml maven
  • com.fasterxml.jackson.core:jackson-databind
  • com.fasterxml.jackson.dataformat:jackson-dataformat-yaml
  • com.fasterxml.jackson.datatype:jackson-datatype-jsr310
  • com.google.code.findbugs:jsr305 3.0.2
  • org.openapitools:jackson-databind-nullable 0.2.2
  • org.springdoc:springdoc-openapi-ui 1.6.9
  • org.springframework.boot:spring-boot-starter-validation
  • org.springframework.boot:spring-boot-starter-web
  • org.springframework.data:spring-data-commons
  • org.springframework.boot:spring-boot-starter-test test
.github/workflows/publish-snapshots.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-java v2 composite
  • actions/setup-node v2 composite
.github/workflows/release.yml actions
  • actions/cache v2 composite
  • actions/checkout v2 composite
  • actions/setup-java v2 composite
  • actions/setup-node v2 composite
  • softprops/action-gh-release v1 composite
.devcontainer/Dockerfile docker
  • mcr.microsoft.com/vscode/devcontainers/java 0-${VARIANT} build