Skip to content

[Areas API] Missing schema type, and two text fixes #164

Closed

Description

@hdamker

Problem description

Three small items in dedicated-network-areas.yaml.

1. ServiceArea has no type: object.

    ServiceArea:
      description: Common attributes of a service area, i.e. where the network service is supported
      properties:
        id:
          ...
      required:
        - id
        - area
      anyOf:
        - required:
            - networkProfiles
        - required:
            - qosProfiles

Every other schema in this file, and in the other three API definitions in this repository, declares
type: object before properties.

2. info.description:8 reads "...where consitent coverage..." — misspelled.

3. info.description:55 reads:

coveringArea - to return the network service areas whose geographical area fully covers the input geographical area will be returned, where the input geographical area may be a circle or polygon

This sentence looks broken and is hard to follow.

Expected behavior

  1. Add type: object to ServiceArea.
  2. "consistent".
  3. Please rewrite this sentence for clarity.

Alternative solution

None.

Additional context

None.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions