Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Error "'path' must begin with '/' and be relative to an individual" when endpoint path contains = #10009

Open
dominikforal opened this issue Jun 10, 2024 · 0 comments

Comments

@dominikforal
Copy link

Q&A (please complete the following information)

  • OS: Windows
  • Browser: Firefox, Edge
  • Version: SaaS

Example Swagger/OpenAPI definition:

  /me/RecentCommunication(senderEmail='{senderEmail}'):
    get:
      summary: Recent requests with e-mail sender
      tags:
        - Internal
      parameters:
        - in: path
          name: senderEmail
          schema:
            type: string
          required: true
        - $ref: '#/components/parameters/odata.top'
        - in: query
          schema:
            type: string
          name: $expand
          description: >-
            Include linked resources with retrieved resources with <a
            href="http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part2-url-conventions/odata-v4.0-errata03-os-part2-url-conventions-complete.html#_Toc453752359"
            target="_blank">OData v4.0 $expand</a>
          examples:
            requester:
              value: requester
            service:
              value: service
            coRequesters:
              value: coRequesters
            objects:
              value: objects
            state:
              value: state
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SD.TicketsApiResponse'
        '500':
          $ref: '#/components/responses/ServerError'

Describe the bug you're encountering

I have an OData function as a part of my API with the following path:
/me/RecentCommunication(senderEmail='{senderEmail}'):

Shortly after I updated my spec to 3.1.0 an error "'path' must begin with '/' and be relative to an individual" occured. It is strange that error does not appear immediately but after a few minutes. I have never had any issues with this path before and it is OK on the older version of this API (OAS version 3.0.0). It seems to be related to '=' in the function path.

YAML is valid and this endpoint is displayed correctly in API doc. So it seems as a bug to me.

Any suggestions?

Screenshots

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant