Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
schedules
schedules
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 11
    • Issues 11
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • SRCT
  • schedulesschedules
  • Issues
  • #13

Closed
Open
Opened Aug 13, 2018 by Zac Wood@zwood2Owner
  • Report abuse
  • New issue
Report abuse New issue

Add API Documentation

Summary

For users developing with the Schedules API, it would be really useful to have nice documentation so they know which endpoints are available and how to use them. Fortunately, there are some really nice Rails gems that make it super easy to generate beautiful and dynamic documentation.

The docs should be publically available at an endpoint like /api/documentation.

Helpful Links

https://github.com/Apipie/apipie-rails

Edited Sep 04, 2018 by Zac Wood
To upload designs, you'll need to enable LFS and have admin enable hashed storage. More information
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: srct/schedules#13