linkscraper-api/openapi.yaml at main · apiverve/linkscraper-api · 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
openapi: 3.0.4
info:
  title: Link Scraper
  description: >-
    Link Scraper is a simple tool for scraping web page links. It returns all
    the links on a web page.
  termsOfService: https://apiverve.com/terms/
  contact:
    name: APIVerve Support
    email: hello@apiverve.com
    url: https://apiverve.com/contact
  version: 1.0.0
externalDocs:
  description: Learn more about APIVerve
  url: https://docs.apiverve.com?utm_source=openapi
servers:
  - url: https://api.apiverve.com/
paths:
  /v1/linkscraper:
    post:
      summary: Scrape Links
      description: Scrape all the links on a web page
      operationId: linkscraper
      parameters: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: status
                  error:
                    type: string
                    description: error
                  data:
                    type: object
                    description: data
              example:
                status: ok
                error: null
                data:
                  url: >-
                    http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html
                  linkCount: 16
                  links:
                    - text: ''
                      href: >-
                        http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/pdfs/AWSEC2/latest/UserGuide/ec2-ug.pdf#concepts
                      external: false
                    - text: Documentation
                      href: >-
                        http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/index.html
                      external: false
                    - text: Amazon EC2
                      href: >-
                        http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html/ec2/index.html
                      external: false
                    - text: User Guide
                      href: concepts.html
                      external: true
                    - text: Amazon EC2 Instance Types Guide
                      href: >-
                        https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html
                      external: true
                    - text: PCI DSS Level 1
                      href: https://aws.amazon.com/compliance/pci-dss-level-1-faqs/
                      external: true
                    - text: Amazon EC2 Auto Scaling
                      href: https://docs.aws.amazon.com/autoscaling/
                      external: true
                    - text: AWS Backup
                      href: https://docs.aws.amazon.com/aws-backup/
                      external: true
                    - text: Amazon CloudWatch
                      href: https://docs.aws.amazon.com/cloudwatch/
                      external: true
                    - text: Elastic Load Balancing
                      href: https://docs.aws.amazon.com/elasticloadbalancing/
                      external: true
                    - text: Amazon GuardDuty
                      href: https://docs.aws.amazon.com/guardduty/
                      external: true
                    - text: EC2 Image Builder
                      href: https://docs.aws.amazon.com/imagebuilder/
                      external: true
                    - text: AWS Launch Wizard
                      href: https://docs.aws.amazon.com/launchwizard/
                      external: true
                    - text: AWS Systems Manager
                      href: https://docs.aws.amazon.com/systems-manager/
                      external: true
                    - text: Amazon Lightsail
                      href: https://docs.aws.amazon.com/lightsail/
                      external: true
                    - text: Amazon Lightsail or Amazon EC2
                      href: >-
                        https://docs.aws.amazon.com/decision-guides/latest/lightsail-or-ec2/lightsail-or-ec2.html
                      external: true
                  maxLinksReached: false
        '401':
          description: Your request was not authorized, or your API Key was invalid
        '404':
          description: Requested resource was not found
        '500':
          description: A server error has occurred, try again later
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The URL of the web page to scrape links from
                maxlinks:
                  type: number
                  description: Maximum number of links to scrape and return
                includequery:
                  type: boolean
                  description: Include query strings in the scraped links
              required:
                - url
                - maxlinks
components:
  securitySchemes:
    api_key:
      type: apiKey
      name: x-api-key
      in: header
security:
  - api_key: []
sampleRequest:
  url: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts.html
  maxlinks: 20
  includequery: false