graphql-engine/server/tests-py/queries/openapi/openapi_endpoint_with_multiple_methods.yaml

- description: Try to add a rest endpoint with multiple methods
  url: /v1/query
  status: 200
  response:
    message: success
  query:
    type: create_rest_endpoint
    args:
      url: multi_method_endpoint
      name: multi_method_endpoint
      methods:
      - GET
      - POST
      - PUT
      - DELETE
      - PATCH
      definition:
        query:
          collection_name: test_collection
          query_name: mutation_with_args

- description: Call openapi json endpoint
  url: /api/swagger/json
  method: GET
  status: 200
  query:
  response:
    openapi: 3.0.0
    info:
      description: This OpenAPI specification is automatically generated by Hasura.
      title: Rest Endpoints
      version: ''
    paths:
      /api/rest/multi_method_endpoint:
        get:
          summary: multi_method_endpoint
          description: "***\nThe GraphQl query for this endpoint is:\n``` graphql\n\
            mutation ($first_name: String!, $last_name: String!) { insert_test_table(\
            \ objects: {first_name: $first_name, last_name: $last_name }) { returning\
            \ { id } affected_rows } }\n```"
          parameters:
          - description: Your x-hasura-admin-secret will be used for authentication
              of the API request.
            in: header
            name: x-hasura-admin-secret
            schema:
              type: string
          - description: _"last_name" is required (enter it either in parameters or
              request body)_
            in: query
            name: last_name
            schema:
              type: string
          - description: _"first_name" is required (enter it either in parameters
              or request body)_
            in: query
            name: first_name
            schema:
              type: string
          requestBody:
            content:
              application/json:
                schema:
                  properties:
                    first_name:
                      nullable: false
                      title: String
                      type: string
                    last_name:
                      nullable: false
                      title: String
                      type: string
                  type: object
            description: Query parameters can also be provided in the request body
              as a JSON object
            required: false
          responses:
            '200':
              content:
                application/json:
                  schema:
                    properties:
                      insert_test_table:
                        description: response of any mutation on the table "test_table"
                        nullable: true
                        properties:
                          affected_rows:
                            nullable: false
                            title: Int
                            type: integer
                          returning:
                            items:
                              description: columns and relationships of "test_table"
                              nullable: false
                              properties:
                                id:
                                  $ref: '#/components/schemas/uuid!'
                              title: test_table
                              type: object
                            nullable: false
                            type: array
                        title: test_table_mutation_response
                        type: object
              description: Responses for GET /api/rest/multi_method_endpoint
        put:
          summary: multi_method_endpoint
          description: "***\nThe GraphQl query for this endpoint is:\n``` graphql\n\
            mutation ($first_name: String!, $last_name: String!) { insert_test_table(\
            \ objects: {first_name: $first_name, last_name: $last_name }) { returning\
            \ { id } affected_rows } }\n```"
          parameters:
          - description: Your x-hasura-admin-secret will be used for authentication
              of the API request.
            in: header
            name: x-hasura-admin-secret
            schema:
              type: string
          - description: _"last_name" is required (enter it either in parameters or
              request body)_
            in: query
            name: last_name
            schema:
              type: string
          - description: _"first_name" is required (enter it either in parameters
              or request body)_
            in: query
            name: first_name
            schema:
              type: string
          requestBody:
            content:
              application/json:
                schema:
                  properties:
                    first_name:
                      nullable: false
                      title: String
                      type: string
                    last_name:
                      nullable: false
                      title: String
                      type: string
                  type: object
            description: Query parameters can also be provided in the request body
              as a JSON object
            required: false
          responses:
            '200':
              content:
                application/json:
                  schema:
                    properties:
                      insert_test_table:
                        description: response of any mutation on the table "test_table"
                        nullable: true
                        properties:
                          affected_rows:
                            nullable: false
                            title: Int
                            type: integer
                          returning:
                            items:
                              description: columns and relationships of "test_table"
                              nullable: false
                              properties:
                                id:
                                  $ref: '#/components/schemas/uuid!'
                              title: test_table
                              type: object
                            nullable: false
                            type: array
                        title: test_table_mutation_response
                        type: object
              description: Responses for PUT /api/rest/multi_method_endpoint
        post:
          summary: multi_method_endpoint
          description: "***\nThe GraphQl query for this endpoint is:\n``` graphql\n\
            mutation ($first_name: String!, $last_name: String!) { insert_test_table(\
            \ objects: {first_name: $first_name, last_name: $last_name }) { returning\
            \ { id } affected_rows } }\n```"
          parameters:
          - description: Your x-hasura-admin-secret will be used for authentication
              of the API request.
            in: header
            name: x-hasura-admin-secret
            schema:
              type: string
          - description: _"last_name" is required (enter it either in parameters or
              request body)_
            in: query
            name: last_name
            schema:
              type: string
          - description: _"first_name" is required (enter it either in parameters
              or request body)_
            in: query
            name: first_name
            schema:
              type: string
          requestBody:
            content:
              application/json:
                schema:
                  properties:
                    first_name:
                      nullable: false
                      title: String
                      type: string
                    last_name:
                      nullable: false
                      title: String
                      type: string
                  type: object
            description: Query parameters can also be provided in the request body
              as a JSON object
            required: false
          responses:
            '200':
              content:
                application/json:
                  schema:
                    properties:
                      insert_test_table:
                        description: response of any mutation on the table "test_table"
                        nullable: true
                        properties:
                          affected_rows:
                            nullable: false
                            title: Int
                            type: integer
                          returning:
                            items:
                              description: columns and relationships of "test_table"
                              nullable: false
                              properties:
                                id:
                                  $ref: '#/components/schemas/uuid!'
                              title: test_table
                              type: object
                            nullable: false
                            type: array
                        title: test_table_mutation_response
                        type: object
              description: Responses for POST /api/rest/multi_method_endpoint
        delete:
          summary: multi_method_endpoint
          description: "***\nThe GraphQl query for this endpoint is:\n``` graphql\n\
            mutation ($first_name: String!, $last_name: String!) { insert_test_table(\
            \ objects: {first_name: $first_name, last_name: $last_name }) { returning\
            \ { id } affected_rows } }\n```"
          parameters:
          - description: Your x-hasura-admin-secret will be used for authentication
              of the API request.
            in: header
            name: x-hasura-admin-secret
            schema:
              type: string
          - description: _"last_name" is required (enter it either in parameters or
              request body)_
            in: query
            name: last_name
            schema:
              type: string
          - description: _"first_name" is required (enter it either in parameters
              or request body)_
            in: query
            name: first_name
            schema:
              type: string
          requestBody:
            content:
              application/json:
                schema:
                  properties:
                    first_name:
                      nullable: false
                      title: String
                      type: string
                    last_name:
                      nullable: false
                      title: String
                      type: string
                  type: object
            description: Query parameters can also be provided in the request body
              as a JSON object
            required: false
          responses:
            '200':
              content:
                application/json:
                  schema:
                    properties:
                      insert_test_table:
                        description: response of any mutation on the table "test_table"
                        nullable: true
                        properties:
                          affected_rows:
                            nullable: false
                            title: Int
                            type: integer
                          returning:
                            items:
                              description: columns and relationships of "test_table"
                              nullable: false
                              properties:
                                id:
                                  $ref: '#/components/schemas/uuid!'
                              title: test_table
                              type: object
                            nullable: false
                            type: array
                        title: test_table_mutation_response
                        type: object
              description: Responses for DELETE /api/rest/multi_method_endpoint
        patch:
          summary: multi_method_endpoint
          description: "***\nThe GraphQl query for this endpoint is:\n``` graphql\n\
            mutation ($first_name: String!, $last_name: String!) { insert_test_table(\
            \ objects: {first_name: $first_name, last_name: $last_name }) { returning\
            \ { id } affected_rows } }\n```"
          parameters:
          - description: Your x-hasura-admin-secret will be used for authentication
              of the API request.
            in: header
            name: x-hasura-admin-secret
            schema:
              type: string
          - description: _"last_name" is required (enter it either in parameters or
              request body)_
            in: query
            name: last_name
            schema:
              type: string
          - description: _"first_name" is required (enter it either in parameters
              or request body)_
            in: query
            name: first_name
            schema:
              type: string
          requestBody:
            content:
              application/json:
                schema:
                  properties:
                    first_name:
                      nullable: false
                      title: String
                      type: string
                    last_name:
                      nullable: false
                      title: String
                      type: string
                  type: object
            description: Query parameters can also be provided in the request body
              as a JSON object
            required: false
          responses:
            '200':
              content:
                application/json:
                  schema:
                    properties:
                      insert_test_table:
                        description: response of any mutation on the table "test_table"
                        nullable: true
                        properties:
                          affected_rows:
                            nullable: false
                            title: Int
                            type: integer
                          returning:
                            items:
                              description: columns and relationships of "test_table"
                              nullable: false
                              properties:
                                id:
                                  $ref: '#/components/schemas/uuid!'
                              title: test_table
                              type: object
                            nullable: false
                            type: array
                        title: test_table_mutation_response
                        type: object
              description: Responses for PATCH /api/rest/multi_method_endpoint
    components:
      schemas:
        uuid!:
          nullable: false
          pattern: '[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}'
          title: uuid
          type: string

- description: Try to remove the endpoint
  url: /v1/query
  status: 200
  response:
    message: success
  query:
    type: drop_rest_endpoint
    args:
      name: multi_method_endpoint