feat: define api and generate swagger file #16
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Copyright 2023 The opennaslab Authors. | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: Bifrost style check | |
| on: | |
| pull_request: | |
| branches: [ 'main', 'release-*' ] | |
| jobs: | |
| golangci: | |
| name: lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-go@v4 | |
| with: | |
| go-version: '1.21' | |
| cache: false | |
| - name: golangci-lint | |
| uses: golangci/golangci-lint-action@v3 | |
| with: | |
| # Require: The version of golangci-lint to use. | |
| # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version. | |
| # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit. | |
| version: v1.54 | |
| # Optional: working directory, useful for monorepos | |
| # working-directory: somedir | |
| # Optional: golangci-lint command line arguments. | |
| # | |
| # Note: By default, the `.golangci.yml` file should be at the root of the repository. | |
| # The location of the configuration file can be changed by using `--config=` | |
| args: --timeout=30m | |
| # Optional: show only new issues if it's a pull request. The default value is `false`. | |
| # only-new-issues: true | |
| # Optional: if set to true, then all caching functionality will be completely disabled, | |
| # takes precedence over all other caching options. | |
| # skip-cache: true | |
| # Optional: if set to true, then the action won't cache or restore ~/go/pkg. | |
| # skip-pkg-cache: true | |
| # Optional: if set to true, then the action won't cache or restore ~/.cache/go-build. | |
| # skip-build-cache: true | |
| # Optional: The mode to install golangci-lint. It can be 'binary' or 'goinstall'. | |
| # install-mode: "goinstall" |