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

Add OpenAPI to support creating API documentation with OpenAPI #446

Closed
suho opened this issue Jul 25, 2023 · 0 comments · Fixed by #466 or #464
Closed

Add OpenAPI to support creating API documentation with OpenAPI #446

suho opened this issue Jul 25, 2023 · 0 comments · Fixed by #466 or #464
Assignees
@sanG-github
Labels
type : feature

Comments

@suho
Copy link
Member

suho commented Jul 25, 2023 •
edited by sanG-github
Loading

Why

The team now has OpenAPI Training Path to learn and practice. OpenAPI on Compass for developers to follow conventions and best practices. NO OpenAPI boilerplates currently exist in the rails templates to support web developers in creating API documentation with OpenAPI.

Acceptance Criteria

  • Add OpenAPI addon as a required addon in the template.
  • Add OpenAPI tooling (Spectral, Elements, Lint).
  • Create an endpoint (e.g., GET {{base_url}}/api/docs/openapi) to access the API documentation through the browser.
  • Add Mock Server with Prism (related to this API Mock Server with OpenAPI).
  • Add CI/CD workflow to run linting and deploy mock server to fly.io.

Resources

Who Benefits?

Everyone
@suho suho self-assigned this Jul 25, 2023
@suho suho assigned sanG-github and unassigned suho Aug 10, 2023
@suho suho mentioned this issue Aug 28, 2023
Merged
sanG-github added a commit that referenced this issue Aug 29, 2023
@sanG-github
[#446] Add OpenAPI to template
b8b985b
sanG-github added a commit that referenced this issue Aug 30, 2023
@sanG-github
[#446] Update folder
1e41910
sanG-github added a commit that referenced this issue Aug 30, 2023
@sanG-github
[#446] Fix linting
4c19e2a
sanG-github added a commit that referenced this issue Aug 31, 2023
@sanG-github
[#446] Ignore file violating eslint rules
9cdeeb6
sanG-github added a commit that referenced this issue Aug 31, 2023
@sanG-github
[#446] Add endpoint and template html
e9e85bf
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Add tests
b1d3e2a
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Add tests
950657d
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Update failed tests
96a9b3d
@sanG-github sanG-github mentioned this issue Sep 6, 2023
Merged
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Update failed tests
0c0ec8d
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Toggle failed tests
d50449d
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Add package json for web
6e3fdc2
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Remove cache
d23baf4
sanG-github added a commit that referenced this issue Sep 6, 2023
@sanG-github
[#446] Add package.json for api
41784d1
sanG-github added a commit that referenced this issue Sep 7, 2023
@sanG-github
[#446] Add endpoint and template html
84fa5c7
sanG-github added a commit that referenced this issue Sep 7, 2023
@sanG-github
[#446] Add test
d9bb64a
sanG-github added a commit that referenced this issue Sep 7, 2023
@sanG-github
[#446] Add files support creating mock server
d3a76f4
sanG-github added a commit that referenced this issue Sep 7, 2023
@sanG-github
[#446] Add tests
bf81f43
This was referenced Sep 7, 2023
Merged
Merged
sanG-github added a commit that referenced this issue Sep 14, 2023
@sanG-github
[#446] Update keep file name
935447b
sanG-github added a commit that referenced this issue Sep 18, 2023
@sanG-github
[#446] Update keep file name in tests
a083087
sanG-github added a commit that referenced this issue Sep 18, 2023
@sanG-github
[#446] Rollback yarn/node
e47d532
sanG-github added a commit that referenced this issue Sep 18, 2023
@sanG-github
[#446] Don't run system tests
1276435
sanG-github added a commit that referenced this issue Sep 18, 2023
@sanG-github
[#446] Rollback Makefile
3e762bb
github-merge-queue bot pushed a commit that referenced this issue Sep 27, 2023
@sanG-github
[#446][Part 1] Add OpenAPI to support creating API documentation with…
f918404 
… OpenAPI (#464)

* [#446] Add OpenAPI to template

* [#446] Update folder

* [#446] Fix linting

* [#446] Ignore file violating eslint rules

* [#446] Add tests

* [#446] Update failed tests

* [#446] Update failed tests

* [#446] Toggle failed tests

* [#446] Add package.json for api

* [#446] Update keep file name

* [#446] Update keep file name in tests

* [#446] Move files inside addon folder

* [#446] Make OpenAPI optional for WEB

* [#446] Update the condition to copy file

* [#446] Fix linting

* [#446] Update the failed generating

* [#446] Update logic for readable

* [#446] Update Makefile

* [#446] Add tests for addon

* [#446] Update failed tests

* [#446] Update Makefile

* [#446] Add lint docs rely on OpenAPI

* [#446] Update tests localtion

* [#446] Use latest patch version for the external packages?

* [#446] Update the Makefile options
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Add endpoint and template html
88df4ce
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Update route
02eef2f
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Rename stoplight to openapi
c1d8570
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Remove redundant route
cf74771
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Update tests location
98d42ae
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Add files support creating mock server
6b90e03
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Add tests
d8976e1
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Move Fly.io deployment file to addon folder
cd7d670
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Only apply Dockerfile when installing OpenAPI
b4ca111
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Ask when adding Mock server
61d2594
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Update Makefile
32eedb2
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Fix wrong rebased
330368f
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Optimize flow
3406627
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Add missing comment
d20d1ae
sanG-github added a commit that referenced this issue Sep 28, 2023
@sanG-github
[#446] Move tests to proper place
7a73e42
github-merge-queue bot pushed a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446][Part 2] Add OpenAPI to support creating API documentation with…
fe2f59a 
… OpenAPI (#465)

* [#446] Add endpoint and template html

* [#446] Update route

* [#446] Rename stoplight to openapi

* [#446] Remove redundant route

* [#446] Update tests location
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Add files support creating mock server
5fab3b7
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Add tests
44e64a6
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Move Fly.io deployment file to addon folder
d6dac93
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Only apply Dockerfile when installing OpenAPI
a9c269b
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Ask when adding Mock server
d1accfb
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Update Makefile
721c172
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Fix wrong rebased
5d332b1
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Optimize flow
31fb52e
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Add missing comment
fc9ea66
sanG-github added a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446] Move tests to proper place
1688599
github-merge-queue bot pushed a commit that referenced this issue Sep 29, 2023
@sanG-github
[#446][Part3] Add OpenAPI to support creating API documentation with …
2affbce 
…OpenAPI (#466)

* [#446] Add files support creating mock server

* [#446] Add tests

* [#446] Move Fly.io deployment file to addon folder

* [#446] Only apply Dockerfile when installing OpenAPI

* [#446] Ask when adding Mock server

* [#446] Update Makefile

* [#446] Fix wrong rebased

* [#446] Optimize flow

* [#446] Add missing comment

* [#446] Move tests to proper place
@malparty malparty mentioned this issue Oct 2, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sanG-github sanG-github

Labels
type : feature
Projects
None yet
Milestone
No milestone
2 participants
@suho @sanG-github