trust-receive/openapi.yaml at main · omalloc/trust-receive · 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
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi

openapi: 3.0.3
info:
    title: Receive Service
    description: ReceiveService provides file consistency verification reporting.
    contact:
        name: omalloc
        url: https://github.com/omalloc/trust-receive
    license:
        name: MIT
        url: https://github.com/omalloc/trust-receive/blob/main/LICENSE
    version: 1.0.0
paths:
    /receive:
        post:
            tags:
                - ReceiveService
            summary: Receive reported file information
            description: Validates reported file information against authoritative records.
            operationId: ReceiveService_Receive
            requestBody:
                content:
                    application/json:
                        schema:
                            $ref: '#/components/schemas/receive.v1.ReceiveRequest'
                required: true
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/receive.v1.ReceiveReply'
components:
    schemas:
        receive.v1.ReceiveReply:
            type: object
            properties:
                message:
                    example: "ok"
                    type: string
                    description: Confirmation message.
            description: ReceiveReply represents the response of file information reporting.
        receive.v1.ReceiveRequest:
            type: object
            properties:
                url:
                    example: "https://example.com/static/js/main.js"
                    type: string
                    description: The full URL of the file resource.
                hash:
                    example: "d41d8cd98f00b204e9800998ecf8427e"
                    type: string
                    description: The HASH value of the file (e.g., MD5 or SHA256).
                lm:
                    example: "Wed, 21 Oct 2015 07:28:00 GMT"
                    type: string
                    description: The Last-Modified header value from the origin server.
                cl:
                    example: 1024
                    type: string
                    description: The Content-Length of the file in bytes.
            description: ReceiveRequest represents the request to report file information.
tags:
    - name: ReceiveService