Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Commit

Permalink
Merge pull request #148 from mcupak/cleanup-openapi
Browse files Browse the repository at this point in the history
Remove Proto3/Avro things, close #146
  • Loading branch information
juhtornr authored Mar 27, 2018
2 parents 3004488 + db91ca9 commit 87187cb
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 337 deletions.
15 changes: 0 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,3 @@
*.py[cod]
target
*~
#*
doc/source/schemas/*.avpr
build

#********** windows template**********

# Windows image file caches
Expand Down Expand Up @@ -41,7 +34,6 @@ $RECYCLE.BIN/

#********** emacs template**********

*~
\#*\#
/.emacs.desktop
/.emacs.desktop.lock
Expand All @@ -62,16 +54,9 @@ tramp
Session.vim


#********** maven template**********

target/

#********** Travis CI **********

!.travis.yml

#********** IntelliJ files ******
*.iml

#********** Dependency files ********
src/avro-schema-test-base
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ branches:
- master
- develop
script:
- nosetests -v $VIRTUAL_ENV/src/avro-schema-test-base
- echo "temporarily skip"
notifications:
slack:
secure: RmyIMB6tA868r+dHECJ566r0+TCB6pHvg9PygNiM5ye+iX4I+CFKMoGzjeMVtuLI80MSzzoaB+PU6TczlhzdbJBALqiV74AQCoNGqswJzJCkJX7HDGk8LVFSsnpwClRLLLVgvBApGDS0ViRfGqsew8CJ8VR5BMDiU53z3Of4JHc=
13 changes: 1 addition & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are two ways to contribute - via issues, which are used for discussion, an

## Issues

The project's [Issues Page](https://github.com/ga4gh/beacon-team/issues) is a forum to discuss both major and minor issues related to developing the Beacon API. It also serves as the means for collaborating with the group and discussing contributions that will ultimately lead to changes to the API. See the [Issue](#issue_resolution) section below for specifics on how issues are resolved by the community.
The project's [Issues Page](https://github.com/ga4gh-beacon/specification/issues) is a forum to discuss both major and minor issues related to developing the Beacon API. It also serves as the means for collaborating with the group and discussing contributions that will ultimately lead to changes to the API. See the [Issue](#issue_resolution) section below for specifics on how issues are resolved by the community.

## Pull Requests

Expand Down Expand Up @@ -38,17 +38,6 @@ We sometimes waive the time constraint for cosmetic-only changes -- use good jud

The project will strive for full consensus on everything until it runs into a problem with this model.

## Syntax Style and Conventions

The current code conventions for the source files are as follows:

- Use two-space indentation, and no tabs.
- Hard-wrap code to 80 characters per line.
- Use `UpperCamelCase` for object or record names.
- Use `lowerCamelCase` for attribute or method names.
- Use `CONSTANT_CASE` for global and constant values.
- Comments: Please use the OpenAPI description for addition information

## Gitflow Workflow

Our workflow is based on [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow), which defines a strict branching model designed around the project release. This workflow uses two branches to record the history of the project. The master branch stores the official release history, and the develop branch serves as an integration branch for features. Aside from these two main branches, the workflow utilizes topic and release branches.
Expand Down
25 changes: 2 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,15 @@
# Beacon Schemas [![](https://travis-ci.org/ga4gh/beacon-team.svg?branch=develop)](https://travis-ci.org/ga4gh/beacon-team) [![](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/ga4gh/beacon-team/develop/LICENSE) [![](https://beacon-team-slackin.herokuapp.com/badge.svg)](https://beacon-team-slackin.herokuapp.com/) [![](https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png)](https://zenhub.com)

# Beacon API specification [![](https://travis-ci.org/ga4gh-beacon/specification.svg?branch=develop)](https://travis-ci.org/ga4gh-beacon/specification) [![](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/ga4gh-beacon/specification/develop/LICENSE) [![](https://beacon-team-slackin.herokuapp.com/badge.svg)](https://beacon-team-slackin.herokuapp.com/)

Specification Status: <img src="http://online.swagger.io/validator?url=https://raw.githubusercontent.com/ga4gh-beacon/specification/develop/openapi.yaml">

## What is a Beacon?

A _Beacon_ is a web-accessible service that can be queried for information about a specific allele. A user of a Beacon can pose queries of the form _Have you observed this nucleotide (e.g. C) at this genomic location (e.g. position 32,936,732 on chromosome 13)?_ to which the Beacon must respond with either _yes_ or _no_.

## Beacon Project

The Beacon project is a project to test the willingness of international sites to share genetic data in the simplest of all technical contexts. For more information, visit [GA4GH Data Working Group](http://ga4gh.org/#/beacon).

## Tools

A list of related tools and projects developed by the community is maintained on the [Resources](https://github.com/ga4gh/beacon-team/wiki/Resources) wiki page.

## How to contribute

Guidelines for contributing to this repository are listed in the [CONTRIBUTING.md](CONTRIBUTING.md) document.

## How to build

Prerequisites: Maven 3+, Java 1.6+.

To generate Java code, run `mvn package` and check the output in the `target` directory.

## How to test

Prerequisites: Python 2.7 (incl. Pip 7+).

Install dependencies with `pip install -r requirements.txt`. To run the test suite, use `nosetests -v`.

## More information

More information for developers is available on [our wiki](https://github.com/ga4gh/beacon-team/wiki).
More information for developers is available on [our wiki](https://github.com/ga4gh-beacon/specification/wiki). A list of related tools and projects developed by the community is maintained on the [Resources](https://github.com/ga4gh-beacon/specification/wiki/Resources) page.
286 changes: 0 additions & 286 deletions pom.xml

This file was deleted.

0 comments on commit 87187cb

Please sign in to comment.