Skip to content

[elixir] Typespec: Fixes issue with formated primitivs as parameters#1534

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
cyon:elixir/formated-primitives
Nov 27, 2018
Merged

[elixir] Typespec: Fixes issue with formated primitivs as parameters#1534
wing328 merged 1 commit intoOpenAPITools:masterfrom
cyon:elixir/formated-primitives

Conversation

@mrmstn
Copy link
Copy Markdown
Contributor

@mrmstn mrmstn commented Nov 23, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I had a issue that formatted strings as parameter won't be treated as primitivs ( this might be a issue in the global scope? ) which will result in Typespec like MyApi.Model.String.t.t. With this PR, the resulting typespec will be String.t (or what ever datetype mapping has been done before).

To proof my point, the yml for the sample need to have something like the following lines. I'm not quite sure how to do that - could you help me out on this one? @wing328

---
swagger: "2.0"
info:
  version: "1.0.0"
  title: "Swagger Petstore"
host: "petstore.swagger.io"
basePath: "/v2"
tags:
  - name: "invoice"
schemes:
  - "http"
paths:
  /invoice/{invoiceItemId}:
    get:
      tags:
        - "invoice"
      operationId: "getInvoice"
      parameters:
        - name: invoiceItemId
          in: path
          required: true
          type: string
          pattern: \w+-\w+-\w+-\w+-\w+
          format: uuid
      responses:
        405:
          description: "Invalid input"

Here's a sample of the difference:
old:

  @spec get_invoice(Tesla.Env.client, SwaggerPetstore.Model.String.t.t, keyword()) :: {:ok, nil} | {:error, Tesla.Env.t}
  def get_invoice(connection, invoice_item_id, _opts \\ []) do

new:

  @spec get_invoice(Tesla.Env.client, String.t, keyword()) :: {:ok, nil} | {:error, Tesla.Env.t}
  def get_invoice(connection, invoice_item_id, _opts \\ []) do

@wing328
Copy link
Copy Markdown
Member

wing328 commented Nov 27, 2018

There may be another way to fix this. Let me check further.

@wing328 wing328 added this to the 3.3.4 milestone Nov 27, 2018
@wing328
Copy link
Copy Markdown
Member

wing328 commented Nov 27, 2018

I did a bit more debugging and it's because isPrimitiveType is set to false for UUID (string). We'll go with your approach first and I'll submit another PR to cover other edge cases as well.

@wing328 wing328 merged commit d31fa4f into OpenAPITools:master Nov 27, 2018
@wing328
Copy link
Copy Markdown
Member

wing328 commented Nov 27, 2018

@mrmstn I've filed #1558 to handle other edge cases as well (e.g. email, password)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants