linode-cli/tests/fixtures/skip_attribute_test.yaml at 4c284068c72ecdcbf5912913e832ee899c0ebd50 · linode/linode-cli · 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
openapi: 3.0.1
info:
  title: API Specification for x-linode-cli-skip Tests
  version: 1.0.0
servers:
  - url: http://localhost/v4

paths:
  /skip/test:
    x-linode-cli-command: skip-test
    get:
      summary: Test GET with skipped response attributes
      operationId: getSkipTest
      x-linode-cli-action: list
      description: List items with some attributes skipped
      responses:
        '200':
          description: Successful response with skipped attributes
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SkipTestResponse'
                  page:
                    $ref: '#/components/schemas/PaginationEnvelope/properties/page'
                  pages:
                    $ref: '#/components/schemas/PaginationEnvelope/properties/pages'
                  results:
                    $ref: '#/components/schemas/PaginationEnvelope/properties/results'
    post:
      summary: Create with skipped request attributes
      operationId: createSkipTest
      x-linode-cli-action: create
      description: Create an item with some request attributes skipped
      requestBody:
        description: Parameters for creating the item
        required: true
        content:
          application/json:
            schema:
              required:
              - visible_field
              allOf:
              - $ref: '#/components/schemas/SkipTestRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SkipTestResponse'

components:
  schemas:
    PaginationEnvelope:
      type: object
      properties:
        pages:
          type: integer
          readOnly: true
          description: The total number of pages.
          example: 1
        page:
          type: integer
          readOnly: true
          description: The current page.
          example: 1
        results:
          type: integer
          readOnly: true
          description: The total number of results.
          example: 1

    SkipTestRequest:
      type: object
      description: Request object with skipped fields
      properties:
        visible_field:
          type: string
          description: This field should be visible
        skipped_request_field:
          type: string
          x-linode-cli-skip: true
          description: This field should be skipped in request
        another_visible_field:
          type: integer
          description: Another visible field
        skipped_both_field:
          type: string
          x-linode-cli-skip: true
          description: This field should be skipped in both request and response
        nested_object:
          type: object
          properties:
            nested_visible_field:
              type: string
              description: This nested field should be visible
            nested_skipped_field:
              type: string
              x-linode-cli-skip: true
              description: This nested field should be skipped

    SkipTestResponse:
      type: object
      description: Response object with skipped fields
      properties:
        id:
          type: integer
          readOnly: true
          description: The unique ID
        visible_field:
          type: string
          description: This field should be visible
        skipped_response_field:
          type: string
          x-linode-cli-skip: true
          description: This field should be skipped in response
        another_visible_field:
          type: integer
          description: Another visible field
        skipped_both_field:
          type: string
          x-linode-cli-skip: true
          description: This field should be skipped in both request and response
        nested_object:
          type: object
          properties:
            nested_visible_field:
              type: string
              description: This nested field should be visible
            nested_skipped_field:
              type: string
              x-linode-cli-skip: true
              description: This nested field should be skipped