내 워크플로우

on: [pull_request]

jobs:
  review_openapi_specs:
    runs-on: ubuntu-latest
    name: Review all OpenAPI specs
    steps:
      - name: Checkout
        uses: actions/checkout@v1
      - name: Review OpenAPI specs
        uses: blake-mealey/openapi-review-action@v1
        with:
          spec-paths: ./fixtures/*.@(json|yaml|yml)
          github-token: ${{ secrets.GITHUB_TOKEN }}

제출 카테고리:

메인테이너 머스트해브

Yaml 파일 또는 코드 링크

블레이크밀리 / openapi-review-action

OpenAPI 문서가 변경될 때마다 PR에 주석으로 게시하는 GitHub 작업입니다.

OpenAPI 검토 작업

OpenAPI 사양에 대한 변경 사항을 검토하기 위한 GitHub 작업입니다.
이 작업은 OpenAPI 사양 파일을 변경할 때마다 PR에 댓글을 게시합니다.
검토자가 더 많은 잠재적인 문제를 파악하고 더 나은 피드백을 제공할 수 있도록 유용한 세부 정보!

사양의 diff를 검토하여 사용자에게 주요 변경 사항을 도입하지 않았는지 확인하십시오

.

변경 사항을 수락하기 전에 API 문서가 완전하고 최신 상태인지 확인하십시오

.

⚡ openapi-diff 및
widdershins !
지원되는 이벤트:

pull_request

사용 예

# Make sure you checkout your repo before first!
- uses: actions/checkout@v1
- uses: blake-mealey/openapi-review-action@v1
  with
    spec-paths: ./specs/*.yaml
    github-token: ${{ secrets.GITHUB_TOKEN }}

입력

사양 경로(필수)

처리할 OpenAPI 사양의 경로입니다(단일 glob 또는 glob 배열). 참조
glob glob 구문 지원에 대한 정보 패키지. JSON 및
yaml 파일이 지원됩니다. 상대 경로…

View on GitHub

추가 리소스/정보

스크린샷:



PR 예시:

https://github.com/blake-mealey/openapi-review-action/pull/22