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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: better OpenAPI description and documentation links #18

Closed
2 tasks done
0-vortex opened this issue Aug 6, 2022 · 4 comments
Closed
2 tasks done

Feature: better OpenAPI description and documentation links #18

0-vortex opened this issue Aug 6, 2022 · 4 comments
Assignees
@0-vortex
Labels
馃挕 feature A label to note if work is a feature 馃憖 needs triage released on @beta released
Milestone
1.0 ready supabas...

Comments

@0-vortex
Copy link
Contributor

0-vortex commented Aug 6, 2022

Type of feature

馃摑 Documentation

Current behavior

We set the version, description and title automatically from package.json, producing a very brute description: https://beta.api.opensauced.pizza/docs

Suggested solution

Extend our OAS3 configuration with other properties from @nestjs/swagger/dist/document-builder.d.ts

Additional context

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributing Docs

  • I agree to follow this project's Contribution Docs
@0-vortex 0-vortex added 馃憖 needs triage 馃挕 feature A label to note if work is a feature labels Aug 6, 2022
@0-vortex 0-vortex added this to the 1.0 ready supabase conversion milestone Aug 6, 2022
@0-vortex
Copy link
Contributor Author

0-vortex commented Aug 6, 2022

.take

@github-actions
Copy link

github-actions bot commented Aug 6, 2022

Thanks for taking this on! If you have not already, join the conversation in our Discord

0-vortex added a commit that referenced this issue Aug 6, 2022
@0-vortex
feat: add better swagger document links
eba258a 
closes #18
github-actions bot pushed a commit that referenced this issue Aug 6, 2022
@0-vortex @open-sauced
chore(minor): release 1.8.0-beta.5 on beta channel [skip ci]
2cf23c1 
## [1.8.0-beta.5](v1.8.0-beta.4...v1.8.0-beta.5) (2022-08-06)

### 馃崟 Features

* add better swagger document links ([eba258a](eba258a)), closes [#18](#18)

### 馃 Build System

* update dependencies ([62b3eea](62b3eea))
@github-actions
Copy link

github-actions bot commented Aug 6, 2022

馃帀 This issue has been resolved in version 1.8.0-beta.5 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

github-actions bot pushed a commit that referenced this issue Aug 12, 2022
@0-vortex @open-sauced
chore(minor): release 1.8.0 [skip ci]
13eca80 
## [1.8.0](v1.7.12...v1.8.0) (2022-08-12)

### 馃摑 Documentation

* add deployment links and apidocs diagrams ([d77ea52](d77ea52))
* update readme badges ([17c54b9](17c54b9))

### 馃崟 Features

* add better swagger document links ([eba258a](eba258a)), closes [#18](#18)
* add get repository by id and full name ([4552c66](4552c66))
* add proper metadata fields to entities and typeorm soft delete ([#13](#13)) ([af531e4](af531e4)), closes [#10](#10)

### 馃 Build System

* update dependencies ([62b3eea](62b3eea))
@github-actions
Copy link

馃帀 This issue has been resolved in version 1.8.0 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@0-vortex 0-vortex

Labels
馃挕 feature A label to note if work is a feature 馃憖 needs triage released on @beta released
Projects
None yet
Milestone
1.0 ready supabase conversion
Development

No branches or pull requests
1 participant
@0-vortex