Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Framework refactor entry type definitions #102

Closed
wants to merge 39 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
2b16fcb
Update other-implementations.md
mbaudis Mar 14, 2023
a0fb9f0
Update index.md
mbaudis Mar 14, 2023
b851579
Update index.md
mbaudis Mar 14, 2023
213fddc
Update security.md
mbaudis Mar 14, 2023
ee11ce1
Update bugs-changes-log.md
mbaudis Mar 14, 2023
799133b
Update variant-queries.md
mbaudis Mar 30, 2023
c8c2904
Update README.md
d-salgado Apr 11, 2023
5820573
Merge pull request #71 from d-salgado/patch-2
jrambla Apr 12, 2023
b8ed6f8
adding contribution/development pages
mbaudis May 8, 2023
fca3233
Update filters.md
mbaudis May 31, 2023
5ba60b3
Update filters.md
mbaudis May 31, 2023
fb7b48d
Update filters.md
mbaudis May 31, 2023
68f319d
age queries in FAQ
mbaudis May 31, 2023
3f1d174
Nav mod
mbaudis May 31, 2023
5468efe
http => https for all links
mbaudis Jun 4, 2023
1d8f804
documentation change log update
mbaudis Jun 4, 2023
622b017
documentation
mbaudis Jun 11, 2023
8d72492
documentation restructuring and additions
mbaudis Jun 11, 2023
ac3e038
rename/restructure changes page
mbaudis Jun 12, 2023
278648e
Update records.md
mbaudis Jun 12, 2023
87a17ab
Update records.md
mbaudis Jun 12, 2023
1c52ad2
Amending some examples
jrambla Jun 13, 2023
a75dbbd
Merge branch 'website-docs' of https://github.com/ga4gh-beacon/beacon…
jrambla Jun 13, 2023
23d49cc
fix yaml for filteringTerms
mbaudis Jun 14, 2023
bc666cd
link fix
mbaudis Jun 14, 2023
16db543
comment broken Beacon link for http://clinbioinfosspa.es
mbaudis Jun 14, 2023
c7cb886
remove numeric example from doc
mbaudis Jun 14, 2023
01381e6
Update filters.md
mbaudis Jun 15, 2023
62d704d
complexValue required type fixed
Jun 16, 2023
cfec496
fixed position of required
Jun 16, 2023
be4ff29
added required again for quantityType
Jun 16, 2023
647a167
Merge pull request #89 from ga4gh-beacon/hotfix_complexValue
costero-e Jun 19, 2023
4d104ce
new gh actions
Jun 19, 2023
d72462a
Merge branch 'main' into website-docs
costero-e Jun 19, 2023
d2be0e2
Merge pull request #86 from ga4gh-beacon/website-docs
costero-e Jun 19, 2023
7137b03
entry type definitions refactoring
mbaudis Jul 11, 2023
4169d12
Merge branch 'develop' into framework-refactor-entry-type-definitions
costero-e Jan 16, 2024
df401fc
Undo commit for filtering terms response
costero-e Oct 8, 2024
b9b6646
Revert "Undo commit for filtering terms response"
costero-e Oct 8, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/github-actions-demo-yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "🍏 This job's status is ${{ job.status }}."
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
* Updated `docs`:
- `filters.md`
- `variant-queries.md`
- `bugs-changes-log.md`
- `changes-todo.md`
- `ComplexValue.md`
- `README.md`
- Added missing descriptions to models properties (see issue #42)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This repository is a unified repository representing the different parts of the
* [models](models)
* Beacon v2 Documentation
- authoritive source already in this repository [`/docs`](docs)
- rendered version through [here](https://beacon-project.io/beacon-v2/) (alternative address is [docs.genomebeacons.org](http://docs.genomebeacons.org))
- rendered version through [here](https://beacon-project.io/beacon-v2/) (alternative address is [docs.genomebeacons.org](https://docs.genomebeacons.org))

As with other schema projects, here we separate between the schema source files (in `src`; JSON-Schema written in YAML) and the generated versions for referencing. The current setup allows already the direct referencing of the generated JSON schemas. Examples:

Expand All @@ -30,10 +30,10 @@ There is a set of tools in [`/bin`](./bin/) to facilitate the conversion. ATM, a

### Changes

* change notes with respect to the repository & documentation are now in [docs.genomebeacons.org](http://docs.genomebeacons.org/bugs-changes-log/)
* change notes with respect to the repository & documentation are now in [docs.genomebeacons.org](https://docs.genomebeacons.org/changes-todo/)
* NOTE: on 2022-06-20 the previous development repositories have been archived:
- ARCHIVE - [beacon-framework-v2](https://github.com/ga4gh-beacon/beacon-framework-v2)
- ARCHIVE - [[beacon-v2-Models](https://github.com/ga4gh-beacon/beacon-v2-Models)
- ARCHIVE - [beacon-v2-Models](https://github.com/ga4gh-beacon/beacon-v2-Models)


## Directory structure
Expand Down
6 changes: 3 additions & 3 deletions bin/SCHEMAS2MD.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ YAMLs schemas. Each time the original MS Word document was edited, someone had t

This script inverts the process, i.e., **it enforces modifying the schema specification directly at the YAML/JSON level**.

Editing the schemas directly at the YAML/JSON level has two advantages, the first is that because we follow [OpenAPI](https://swagger.io/specification/) specification (along with JSON schema), _a priori_ we could use [SWAGGER UI](https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation). The second is that the YAML/JSON files can be converted to Markdown tables in order to create [Markdown based documentation](http://docs.genomebeacons.org) documentation. This script **transforms YAML/JSON to Markdown tables**, including their nested objects **up to a third degree of hierarchy**.
Editing the schemas directly at the YAML/JSON level has two advantages, the first is that because we follow [OpenAPI](https://swagger.io/specification/) specification (along with JSON schema), _a priori_ we could use [SWAGGER UI](https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation). The second is that the YAML/JSON files can be converted to Markdown tables in order to create [Markdown based documentation](https://docs.genomebeacons.org) documentation. This script **transforms YAML/JSON to Markdown tables**, including their nested objects **up to a third degree of hierarchy**.

The **Markdown** format can be directly rendered as tables at the GitHub repository, and it can be used with [MkDocs](https://www.mkdocs.org/) to create [HTML](http://docs.genomebeacons.org) documentation.
The **Markdown** format can be directly rendered as tables at the GitHub repository, and it can be used with [MkDocs](https://www.mkdocs.org/) to create [HTML](https://docs.genomebeacons.org) documentation.

Everytime a `git push` is performed to the [repo](https://github.com/ga4gh-beacon/beacon-v2) the documentation at [Github Pages](http://docs.genomebeacons.org) gets updated. Note that only content under directory `docs/` will make it to [Github Pages](http://docs.genomebeacons.org).
Everytime a `git push` is performed to the [repo](https://github.com/ga4gh-beacon/beacon-v2) the documentation at [Github Pages](https://docs.genomebeacons.org) gets updated. Note that only content under directory `docs/` will make it to [Github Pages](https://docs.genomebeacons.org).

Before creating this tool, the author made an exhaustive search on what had been dveloped by the _community_ to automatically convert YAML/JSON to Markdown tables and found that there were many ways to go from YAML/JSON to HTML (e.g., CPAN, Python, Node.js), but not much from YAML/JSON to Markdown. Obviously, even in the case we had found something, some major tweaking will be needed in order to display things the way we want.

Expand Down
8 changes: 4 additions & 4 deletions bin/beacon_yaml2md.pl
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ sub create_str_yaml {
description: References to the tool
examples:
- bio.toolsId: https://bio.tools/vep
- url: http://www.ensembl.org/vep
- url: https://www.ensembl.org/vep
type: object
EOF

Expand Down Expand Up @@ -769,11 +769,11 @@ =head1 MOTIVATION

This script inverts the process, i.e., B<it enforces modifying the schema specification directly at the YAML/JSON level>.

Editing the schemas directly at the YAML/JSON level has two advantages, the first is that because we follow L<OpenAPI|https://swagger.io/specification/> specification (along with JSON schema), I<a priori> we could use L<SWAGGER UI|https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation>. The second is that the YAML/JSON files can be converted to Markdown tables in order to create L<Markdown based documentation|http://docs.genomebeacons.org> documentation. This script B<transforms YAML/JSON to Markdown tables>, including their nested objects B<up to a third degree of hierarchy>.
Editing the schemas directly at the YAML/JSON level has two advantages, the first is that because we follow L<OpenAPI|https://swagger.io/specification/> specification (along with JSON schema), I<a priori> we could use L<SWAGGER UI|https://swagger.io/docs/open-source-tools/swagger-ui/usage/installation>. The second is that the YAML/JSON files can be converted to Markdown tables in order to create L<Markdown based documentation|https://docs.genomebeacons.org> documentation. This script B<transforms YAML/JSON to Markdown tables>, including their nested objects B<up to a third degree of hierarchy>.

The B<Markdown> format can be directly rendered as tables at the GitHub repository, and it can be used with L<MkDocs|https://www.mkdocs.org/> to create L<HTML|http://docs.genomebeacons.org> documentation.
The B<Markdown> format can be directly rendered as tables at the GitHub repository, and it can be used with L<MkDocs|https://www.mkdocs.org/> to create L<HTML|https://docs.genomebeacons.org> documentation.

Everytime a C<git push> is performed to the L<repo|https://github.com/ga4gh-beacon/beacon-v2> the documentation at L<Github Pages|http://docs.genomebeacons.org> gets updated. Note that only content under directory C<docs/> will make it to L<Github Pages|http://docs.genomebeacons.org>.
Everytime a C<git push> is performed to the L<repo|https://github.com/ga4gh-beacon/beacon-v2> the documentation at L<Github Pages|https://docs.genomebeacons.org> gets updated. Note that only content under directory C<docs/> will make it to L<Github Pages|https://docs.genomebeacons.org>.

Before creating this tool, the author made an exhaustive search on what had been dveloped by the I<community> to automatically convert YAML/JSON to Markdown tables and found that there were many ways to go from YAML/JSON to HTML (e.g., CPAN, Python, Node.js), but not much from YAML/JSON to Markdown. Obviously, even in the case we had found something, some major tweaking will be needed in order to display things the way we want.

Expand Down
2 changes: 1 addition & 1 deletion bin/deref_schemas/datasets/defaultSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@
"externalUrl": {
"description": "URL to an external system providing more dataset information (RFC 3986 format).",
"examples": [
"http://example.org/wiki/Main_Page"
"https://example.org/wiki/Main_Page"
],
"type": "string"
},
Expand Down
2 changes: 1 addition & 1 deletion bin/deref_schemas/datasets/defaultSchema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ properties:
externalUrl:
description: URL to an external system providing more dataset information (RFC 3986 format).
examples:
- http://example.org/wiki/Main_Page
- https://example.org/wiki/Main_Page
type: string
id:
description: Unique identifier of the dataset
Expand Down
24 changes: 12 additions & 12 deletions bin/deref_schemas/genomicVariations/defaultSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -295,7 +295,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -706,7 +706,7 @@
{
"id": "ClinGen:CA152954",
"notes": "ClinGen Allele Registry id",
"reference": "http://reg.clinicalgenome.org/redmine/projects/registry/genboree_registry/by_caid?caid=CA152954"
"reference": "https://reg.clinicalgenome.org/redmine/projects/registry/genboree_registry/by_caid?caid=CA152954"
},
{
"id": "UniProtKB:P35557#VAR_003699",
Expand Down Expand Up @@ -1563,7 +1563,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -1766,7 +1766,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -1811,7 +1811,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -1994,7 +1994,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -2259,7 +2259,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -2456,7 +2456,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -2797,7 +2797,7 @@
{
"id": "ClinGen:CA152954",
"notes": "ClinGen Allele Registry id",
"reference": "http://reg.clinicalgenome.org/redmine/projects/registry/genboree_registry/by_caid?caid=CA152954"
"reference": "https://reg.clinicalgenome.org/redmine/projects/registry/genboree_registry/by_caid?caid=CA152954"
},
{
"id": "UniProtKB:P35557#VAR_003699",
Expand Down Expand Up @@ -3022,7 +3022,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down Expand Up @@ -3205,7 +3205,7 @@
"bio.toolsId": "https://bio.tools/vep"
},
{
"url": "http://www.ensembl.org/vep"
"url": "https://www.ensembl.org/vep"
}
],
"minProperties": 1,
Expand Down
Loading
Loading