Changeset View
Changeset View
Standalone View
Standalone View
swh/web/tests/api/test_apidoc.py
| Show All 33 Lines | :resheader Content-Type: this depends on :http:header:`Accept` header | ||||
| of request | of request | ||||
| :<json int n: sample input integer | :<json int n: sample input integer | ||||
| :<json string s: sample input string | :<json string s: sample input string | ||||
| :<json array a: sample input array | :<json array a: sample input array | ||||
| :>json object author: information about the author of the revision | :>json object author: information about the author of the revision | ||||
| :>json object committer: information about the committer of the revision | :>json object committer: information about the committer of the revision | ||||
| :>json string committer_date: ISO representation of the commit date | :>json string committer_date: RFC3339 representation of the commit date | ||||
| (in UTC) | :>json string date: RFC3339 representation of the revision date | ||||
| :>json string date: ISO representation of the revision date (in UTC) | |||||
| :>json string directory: the unique identifier that revision points to | :>json string directory: the unique identifier that revision points to | ||||
| :>json string directory_url: link to | :>json string directory_url: link to | ||||
| :http:get:`/api/1/directory/(sha1_git)/[(path)/]` to get information | :http:get:`/api/1/directory/(sha1_git)/[(path)/]` to get information | ||||
| about the directory associated to the revision | about the directory associated to the revision | ||||
| :>json string id: the revision unique identifier | :>json string id: the revision unique identifier | ||||
| :>json boolean merge: whether or not the revision corresponds to a merge | :>json boolean merge: whether or not the revision corresponds to a merge | ||||
| commit | commit | ||||
| :>json string message: the message associated to the revision | :>json string message: the message associated to the revision | ||||
| ▲ Show 20 Lines • Show All 230 Lines • ▼ Show 20 Lines | expected_returns = [ | ||||
| { | { | ||||
| "name": "committer", | "name": "committer", | ||||
| "type": "object", | "type": "object", | ||||
| "doc": "information about the committer of the revision", | "doc": "information about the committer of the revision", | ||||
| }, | }, | ||||
| { | { | ||||
| "name": "committer_date", | "name": "committer_date", | ||||
| "type": "string", | "type": "string", | ||||
| "doc": "ISO representation of the commit date (in UTC)", | "doc": "RFC3339 representation of the commit date", | ||||
| }, | }, | ||||
| { | { | ||||
| "name": "date", | "name": "date", | ||||
| "type": "string", | "type": "string", | ||||
| "doc": "ISO representation of the revision date (in UTC)", | "doc": "RFC3339 representation of the revision date", | ||||
| }, | }, | ||||
| { | { | ||||
| "name": "directory", | "name": "directory", | ||||
| "type": "string", | "type": "string", | ||||
| "doc": "the unique identifier that revision points to", | "doc": "the unique identifier that revision points to", | ||||
| }, | }, | ||||
| { | { | ||||
| "name": "directory_url", | "name": "directory_url", | ||||
| ▲ Show 20 Lines • Show All 184 Lines • Show Last 20 Lines | |||||