ri-analytics-classification-twitter/swagger.yaml at master · OpenReqEU/ri-analytics-classification-twitter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
---
swagger: "2.0"
info:
  description: This API returns a json, containing a list of processed tweets. It expects a JSON payload that
    contains an array of at least a single tweet. An tweet json object must contain a field
    text (string) and the status_id (string).
  version: "1.0.1"
  title: Classify tweets from Twitter
  contact:
    email: stanik@informatik.uni-hamburg.de
host: api.openreq.eu
basePath: /ri-analytics-classification-twitter
schemes:
- https
paths:
  /hitec/classify/domain/tweets/lang/{lang}:
    post:
      summary: returns an array of classified tweets.
      description: returns an array of classified tweets.
      operationId: post_classification_result
      produces:
        - application/json
      consumes:
              - application/json
      parameters:
        - in: body
          name: an array of tweets
          schema:
             $ref: '#/definitions/Tweet'
          required: true
        - in: path
          name: lang
          description: the language of the tweet. Supported languages are 'it' and 'en'
          required: true
          type: string

      responses:
        200:
          description: json array of classified tweets. The example only includes the minimal required information
          schema:
            $ref: '#/definitions/ProcessedTweet'
        400:
          description: error during the processing of the tweets.
definitions:
  Tweet:
    type: object
    properties:
      created_at:
        type:  integer
        example: 20181201
      favorite_count:
        type:  integer
        example: 1
      retweet_count:
        type:  integer
        example: 1
      status_id:
        type: string
        example: 933476766408200193
      in_reply_to_screen_name:
        type: string
        example: musteraccount
      lang:
        type: string
        example: en
      text:
        type: string
        example: "@maxmustermann Thanks for your message!"
      user_name:
        type: string
        example: maxmustermann
  ProcessedTweet:
    type: object
    properties:
      created_at:
        type:  integer
        example: 20181201
      favorite_count:
        type:  integer
        example: 1
      retweet_count:
        type:  integer
        example: 1
      status_id:
        type: string
        example: 933476766408200193
      in_reply_to_screen_name:
        type: string
        example: musteraccount
      lang:
        type: string
        example: en
      text:
        type: string
        example: "@maxmustermannThanks for your message!"
      user_name:
        type: string
        example: maxmustermann
      sentiment:
        type: string
        example: NEUTRAL
      sentiment_score:
        type: integer
        example: -1
      tweet_class:
        type: string
        example: problem_report