You've already forked oncall
mirror of
https://github.com/linkedin/oncall.git
synced 2025-11-28 23:20:23 +02:00
docs: remove redundant route docstring
This commit is contained in:
@@ -2,7 +2,7 @@
|
|||||||
#
|
#
|
||||||
|
|
||||||
# You can set these variables from the command line.
|
# You can set these variables from the command line.
|
||||||
SPHINXOPTS =
|
SPHINXOPTS = -E
|
||||||
SPHINXBUILD = sphinx-build
|
SPHINXBUILD = sphinx-build
|
||||||
SPHINXPROJ = Oncall
|
SPHINXPROJ = Oncall
|
||||||
SOURCEDIR = source
|
SOURCEDIR = source
|
||||||
@@ -17,8 +17,8 @@ help:
|
|||||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||||
%: Makefile
|
%: Makefile
|
||||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||||
|
|
||||||
|
|
||||||
livehtml:
|
livehtml:
|
||||||
sphinx-autobuild -b html -H 0.0.0.0 --ignore '*~' "$(SOURCEDIR)" "$(BUILDDIR)/html"
|
sphinx-autobuild -b html -H 0.0.0.0 --ignore '*~' "$(SOURCEDIR)" "$(BUILDDIR)/html" -E
|
||||||
|
|||||||
@@ -65,8 +65,6 @@ constraints = {
|
|||||||
|
|
||||||
def on_get(req, resp):
|
def on_get(req, resp):
|
||||||
"""
|
"""
|
||||||
http:get:: /api/v0/events
|
|
||||||
|
|
||||||
Search for events. Allows filtering based on a number of parameters, detailed below.
|
Search for events. Allows filtering based on a number of parameters, detailed below.
|
||||||
|
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|||||||
@@ -15,8 +15,6 @@ from ...utils import create_audit
|
|||||||
|
|
||||||
def on_get(req, resp, team, roster):
|
def on_get(req, resp, team, roster):
|
||||||
"""
|
"""
|
||||||
http:get:: /api/v0/teams/(str:team_name)/rosters
|
|
||||||
|
|
||||||
Get user and schedule info for a roster
|
Get user and schedule info for a roster
|
||||||
|
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|||||||
@@ -14,8 +14,6 @@ from ...constants import ROSTER_USER_ADDED
|
|||||||
|
|
||||||
def on_get(req, resp, team, roster):
|
def on_get(req, resp, team, roster):
|
||||||
"""
|
"""
|
||||||
http:get:: /api/v0/teams/team-foo/rosters/roster-foo/users
|
|
||||||
|
|
||||||
Get all users for a team's roster
|
Get all users for a team's roster
|
||||||
|
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|||||||
@@ -23,8 +23,6 @@ get_oncall_query = '''
|
|||||||
|
|
||||||
def on_get(req, resp, team, role):
|
def on_get(req, resp, team, role):
|
||||||
"""
|
"""
|
||||||
http:get:: /api/v0/teams/(str:team_name)/oncall/(str:role)
|
|
||||||
|
|
||||||
Get current active event for team based on given role.
|
Get current active event for team based on given role.
|
||||||
|
|
||||||
**Example request**:
|
**Example request**:
|
||||||
|
|||||||
@@ -24,8 +24,6 @@ constraints = {
|
|||||||
|
|
||||||
def on_get(req, resp):
|
def on_get(req, resp):
|
||||||
'''
|
'''
|
||||||
http:get:: /api/v0/teams
|
|
||||||
|
|
||||||
Search for team names. Allows filtering based on a number of parameters, detailed below.
|
Search for team names. Allows filtering based on a number of parameters, detailed below.
|
||||||
Returns list of matching team names. If "active" parameter is unspecified, defaults to
|
Returns list of matching team names. If "active" parameter is unspecified, defaults to
|
||||||
True (only displaying undeleted teams)
|
True (only displaying undeleted teams)
|
||||||
|
|||||||
Reference in New Issue
Block a user