From c92928d8fdf19e6207fb23debd867ade66cafbeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Herv=C3=A9?= Date: Wed, 6 Sep 2023 11:21:49 +0200 Subject: [PATCH 1/6] wip --- optic.yml | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 optic.yml diff --git a/optic.yml b/optic.yml new file mode 100644 index 0000000..c27e2da --- /dev/null +++ b/optic.yml @@ -0,0 +1,9 @@ +ruleset: + - naming: + required_on: added + requestHeaders: Capital-Param-Case + responseHeaders: param-case + properties: Capital-Param-Case + pathComponents: param-case + queryParameters: snake_case + - breaking-changes From 6fa8a49a20661436c8f3a90ec41133a1fbc5880d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Herv=C3=A9?= Date: Wed, 6 Sep 2023 12:05:41 +0200 Subject: [PATCH 2/6] wip --- optic.yml | 2 +- todo-api.yaml | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/optic.yml b/optic.yml index c27e2da..7c651ba 100644 --- a/optic.yml +++ b/optic.yml @@ -1,6 +1,6 @@ ruleset: - naming: - required_on: added + required_on: always requestHeaders: Capital-Param-Case responseHeaders: param-case properties: Capital-Param-Case diff --git a/todo-api.yaml b/todo-api.yaml index d2b9e73..0b8a03a 100644 --- a/todo-api.yaml +++ b/todo-api.yaml @@ -11,6 +11,11 @@ paths: schema: type: number required: false + - name: test + in: path + schema: + type: string + required: true responses: '200': description: okay From 4a91feef4184965929634d56bc2a8e7c7352ac79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Herv=C3=A9?= Date: Fri, 8 Sep 2023 18:02:16 +0200 Subject: [PATCH 3/6] wip --- .github/workflows/optic_pr.yml | 8 +++++--- nope.yaml | 0 todo-api.yaml | 9 ++++----- 3 files changed, 9 insertions(+), 8 deletions(-) create mode 100644 nope.yaml diff --git a/.github/workflows/optic_pr.yml b/.github/workflows/optic_pr.yml index 39ab155..0af3368 100644 --- a/.github/workflows/optic_pr.yml +++ b/.github/workflows/optic_pr.yml @@ -12,9 +12,11 @@ jobs: - name: Checkout uses: actions/checkout@v3 - - name: Install Optic - run: npm install --location global @useoptic/optic@0.49.7-7 + run: npm install --location global @useoptic/optic@0.49.10-3 - name: Run Optic - run: OPTIC_ENV=staging OPTIC_TOKEN="oidMDU4MmI1YzQtNTQwMS00YjIxLWI2Y2ItMDFmNGU0ODlkYWI3.ZBWfGe1k1noEvGGcKTtJG.-_KL_7gZsqLqfetE7iLm4" GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} optic run + env: + OPTIC_TOKEN: ${{ secrets.OPTIC_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: optic run diff --git a/nope.yaml b/nope.yaml new file mode 100644 index 0000000..e69de29 diff --git a/todo-api.yaml b/todo-api.yaml index 0b8a03a..6cae798 100644 --- a/todo-api.yaml +++ b/todo-api.yaml @@ -6,13 +6,13 @@ paths: /todos: get: parameters: - - name: limit - in: query + - name: new + in: header schema: type: number required: false - - name: test - in: path + - name: tDah + in: query schema: type: string required: true @@ -46,6 +46,5 @@ components: format: date-time example: "2020-01-01T00:00:00.000Z" required: - - name - status - created_at From 0fbdf0a4134578bc0dea48f6a040e0a78ec748a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Herv=C3=A9?= Date: Fri, 8 Sep 2023 19:06:03 +0200 Subject: [PATCH 4/6] wip --- .github/workflows/optic_pr.yml | 2 +- todo-api.yaml | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/.github/workflows/optic_pr.yml b/.github/workflows/optic_pr.yml index 0af3368..78712e1 100644 --- a/.github/workflows/optic_pr.yml +++ b/.github/workflows/optic_pr.yml @@ -13,7 +13,7 @@ jobs: uses: actions/checkout@v3 - name: Install Optic - run: npm install --location global @useoptic/optic@0.49.10-3 + run: npm install --location global @useoptic/optic - name: Run Optic env: diff --git a/todo-api.yaml b/todo-api.yaml index 6cae798..5f6f5c5 100644 --- a/todo-api.yaml +++ b/todo-api.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: TodoAPI - version: "1.1" + version: '1.1' paths: /todos: get: @@ -27,7 +27,7 @@ paths: todos: type: array items: - $ref: "#/components/schemas/TodoRead" + $ref: '#/components/schemas/TodoRead' required: - todos components: @@ -44,7 +44,6 @@ components: example: type: string format: date-time - example: "2020-01-01T00:00:00.000Z" + example: '2020-01-01T00:00:00.000Z' required: - status - - created_at From b1e64a48becbd6f40be8ed02fd28bc31e3f725d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Herv=C3=A9?= Date: Fri, 8 Sep 2023 19:10:19 +0200 Subject: [PATCH 5/6] wip --- .github/workflows/optic_pr.yml | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/.github/workflows/optic_pr.yml b/.github/workflows/optic_pr.yml index 78712e1..fb26be2 100644 --- a/.github/workflows/optic_pr.yml +++ b/.github/workflows/optic_pr.yml @@ -16,7 +16,4 @@ jobs: run: npm install --location global @useoptic/optic - name: Run Optic - env: - OPTIC_TOKEN: ${{ secrets.OPTIC_TOKEN }} - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: optic run + run: OPTIC_TOKEN=${{ secrets.OPTIC_TOKEN }} GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} optic run From e0a5e54537bfe1356a3aacd9995ce9f9497765df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Herv=C3=A9?= Date: Fri, 8 Sep 2023 19:11:40 +0200 Subject: [PATCH 6/6] wip --- .github/workflows/optic_pr.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/optic_pr.yml b/.github/workflows/optic_pr.yml index fb26be2..a1a7964 100644 --- a/.github/workflows/optic_pr.yml +++ b/.github/workflows/optic_pr.yml @@ -16,4 +16,8 @@ jobs: run: npm install --location global @useoptic/optic - name: Run Optic - run: OPTIC_TOKEN=${{ secrets.OPTIC_TOKEN }} GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} optic run + env: + OPTIC_TOKEN: ${{ secrets.OPTIC_TOKEN }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + OPTIC_ENV: staging + run: optic run