Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Fix indentation in lines started with a hyphen.

This commit is contained in:
Yago González 2017-05-23 18:51:14 -07:00 committed by Tim Abbott
parent 1fc1cafd6f
commit 90301a4d93
1 changed files with 158 additions and 158 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

316
static/yaml/zulip.yaml
View File

@ -23,12 +23,12 @@ info:
# The base configuration for this API # The base configuration for this API
basePath: /api/v1 basePath: /api/v1
schemes: schemes:
- http - http
- https - https
consumes: consumes:
- application/x-www-form-urlencoded - application/x-www-form-urlencoded
produces: produces:
- application/json - application/json
###################### ######################
# Endpoint definitions # Endpoint definitions
@ -40,33 +40,33 @@ paths:
description: Send a message description: Send a message
operationId: addMessage operationId: addMessage
parameters: parameters:
- name: type - name: type
in: formData in: formData
description: One of {`private`, `stream`} description: One of {`private`, `stream`}
required: true required: true
type: string type: string
- name: content - name: content
in: formData in: formData
description: The content of the message. Maximum message size of 10000 bytes. description: The content of the message. Maximum message size of 10000 bytes.
required: true required: true
type: string type: string
- name: to - name: to
in: formData in: formData
description: | description: |
In the case of a stream message, a string identifying the In the case of a stream message, a string identifying the
stream. In the case of a private message, a JSON-encoded stream. In the case of a private message, a JSON-encoded
list containing the usernames of the recipients. list containing the usernames of the recipients.
required: true required: true
type: string type: string
- name: subject - name: subject
in: formData in: formData
description: | description: |
The topic for the message (Only required if type is `stream`). The topic for the message (Only required if type is `stream`).
Maximum length of 60 characters. Maximum length of 60 characters.
required: false required: false
type: string type: string
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: | description: |
@ -83,39 +83,39 @@ paths:
description: Register a queue to receive new messages description: Register a queue to receive new messages
operationId: registerQueue operationId: registerQueue
parameters: parameters:
- name: event_types - name: event_types
in: formData in: formData
description: | description: |
A JSON-encoded array indicating which types of A JSON-encoded array indicating which types of
events you're interested in. Values that you might find events you're interested in. Values that you might find
useful include: useful include:
`message` (messages), `message` (messages),
`subscriptions` (changes in your subscriptions), `subscriptions` (changes in your subscriptions),
`realm_user` (changes in the list of users in your realm), and `realm_user` (changes in the list of users in your realm), and
`pointer` (changes in your pointer). `pointer` (changes in your pointer).
If you do not specify this argument, you will receive all If you do not specify this argument, you will receive all
events, and have to filter out the events not relevant to events, and have to filter out the events not relevant to
your client in your client code. For most applications, one your client in your client code. For most applications, one
is only interested in messages, so one specifies: is only interested in messages, so one specifies:
`event_types=["message"]` `event_types=["message"]`
required: false required: false
type: string type: string
- name: apply_markdown - name: apply_markdown
in: formData in: formData
description: | description: |
Set to `true` if you would like the content to Set to `true` if you would like the content to
be rendered in HTML format (by default, the API returns the be rendered in HTML format (by default, the API returns the
raw text that the user entered.) raw text that the user entered.)
required: false required: false
type: string type: string
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: | description: |
@ -222,32 +222,32 @@ paths:
description: Get new events from an events queue description: Get new events from an events queue
operationId: getEvents operationId: getEvents
parameters: parameters:
- name: queue_id - name: queue_id
in: query in: query
description: The ID of a queue that you registered via `POST /api/v1/register`. description: The ID of a queue that you registered via `POST /api/v1/register`.
required: true required: true
type: string type: string
- name: last_event_id - name: last_event_id
in: query in: query
description: | description: |
The highest event ID in this queue that you've received and The highest event ID in this queue that you've received and
wish to acknowledge. See the code for `call_on_each_event` in wish to acknowledge. See the code for `call_on_each_event` in
the zulip Python module for an example implementation of the zulip Python module for an example implementation of
correctly processing each event exactly once. correctly processing each event exactly once.
required: true required: true
type: string type: string
- name: dont_block - name: dont_block
in: query in: query
description: | description: |
Set to `true` if the client is requesting a Set to `true` if the client is requesting a
nonblocking reply. If not specified, the request will block nonblocking reply. If not specified, the request will block
until either a new event is available or a few minutes have until either a new event is available or a few minutes have
passed, in which case the server will send the client a passed, in which case the server will send the client a
heartbeat event. heartbeat event.
required: false required: false
type: string type: string
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: | description: |
@ -264,22 +264,22 @@ paths:
description: Get presence data for another user. description: Get presence data for another user.
operationId: getPresence operationId: getPresence
parameters: parameters:
- name: user - name: user
in: path in: path
description: Enter email address description: Enter email address
required: true required: true
type: string type: string
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: The response from a successful call description: The response from a successful call
schema: schema:
type: object type: object
required: required:
- msg - msg
- result - result
- presence - presence
properties: properties:
msg: msg:
type: string type: string
@ -292,24 +292,24 @@ paths:
description: Upload a file, and print the corresponding URI. description: Upload a file, and print the corresponding URI.
operationId: userUploads operationId: userUploads
consumes: consumes:
- multipart/form-data - multipart/form-data
parameters: parameters:
- name: file - name: file
in: formData in: formData
description: File to be uploaded description: File to be uploaded
type: file type: file
required: true required: true
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: Success description: Success
schema: schema:
type: object type: object
required: required:
- msg - msg
- result - result
- uri - uri
properties: properties:
msg: msg:
type: string type: string
@ -322,22 +322,22 @@ paths:
get: get:
description: Retrieve the content of a message. description: Retrieve the content of a message.
parameters: parameters:
- name: message_id - name: message_id
in: path in: path
description: ID of the message to be retrieved. description: ID of the message to be retrieved.
type: integer type: integer
required: true required: true
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: Success. description: Success.
schema: schema:
type: object type: object
required: required:
- msg - msg
- result - result
- raw_content - raw_content
properties: properties:
msg: msg:
type: string type: string
@ -349,26 +349,26 @@ paths:
patch: patch:
description: Edit a message that has already been sent. description: Edit a message that has already been sent.
parameters: parameters:
- name: message_id - name: message_id
in: path in: path
description: ID of the message to be edited. description: ID of the message to be edited.
type: integer type: integer
required: true required: true
- name: subject - name: subject
in: query in: query
description: Message's topic. description: Message's topic.
type: string type: string
- name: propagate_mode - name: propagate_mode
in: query in: query
description: propagation mode description: propagation mode
type: string type: string
default: "change_one" default: "change_one"
- name: content - name: content
in: query in: query
description: Message's body. description: Message's body.
type: string type: string
security: security:
- basicAuth: [] - basicAuth: []
responses: responses:
'200': '200':
description: Success description: Success
@ -382,11 +382,11 @@ paths:
msg: msg:
type: string type: string
enum: enum:
- Your organization has turned off message editing - Your organization has turned off message editing
- You don't have permission to edit this message - You don't have permission to edit this message
- The time limit for editing this message has past - The time limit for editing this message has past
- Nothing to change - Nothing to change
- Topic can't be empty - Topic can't be empty
result: result:
type: string type: string
@ -408,8 +408,8 @@ definitions:
JsonResponse: JsonResponse:
type: object type: object
required: required:
- msg - msg
- result - result
properties: properties:
msg: msg:
type: string type: string
@ -418,14 +418,14 @@ definitions:
JsonSuccess: JsonSuccess:
allOf: allOf:
- $ref: '#/definitions/JsonResponse' - $ref: '#/definitions/JsonResponse'
properties: properties:
msg: msg:
default: success default: success
JsonError: JsonError:
allOf: allOf:
- $ref: '#/definitions/JsonResponse' - $ref: '#/definitions/JsonResponse'
properties: properties:
msg: msg:
default: error default: error
@ -434,9 +434,9 @@ definitions:
MessageResponse: MessageResponse:
type: object type: object
required: required:
- msg - msg
- result - result
- id - id
properties: properties:
msg: msg:
type: string type: string
@ -450,10 +450,10 @@ definitions:
RegisterResponse: RegisterResponse:
type: object type: object
required: required:
- msg - msg
- result - result
- queue_id - queue_id
- last_event_id - last_event_id
properties: properties:
msg: msg:
type: string type: string
@ -575,10 +575,10 @@ definitions:
stream: stream:
type: object type: object
required: required:
- stream_id - stream_id
- description - description
- name - name
- invite_only - invite_only
properties: properties:
stream_id: stream_id:
type: integer type: integer
@ -593,11 +593,11 @@ definitions:
user: user:
type: object type: object
required: required:
- is_admin - is_admin
- user_id - user_id
- email - email
- full_name - full_name
- is_bot - is_bot
properties: properties:
is_admin: is_admin:
type: boolean type: boolean
@ -615,9 +615,9 @@ definitions:
EventsResponse: EventsResponse:
type: object type: object
required: required:
- msg - msg
- result - result
- events - events
properties: properties:
msg: msg:
type: string type: string
@ -634,8 +634,8 @@ definitions:
event: event:
type: object type: object
required: required:
- type - type
- id - id
properties: properties:
type: type:
type: string type: string