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

317 lines
9.2 KiB
JSON
Raw Normal View History

api/render-message: Make code examples and fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_example to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-26 22:11:42 +01:00
{
"render-message":{
"msg":"",
"rendered":"<p><strong>foo<\/strong><\/p>",
"result":"success"
api/stream-message: Make code examples and fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-27 22:26:16 +01:00
},
"stream-message": {
"msg":"",
"id":134,
"result":"success"
api/private-message: Make code examples and fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-27 22:56:36 +01:00
},
"private-message": {
"msg":"",
"id":134,
"result":"success"
api/update-message: Make code examples and fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-27 23:18:19 +01:00
},
"update-message": {
"msg":"",
"result":"success"
api/get-stream-id: Make code examples and fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-28 00:06:45 +01:00
},
"get-stream-id": {
"stream_id":15,
"result":"success",
"msg":""
api/get-subscribed-streams: Make code examples/fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-28 00:39:16 +01:00
},
"get-subscribed-streams": {
"msg":"",
"result":"success",
"subscriptions":[
{
"audible_notifications":true,
"color":"#e79ab5",
"description":"A Scandinavian country",
"desktop_notifications":true,
"email_address":"Denmark+187b4125ed36d6af8b5d03ef4f65c0cf@zulipdev.com:9981",
"in_home_view":true,
"invite_only":false,
"name":"Denmark",
"pin_to_top":false,
"push_notifications":false,
"stream_id":1,
"subscribers":[
"ZOE@zulip.com",
"hamlet@zulip.com",
"iago@zulip.com",
"othello@zulip.com",
"prospero@zulip.com"
]
},
{
"audible_notifications":true,
"color":"#e79ab5",
"description":"Located in the United Kingdom",
"desktop_notifications":true,
"email_address":"Scotland+f5786390183e60a1ccb18374f9d05649@zulipdev.com:9981",
"in_home_view":true,
"invite_only":false,
"name":"Scotland",
"pin_to_top":false,
"push_notifications":false,
"stream_id":3,
"subscribers":[
"ZOE@zulip.com",
"iago@zulip.com",
"othello@zulip.com",
"prospero@zulip.com"
]
},
{
"audible_notifications":true,
"color":"#e79ab5",
"description":"A city in Italy",
"desktop_notifications":true,
"email_address":"Verona+faaa92dc82cf143174ddc098a1c832ef@zulipdev.com:9981",
"in_home_view":true,
"invite_only":false,
"name":"Verona",
"pin_to_top":false,
"push_notifications":false,
"stream_id":5,
"subscribers":[
"AARON@zulip.com",
"ZOE@zulip.com",
"cordelia@zulip.com",
"hamlet@zulip.com",
"iago@zulip.com",
"othello@zulip.com",
"prospero@zulip.com"
]
},
{
"audible_notifications":false,
"color":"#76ce90",
"description":"New stream for testing",
"desktop_notifications":false,
"email_address":"new%0032stream+e1917b4fc733268e91fcc57cf79a9249@zulipdev.com:9981",
"in_home_view":true,
"invite_only":false,
"name":"new stream",
"pin_to_top":false,
"push_notifications":false,
"stream_id":6,
"subscribers":[
"iago@zulip.com"
]
}
]
api/get-all-streams: Make code examples/fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in zerver/lib/api_test_helpers.
2018-01-31 05:04:43 +01:00
},
"get-all-streams": {
"msg":"",
"result":"success",
"streams":[
{
"description":"A Scandinavian country",
"invite_only":false,
"name":"Denmark",
"stream_id":1
},
{
"description":"Yet another Italian city",
"invite_only":false,
"name":"Rome",
"stream_id":2
},
{
"description":"Located in the United Kingdom",
"invite_only":false,
"name":"Scotland",
"stream_id":3
},
{
"description":"A northeastern Italian city",
"invite_only":false,
"name":"Venice",
"stream_id":4
},
{
"description":"A city in Italy",
"invite_only":false,
"name":"Verona",
"stream_id":5
},
{
"description":"New stream for testing",
"invite_only":false,
"name":"new stream",
"stream_id":6
}
]
api/create-user: Make code examples/fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in zerver/lib/api_test_helpers.
2018-01-31 05:36:57 +01:00
},
"create-user": {
api/create-user: Test fixture for "email already in use" error. In templates/zerver/api/create-user.md, we have a sample fixture for when a client attempts to create a user with the same email as an existing user. This commit adds a test for that fixture. Note that this error payload is specific to client.create_user and this error payload isn't generated anywhere else.
2018-02-16 23:38:10 +01:00
"successful_response": {
"msg":"",
"result":"success"
},
"email_already_used_error": {
"msg": "Email 'newbie@zulip.com' already in use",
"result": "error"
}
api/get-profile: Make code examples/fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_examples to generate the example fixture and code example, so that both are tested in zerver/lib/api_test_helpers.
2018-01-31 06:06:56 +01:00
},
"get-profile": {
"client_id":"74c768b081076fdb3c4326256c17467e",
"email":"iago@zulip.com",
"full_name":"Iago",
"is_admin":true,
"is_bot":false,
"max_message_id":30,
"msg":"",
"pointer":-1,
"result":"success",
"short_name":"iago",
"user_id":5
api/add-subscriptions: Make fixtures/examples testable. api/add-subscriptions now uses the Markdown extension in bugdown/api_code_examples to generate code example and fixtures from tests.
2018-02-06 04:17:10 +01:00
},
"add-subscriptions": {
"without_principals": {
"already_subscribed":{
},
"msg":"",
"result":"success",
"subscribed":{
"iago@zulip.com":[
"new stream"
]
}
api/add-subscriptions: Test fixture for "already_subscribed". In templates/zerver/api/add-subscriptions, we have a sample fixture for when the user being subscribed is already subscribed to a stream. This commit tests that fixture against a running server.
2018-02-16 22:41:29 +01:00
},
"already_subscribed": {
"already_subscribed":{
"newbie@zulip.com":[
"new stream"
]
},
"msg":"",
"result":"success",
"subscribed":{
}
},
api docs: Test sample fixtures for unauthorized_errors_fatal. This commit adds tests for the sample fixtures for when unauthorized_errors_fatal is passed to client.add_subscriptions.
2018-02-16 23:22:45 +01:00
"unauthorized_errors_fatal_false": {
"already_subscribed":{
},
"msg":"",
"result":"success",
"subscribed":{
},
"unauthorized":[
"private_stream"
]
},
"unauthorized_errors_fatal_true": {
"msg":"Unable to access stream (private_stream).",
"result":"error"
}
api/remove-subscriptions: Make fixtures/examples testable. api/remove-subscriptions now uses the Markdown extension in bugdown/api_code_examples to generate code example and fixtures from tests.
2018-02-06 04:47:40 +01:00
},
"remove-subscriptions": {
"msg":"",
"not_subscribed":[
],
"removed":[
"new stream"
],
"result":"success",
api docs: Add page for common error payloads. We now have a separate page for common error payloads, for example, the payload for when the client's API key is invalid. All error payloads that are presented on this page will be tested similarly to our other non-error sample fixtures.
2018-02-06 21:04:07 +01:00
},
"invalid-api-key": {
"msg":"Invalid API key",
"result":"error"
api/get-all-users: Make fixtures/examples testable. api/get-all-users now uses the Markdown extension in bugdown/api_code_examples to generate code examples and fixtures from tests.
2018-02-07 04:25:23 +01:00
},
"get-all-users": {
"members":[
{
"avatar_url":"https:\/\/secure.gravatar.com\/avatar\/818c212b9f8830dfef491b3f7da99a14?d=identicon&version=1",
"bot_type":null,
"email":"AARON@zulip.com",
"full_name":"aaron",
"is_active":true,
"is_admin":false,
"is_bot":false,
"user_id":1
},
{
"avatar_url":"https:\/\/secure.gravatar.com\/avatar\/77c3871a68c8d70356156029fd0a4999?d=identicon&version=1",
"bot_type":null,
"email":"cordelia@zulip.com",
"full_name":"Cordelia Lear",
"is_active":true,
"is_admin":false,
"is_bot":false,
"user_id":3
},
{
"avatar_url":"https:\/\/secure.gravatar.com\/avatar\/0cbf08f3a355995fa2ec542246e35123?d=identicon&version=1",
"bot_type":null,
"email":"newbie@zulip.com",
"full_name":"New User",
"is_active":true,
"is_admin":false,
"is_bot":false,
"user_id":24
}
],
"msg":"",
"result":"success"
api_tests: Add tests for client.register_queue.
2018-02-07 05:00:10 +01:00
},
"register-queue": {
"last_event_id":-1,
"msg":"",
"queue_id":"1517975029:0",
"result":"success"
api/delete-queue: Make fixtures/examples testable. api/delete-queue now uses the Markdown extension in bugdown/api_code_examples to generate code examples and fixtures from tests.
2018-02-08 03:54:20 +01:00
},
api/delete-queue: Test fixture for BAD_EVENT_QUEUE_ID error. In templates/zerver/api/delete-queue.md, we have a sample fixture for when the queue_id passed to client.deregister_queue is not valid or the event queue in question has already been deleted. This commit tests that fixture. Note that this error payload is specific to client.deregister_queue.
2018-02-16 23:49:35 +01:00
"delete-queue":{
"successful_response": {
"msg":"",
"result":"success"
},
"bad_event_queue_id_error": {
"code":"BAD_EVENT_QUEUE_ID",
"msg":"Bad event queue id: 1518820930:1",
"queue_id":"1518820930:1",
"result":"error"
}
api docs: Test sample fixture for nonexistent stream error. In templates/zerver/api/stream-message.md, we have a sample fixture for when the target stream does not exist. This commit adds a test for that sample fixture.
2018-02-16 20:25:59 +01:00
},
"nonexistent-stream-error": {
"code":"BAD_REQUEST",
"msg":"Stream 'nonexistent_stream' does not exist",
"result":"error"
api docs: Test sample fixture for invalid PM recipient error. In templates/zerver/api/private-message.md, we have a sample fixture for when the email address of the PM's recipient is invalid. This commit makes sure that fixture is tested against a running server.
2018-02-16 20:35:05 +01:00
},
"invalid-pm-recipient-error": {
"code":"BAD_REQUEST",
"msg":"Invalid email 'eeshan@zulip.com'",
"result":"error"
api docs: Test sample fixture for missing request args error. This commit adds tests for the sample fixture for when a required request argument is missing. Also, it moves the sample fixture to common-error-payloads.md, since this is an error payload that is common to most requests (except the ones that don't take any arguments).
2018-02-16 21:03:50 +01:00
},
"missing-request-argument-error": {
"code":"REQUEST_VARIABLE_MISSING",
"msg":"Missing 'content' argument",
"result":"error",
"var_name":"content"
api docs: Test sample fixture for message edit permission error. In templates/zerver/api/update-message.md, we have a sample fixture for when a zulip.Client does not have the permission to update/edit a particular message. This commit adds a test for that fixture. Also, tools/test-api now also uses a non-admin client for this test, which might come in handy in the future.
2018-02-16 21:26:43 +01:00
},
"update-message-edit-permission-error": {
"code":"BAD_REQUEST",
"msg":"You don't have permission to edit this message",
"result":"error"
api docs: Test sample fixture for user not authorized error. This commit adds tests for the fixture for when a user is not authorized (perhaps because the query requires the use of admin privileges) for a particular query.
2018-02-16 21:58:03 +01:00
},
"user-not-authorized-error": {
"code":"BAD_REQUEST",
"msg":"User not authorized for this query",
"result":"error"
api docs: Test sample fixture for invalid stream name error. This commit adds a test for the sample fixture for when an invalid stream name is passed to a query that expects a valid stream name as an argument. This is the case with almost all of our queries documented under the sidebar heading "Streams". EDIT: Actually, I was wrong. This payload is highly specific to get-stream-id, so it shouldn't be a part of common-error-payloads at all.
2018-02-16 22:23:51 +01:00
},
"invalid-stream-error": {
"code":"BAD_REQUEST",
"msg":"Invalid stream name 'nonexistent'",
"result":"error"
api/render-message: Make code examples and fixtures testable. This commit uses the Markdown extension defined in zerver/lib/bugdown/api_generate_example to generate the example fixture and code example, so that both are tested in tools/lib/api_tests.
2018-01-26 22:11:42 +01:00
}
}