jenkins-bot has submitted this change and it was merged. (
https://gerrit.wikimedia.org/r/376139 )
Change subject: Add swagger spec for summary endpoint
......................................................................
Add swagger spec for summary endpoint
Bug: T174808
Change-Id: I976a2997507240dd162196e6f1ba86e171d9e98b
---
M spec.yaml
M test/features/app/spec.js
2 files changed, 147 insertions(+), 0 deletions(-)
Approvals:
BearND: Looks good to me, approved
jenkins-bot: Verified
diff --git a/spec.yaml b/spec.yaml
index 164553d..766154a 100644
--- a/spec.yaml
+++ b/spec.yaml
@@ -605,6 +605,85 @@
body: /.+/
# from routes/mobile-sections.js
+ /{domain}/v1/page/summary/{title}{/revision}{/tid}:
+ get:
+ tags:
+ - Page content
+ summary: Get a text extract of a page.
+ description: |
+ The summary response includes an extract of the first paragraph of the
page in plain text
+ and HTML as well as the type of page. This is useful for page previews.
+
+ Stability:
[unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)
+ produces:
+ - application/json; charset=utf-8;
profile="https://www.mediawiki.org/wiki/Specs/Summary/1.2.0";
+ parameters:
+ - name: title
+ in: path
+ description: "Page title. Use underscores instead of spaces.
Example: `Main_Page`."
+ type: string
+ required: true
+ - name: revision
+ in: path
+ description: "Revision of page content"
+ type: integer
+ required: false
+ - name: tid
+ in: path
+ description: "Time UUID of requested summary render"
+ type: string
+ required: false
+ responses:
+ '200':
+ description: The summary for the given page
+ schema:
+ $ref: '#/definitions/summary'
+ headers:
+ ETag:
+ description: >
+ Syntax: "{revision}/{tid}".
+ Example: "701384379/154d7bca-c264-11e5-8c2f-1b51b33b59fc"
+ '404':
+ description: Unknown page title or revision
+ schema:
+ $ref: '#/definitions/problem'
+ default:
+ description: Error
+ schema:
+ $ref: '#/definitions/problem'
+ x-amples:
+ - title: Get summary for Barack Obama
+ request:
+ params:
+ domain: en.wikipedia.org
+ title: Barack_Obama
+ response:
+ status: 200
+ headers:
+ etag: /.+/
+ content-type: /^application\/json/
+ body:
+ type: standard
+ title: /.+/
+ displaytitle: /.+/
+ pageid: /.+/
+ thumbnail:
+ source: /.+/
+ width: /.+/
+ height: /.+/
+ originalimage:
+ source: /.+/
+ width: /.+/
+ height: /.+/
+ lang: /.+/
+ dir: /.+/
+ revision: /.+/
+ timestamp: /.+/
+ description: /.+/
+ extract: /.+/
+ extract_html: /.+/
+
+ # from routes/mobile-sections.js
/{domain}/v1/page/mobile-sections/{title}:
get:
tags:
@@ -742,6 +821,69 @@
- width
- height
+ # see also RB v1/common_schemas.yaml
+ summary:
+ type: object
+ properties:
+ type:
+ type: string
+ description: Type of page summary
+ enum:
+ - standard
+ title:
+ type: string
+ description: The page title
+ displaytitle:
+ type: string
+ description: The page title how it should be shown to the user
+ pageid:
+ type: integer
+ description: The page ID
+ revision:
+ type: string
+ description: The revision of the page when the summary was produced
+ extract:
+ type: string
+ description: First several sentences of an article in plain text
+ extract_html:
+ type: string
+ description: First several sentences of an article in simple HTML
format
+ thumbnail:
+ $ref: '#/definitions/image_props'
+ originalimage:
+ $ref: '#/definitions/image_props'
+ lang:
+ type: string
+ description: The page language code
+ example: en
+ dir:
+ type: string
+ description: The page language direction code
+ enum:
+ - ltr
+ - rtl
+ timestamp:
+ type: string
+ format: date-time
+ description: The time when the page was last editted in the [ISO
8601](https://en.wikipedia.org/wiki/ISO_8601) format
+ example: '1970-01-01T00:00:00.000Z'
+ description:
+ type: string
+ description: Wikidata description for the page
+ example: American poet
+# coordinates:
+# type: object
+# description: The coordinates of the item
+# properties:
+# lat:
+# type: number
+# description: The latitude
+# lon:
+# type: number
+# description: The longitude
+# requiredProperties: [ 'lat', 'lon' ]
+ required: ['type', 'title', 'displaytitle', 'pageid', 'lang', 'dir',
'revision', 'timestamp', 'extract', 'extract_html']
+
dated_pageview:
type: object
date:
diff --git a/test/features/app/spec.js b/test/features/app/spec.js
index e482ffe..cee7d9f 100644
--- a/test/features/app/spec.js
+++ b/test/features/app/spec.js
@@ -354,6 +354,11 @@
return assertValidSchema(uri, '#/definitions/onthisdayResponse');
});
+ it('summary response should conform to schema', () => {
+ const uri = `${baseUri}page/summary/Dubai/808803658`;
+ return assertValidSchema(uri, '#/definitions/summary');
+ });
+
// Bad requests return empty response for aggregated=true
it('featured article response should conform to schema (invalid lang,
agg=true)', () => {
--
To view, visit https://gerrit.wikimedia.org/r/376139
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I976a2997507240dd162196e6f1ba86e171d9e98b
Gerrit-PatchSet: 6
Gerrit-Project: mediawiki/services/mobileapps
Gerrit-Branch: master
Gerrit-Owner: BearND <[email protected]>
Gerrit-Reviewer: BearND <[email protected]>
Gerrit-Reviewer: Dbrant <[email protected]>
Gerrit-Reviewer: Fjalapeno <[email protected]>
Gerrit-Reviewer: GWicke <[email protected]>
Gerrit-Reviewer: Gergő Tisza <[email protected]>
Gerrit-Reviewer: Jdlrobson <[email protected]>
Gerrit-Reviewer: Mholloway <[email protected]>
Gerrit-Reviewer: Mhurd <[email protected]>
Gerrit-Reviewer: Mobrovac <[email protected]>
Gerrit-Reviewer: Ppchelko <[email protected]>
Gerrit-Reviewer: jenkins-bot <>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
