Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[#446][Part 1] Add OpenAPI to support creating API documentation with OpenAPI #464

Merged
merged 25 commits into from
Sep 27, 2023
Merged

[#446][Part 1] Add OpenAPI to support creating API documentation with OpenAPI #464

merged 25 commits into from
Sep 27, 2023

Conversation

sanG-github
Copy link
Contributor

@sanG-github sanG-github commented Aug 31, 2023 •
edited
Loading

Implement #446

What happened 👀

  • Added OpenAPI add-on.
  • Added an example for OpenAPI spec (/health API) - in the folder docs/openapi.
  • Added tools for OpenAPI (e.g., spectral, eslint)
  • Added tests to cover cases for OpenAPI add-on.
  • Added lint - CI workflow for running lint on OpenAPI spec.

Insight 📝

This is the first part of the implementation, I intend to implement:

  • Part 2: Add an endpoint (/api/docs/openapi) to support generating OpenAPI docs by using Spotlight
  • Part 3: Add mock server

Proof Of Work 📹

Generated the project successfully
image

The generated project
image

@sanG-github sanG-github added this to the 5.8.0 milestone Aug 31, 2023
@sanG-github sanG-github self-assigned this Aug 31, 2023
@sanG-github sanG-github force-pushed the feature/gh446-add-openapi branch from d23baf4 to 41784d1 Compare September 6, 2023 03:09
@sanG-github sanG-github marked this pull request as ready for review September 6, 2023 03:29
@sanG-github sanG-github changed the title [#466][Part 1] Add OpenAPI to support creating API documentation with OpenAPI [#446][Part 1] Add OpenAPI to support creating API documentation with OpenAPI Sep 7, 2023
malparty
malparty requested changes Sep 11, 2023
View reviewed changes
Copy link
Member

@malparty malparty left a comment

Choose a reason for hiding this comment

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

Let's be sure to not "pollute" the projects that will not select the OpenAPI addons in the future. We should only add content from the openapi addons scripts. Not from the Web or API variant 🙏

.gitignore.rb Outdated Show resolved Hide resolved
.template/addons/github/.github/workflows/lint_docs.yml.tt Outdated Show resolved Hide resolved
.spectral.yml Outdated Show resolved Hide resolved
.template/addons/openapi/docs/openapi/examples/requests/.keepfile Outdated Show resolved Hide resolved
.template/variants/api/package.json.rb Outdated Show resolved Hide resolved
.template/variants/web/package.json.rb Outdated Show resolved Hide resolved
@malparty malparty modified the milestones: 5.8.0, 5.9.0 Sep 14, 2023
@sanG-github sanG-github marked this pull request as draft September 20, 2023 07:02
@sanG-github sanG-github force-pushed the feature/gh446-add-openapi branch 3 times, most recently from 2ce3272 to 045765e Compare September 21, 2023 04:25
@sanG-github sanG-github marked this pull request as ready for review September 21, 2023 04:58
suho
suho reviewed Sep 21, 2023
View reviewed changes
Makefile Outdated Show resolved Hide resolved
@sanG-github sanG-github force-pushed the feature/gh446-add-openapi branch from cd0c9f3 to d083aa7 Compare September 21, 2023 07:57
@sanG-github sanG-github linked an issue Sep 22, 2023 that may be closed by this pull request
Add OpenAPI to support creating API documentation with OpenAPI #446
Closed
@sanG-github
[#446] Fix linting
7f51819
@sanG-github
[#446] Ignore file violating eslint rules
6d69b14
@sanG-github
[#446] Add tests
da66318
@sanG-github
[#446] Update failed tests
87dcab8
@sanG-github
[#446] Update failed tests
4a8c6be
@sanG-github
[#446] Toggle failed tests
bcbf812
@sanG-github
[#446] Add package.json for api
ca144e4
@sanG-github
[#446] Update keep file name
9a531b6
@sanG-github
[#446] Update keep file name in tests
84656db
@sanG-github
[#446] Move files inside addon folder
265afd5
@sanG-github
[#446] Make OpenAPI optional for WEB
965267e
@sanG-github
[#446] Update the condition to copy file
4b54c09
@sanG-github
[#446] Fix linting
cfa258d
@sanG-github
[#446] Update the failed generating
0cae75f
@sanG-github
[#446] Update logic for readable
5213731
@sanG-github
[#446] Update Makefile
399fa5f
@sanG-github
[#446] Add tests for addon
07f8014
@sanG-github
[#446] Update failed tests
38bd781
@sanG-github
[#446] Update Makefile
8ba4716
@sanG-github
[#446] Add lint docs rely on OpenAPI
8bb1b77
@sanG-github
[#446] Update tests localtion
201b962
@sanG-github
[#446] Use latest patch version for the external packages?
686013b
@sanG-github
[#446] Update the Makefile options
7e69c20
@sanG-github sanG-github force-pushed the feature/gh446-add-openapi branch from 5695671 to 7e69c20 Compare September 26, 2023 04:08
@malparty malparty added this pull request to the merge queue Sep 27, 2023
Merged via the queue into develop with commit f918404 Sep 27, 2023
5 checks passed
@malparty malparty deleted the feature/gh446-add-openapi branch September 27, 2023 02:37
@malparty malparty mentioned this pull request Oct 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@malparty malparty malparty approved these changes

@suho suho suho approved these changes

@olivierobert olivierobert olivierobert approved these changes

@rosle rosle Awaiting requested review from rosle

@andyduong1920 andyduong1920 Awaiting requested review from andyduong1920 andyduong1920 is a code owner

@bterone bterone Awaiting requested review from bterone bterone is a code owner

@byhbt byhbt Awaiting requested review from byhbt byhbt is a code owner

@carryall carryall Awaiting requested review from carryall carryall is a code owner

@hoangmirs hoangmirs Awaiting requested review from hoangmirs hoangmirs is a code owner

@longnd longnd Awaiting requested review from longnd longnd is a code owner

@tyrro tyrro Awaiting requested review from tyrro

Assignees

@sanG-github sanG-github

Labels
type : feature
Projects
None yet
Milestone
5.9.0
Development

Successfully merging this pull request may close these issues.

Add OpenAPI to support creating API documentation with OpenAPI
5 participants
@sanG-github @olivierobert @hoangmirs @suho @malparty