Skip to content

Use of $ref for common schema PhoneNumber #247

Open

Description

@tanjadegroot

Problem description
Not using $ref towards a common schema needs to be motivated by the need for a specific local variant of a schema, and also requires a dedicated local name of this schema, to avoid mixing with the common schemas.

Possible evolution
For common schema PhoneNumber use the $ref notation :

    $ref: "../common/CAMARA_common.yaml#/components/schemas/PhoneNumber"

Activity

  1. bigludo7 commented on Oct 23, 2026

    @bigludo7
    Collaborator

    @tanjadegroot I'm bit lost - this is not already the case lines 339-340?

  2. rartych commented on Oct 23, 2026

    @rartych
    Collaborator

    We have an alias in line 335 $ref: '#/components/schemas/PhoneNumber' which is then resolved to $ref: "../common/CAMARA_common.yaml#/components/schemas/PhoneNumber"
    An alias is convenient when migrating an existing spec with local schema definitions.
    The difference is one of style, not correctness.
    For me we can think of simplifying API definition within the next release.

  3. bigludo7 commented on Oct 23, 2026

    @bigludo7
    Collaborator

    5. We have an alias in line 335 $ref: '#/components/schemas/PhoneNumber' which is then resolved to $ref: "../common/CAMARA_common.yaml#/components/schemas/PhoneNumber"
    An alias is convenient when migrating an existing spec with local schema definitions.
    The difference is one of style, not correctness.
    For me we can think of simplifying API definition within the next release.

    OK ! I've done #251
    Is is what you expect? :)

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions