Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Support
    • Submit feedback
    • Contribute to GitLab
  • Sign in
beat.web
beat.web
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 54
    • Issues 54
    • List
    • Boards
    • Labels
    • Milestones
  • Merge Requests 2
    • Merge Requests 2
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • beat
  • beat.webbeat.web
  • Issues
  • #536

Closed
Open
Opened Sep 05, 2019 by Zohreh MOSTAANI@zmostaani
  • Report abuse
  • New issue
Report abuse New issue

Some of the Models defined in django are not well documented

The "swagger.yaml" file that includes the beat.web api information that can be rendered into the sphinx documentation does not include complete information for all the models included in a response object. Some of the basic ones are shown though which means that the package produces this yaml file is working as expected.

It seems that those objects which are not shown, are not well documented in the code and because there are several layers of inheritance for each class, it is difficult to find where exactly the problem lies.

With a brief discussion with @samuel.gaist we tried something fast but it did not work. It required a deeper dive into the implementation.

Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
0
Labels
None
Assign labels
  • View project labels
Reference: beat/beat.web#536