Skip to content

chore: add OpenAPI spec validator based on redocly cli#15

Merged
beeme1mr merged 1 commit intomainfrom
feat/openapi-linter
May 13, 2024
Merged

chore: add OpenAPI spec validator based on redocly cli#15
beeme1mr merged 1 commit intomainfrom
feat/openapi-linter

Conversation

@Kavindu-Dodan
Copy link
Contributor

@Kavindu-Dodan Kavindu-Dodan commented May 9, 2024

This PR

Adds a GitHub action to validate OpenAPI spec using redocly cli. Note that I have fixed currently reported issues which doesn't change anything special in the spec.

Replacement for #13

Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Copy link
Member

@thomaspoignant thomaspoignant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great 👌
I will close the other PR.

Copy link
Member

@lukas-reining lukas-reining left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@beeme1mr beeme1mr merged commit 1d31e7b into main May 13, 2024
@beeme1mr beeme1mr deleted the feat/openapi-linter branch May 13, 2024 13:18
thomaspoignant pushed a commit that referenced this pull request May 17, 2024
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
thomaspoignant pushed a commit that referenced this pull request May 17, 2024
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
thomaspoignant pushed a commit that referenced this pull request May 12, 2025
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
thomaspoignant pushed a commit that referenced this pull request May 16, 2025
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
thomaspoignant added a commit that referenced this pull request May 16, 2025
* feat: Client provider spec

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update provider/specs/client.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* update with review comments

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Move to guideline folder

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Replace specification

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* add OpenAPI spec validator based on redocly cli (#15)

Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* chore(deps): update actions/checkout action to v4 (#16)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update guideline/static-context-provider.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update guideline/static-context-provider.md

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update guideline/static-context-provider.md

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* update guidelines after removing configuration endpoint

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* adding change context

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Allow any reason (#20)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat!: change minPollingInterval field name to mention millisecond (#25)

* feat!: change minPollingInterval field name to mention millisecond

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* change name to ms

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

---------

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Group API in core and extensions (#23)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat!: Reverse the logic for supportedTypes (#24)

* feat!: Reverse the logic for supportedTypes

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* fix

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

---------

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* doc: adding providers link (#26)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* make flags property mandatory for bulk evaluation success response (#27)

Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Typo in header name (#28)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* add optional targeting key property (#30)

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* fix: use correct header name for 429 bulk response (#32)

Signed-off-by: Roman Dmytrenko <rdmytrenko@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Specify caching for OFREP in server providers (#17)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
Signed-off-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com>
Co-authored-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: add flag set metadata for bulk response and failures (#34)

Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Fixups: Add operationIds, remove invalid property, fix tag casing (#35)

Signed-off-by: Honza Dvorsky <honza@apple.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* ci: switch OpenAPI validators (#36)

Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* fix: address style issues

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update static-context-provider.md

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update static-context-provider.md

Co-authored-by: Lukas Reining <lukas.reining@codecentric.de>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* adding timeout

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Server provider guidelines (#42)

* feat: Server provider guideline

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* adding timeout

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

---------

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* feat: Group API in core and extensions (#23)

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update guideline/static-context-provider.md

Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

* Update openapi.yaml

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>

---------

Signed-off-by: Thomas Poignant <thomas.poignant@gofeatureflag.org>
Signed-off-by: Thomas Poignant <thomas.poignant@gmail.com>
Signed-off-by: Kavindu Dodanduwa <kavindudodanduwa@gmail.com>
Signed-off-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Signed-off-by: Roman Dmytrenko <rdmytrenko@gmail.com>
Signed-off-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com>
Signed-off-by: Todd Baert <todd.baert@dynatrace.com>
Signed-off-by: Honza Dvorsky <honza@apple.com>
Co-authored-by: Mark Phelps <209477+markphelps@users.noreply.github.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>
Co-authored-by: Kavindu Dodanduwa <Kavindu-Dodan@users.noreply.github.com>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Lukas Reining <lukas.reining@codecentric.de>
Co-authored-by: Michel TURPIN <michel.turpin1@gmail.com>
Co-authored-by: Roman Dmytrenko <rdmytrenko@gmail.com>
Co-authored-by: Todd Baert <todd.baert@dynatrace.com>
Co-authored-by: Honza Dvorsky <honza@apple.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants