Uploaded image for project: 'Marathon'
  1. Marathon
  2. MARATHON-7978

Deprecate and disable JSON schema endpoint by default

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Medium
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: DC/OS 1.11.3, RI-2
    • Component/s: API
    • Labels:
      None

      Description

      Background:

      We no longer use JSON schema define our API, and it is stale. After talking with the DCOS-UI team, they revealed that they no longer have not used the JSON schema for a long time. It is tedious an a source of error-prone to have to maintain both. It doesn't seem worth it (or, potentially, completely possible) to automatically convert our RAML to JSON schema.

      We also, currently, expose the JSON schema via an API endpoint (/v2/schema, see SchemaResource.scala). This means that some clients out there could still be depending on it.

      Path forward:

      We will follow our deprecation policy for removing endpoints. In a future 1.x.0 release, we will disable the endpoint by default, enabling it with a feature flag. Then, in a subsequent major 1.x.0 release, we will remove it all all supporting code altogether.

      Acceptance

      As a user
      In order to help me be aware that I am using deprecated endpoints,
      I want it to be obvious that I am querying a deprecated interface
      In order to prevent a jarring and frustrating rollback (or an extremely rushed change to some tool),
      I want to be able to optionally continue to use this deprecated a short while longer without having to roll back Marathon

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                tharper Tim Harper
                Reporter:
                tharper Tim Harper
                Team:
                Orchestration Team
                Watchers:
                Tim Harper
              • Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: