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

Swagger docs #11

Open
Blacksmoke16 opened this issue Mar 29, 2019 · 0 comments
Open

Swagger docs #11

Blacksmoke16 opened this issue Mar 29, 2019 · 0 comments
Labels
component:framework kind:feature Brand new functionality

Comments

@Blacksmoke16
Copy link
Member

Blacksmoke16 commented Mar 29, 2019 •
edited
Loading

Ability to generate OAS 3.0 compliant docs.

As much as possible should be auto generated via route/models/shard.yml items. New annotations, or new fields on existing annotations could be added for ungenerable data.

Also add a new section to the athena.yml config to store core app information for the swagger file.

Could build docs in JSON format to auto define property title/descriptions as well.
@Blacksmoke16 Blacksmoke16 mentioned this issue Apr 2, 2019
Closed
4 tasks
@Blacksmoke16 Blacksmoke16 added this to the 0.5.0 milestone Apr 3, 2019
@Blacksmoke16 Blacksmoke16 modified the milestones: 0.5.0, 0.6.0 Apr 16, 2019
@Blacksmoke16 Blacksmoke16 removed this from the 0.6.0 milestone Apr 20, 2019
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Use standard ubuntu image for deploy_docs (#11)
dc37469
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Add Spec module and TracableEventDispatcher (#11)
fd2c43a
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Bump versions (#11)
1020375
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Finish migration to mkdocs (#11)
e0287a9
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Update links to navigate to the new API docs (#11)
c439857
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Updates for Athena 0.13.0 (#11)
fe9e268 
* Remove redundant build CI step
* Add negotiation component API docs
* Refactor config docs based on new implementation
* Finish porting docs to mkdocs (#9)
* Fix routing related doc warnings
* Build docs in strict mode
* Update python deps
* Make horizontal scroll bar a bit taller
* Doc Updates (#10)
* Add static file listener to cookbook
* Add section about validations
* Add section on returning files
* Bump deps
Blacksmoke16 added a commit that referenced this issue Dec 15, 2021
@Blacksmoke16
Correctly yield in the test macro helper (#11)
4dc163c
@Blacksmoke16 Blacksmoke16 added component:framework kind:feature Brand new functionality and removed kind:feature labels Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component:framework kind:feature Brand new functionality
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Blacksmoke16