Skip to content

[API Review] Rename & evaluate properties in ReadResult #1963

Closed

Description

Requester: Safia Abdalla (@captainsafia)

  1. Evaluate rename of properties in ReadResult to avoid redundancy in naming:
    Change OpenAPIDocument -> Document and OpenAPIDiagnostic -> Error
  2. Evaluate if the properties in ReadResult need setters.
  3. OpenAPIDocument should be nullable.

Activity

  1. added
    priority:p1High priority but not blocking. Causes major but not critical loss of functionality SLA <=7days
    on Dec 3, 2024
  2. MaggieKimani1 commented on Dec 6, 2024

    @MaggieKimani1
    Contributor

    I think we can rename OpenApiDiagnostic to Diagnostic since it already contains an errors object within, in addition to a SpecificationVersion object. It would make more sense to have Diagnostic.Errors and Diagnostic.SpecificationVersion instead of Error.Errors

  3. RachitMalik12 commented on Dec 6, 2024

    @RachitMalik12
    ContributorAuthor

    Maggie Kimani (@MaggieKimani1) I am fine with that.

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

    priority:p1High priority but not blocking. Causes major but not critical loss of functionality SLA <=7days

    Type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions