feat: implement OpenAPI documentation (#162) #230
rust.yml
on: pull_request
Formatting
12s
Linting
47s
Annotations
5 errors and 24 warnings
Schema-Unchanged
Process completed with exit code 101.
|
item in documentation is missing backticks:
src/server/run/mod.rs#L158
error: item in documentation is missing backticks
--> src/server/run/mod.rs:158:18
|
158 | /// Utoipa-based OpenAPI generation helper.
| ^^^^^^^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown
= note: `#[deny(clippy::doc_markdown)]` implied by `#[deny(clippy::pedantic)]`
help: try
|
158 | /// Utoipa-based `OpenAPI` generation helper.
| ~~~~~~~~~
|
docs for function which may panic missing `# Panics` section:
src/server/run/hpo_terms.rs#L97
error: docs for function which may panic missing `# Panics` section
--> src/server/run/hpo_terms.rs:97:5
|
97 | / pub fn from_term_with_ontology(
98 | | term: &HpoTerm,
99 | | ontology: &Ontology,
100 | | genes: bool,
... |
103 | | doc: Option<&tantivy::Document>,
104 | | ) -> Self {
| |_____________^
|
note: first possible panic found here
--> src/server/run/hpo_terms.rs:105:29
|
105 | let field_term_id = index
| _____________________________^
106 | | .schema()
107 | | .get_field("term_id")
108 | | .expect("field must exist");
| |_______________________________________^
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc
|
docs for function which may panic missing `# Panics` section:
src/server/run/hpo_omims.rs#L100
error: docs for function which may panic missing `# Panics` section
--> src/server/run/hpo_omims.rs:100:5
|
100 | / pub fn from_omim_disease_with_ontology(
101 | | omim_disease: &OmimDisease,
102 | | ontology: &Ontology,
103 | | hpo_terms: bool,
104 | | ) -> Self {
| |_____________^
|
note: first possible panic found here
--> src/server/run/hpo_omims.rs:115:32
|
115 | let term = term.expect("filtered above");
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#missing_panics_doc
note: the lint level is defined here
--> src/main.rs:2:9
|
2 | #![deny(clippy::pedantic)]
| ^^^^^^^^^^^^^^^^
= note: `#[deny(clippy::missing_panics_doc)]` implied by `#[deny(clippy::pedantic)]`
|
Linting
Clippy had exited with the 101 exit code
|
Formatting
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, arduino/[email protected]. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
Formatting
The following actions uses Node.js version which is deprecated and will be forced to run on node20: actions/checkout@v3, actions-rs/toolchain@v1, arduino/[email protected]. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
|
Formatting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Formatting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Formatting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Formatting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Schema-Unchanged
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, arduino/[email protected]. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
Schema-Unchanged
The following actions uses Node.js version which is deprecated and will be forced to run on node20: actions/checkout@v3, actions-rs/toolchain@v1, arduino/[email protected]. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
|
Schema-Unchanged
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Schema-Unchanged
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Schema-Unchanged
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Schema-Unchanged
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Linting
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, arduino/[email protected], actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
Linting
The following actions uses Node.js version which is deprecated and will be forced to run on node20: actions/checkout@v3, actions-rs/toolchain@v1, arduino/[email protected], actions-rs/clippy-check@v1. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
|
Linting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Linting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Linting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Linting
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Testing
The following actions uses node12 which is deprecated and will be forced to run on node16: actions-rs/toolchain@v1, arduino/[email protected], actions-rs/[email protected]. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
|
Testing
The following actions uses Node.js version which is deprecated and will be forced to run on node20: actions/checkout@v3, actions-rs/toolchain@v1, arduino/[email protected], actions-rs/[email protected], codecov/codecov-action@v3. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
|
Testing
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Testing
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Testing
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|
Testing
The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
|