Uploaded image for project: 'Hybrid Cloud Console'
  1. Hybrid Cloud Console
  2. RHCLOUD-44402

Implement scalar types into V2 API spec

XMLWordPrintable

    • Product / Portfolio Work
    • False
    • Hide

      None

      Show
      None
    • False
    • None
    • Unset
    • None

      Currently the 'fields' query parameter is used throughout the 'roles' and rolebindings APIs with differing documentation, defaults and usage. Simplifying the documentation and creating a reusable scalar type to be used by all the APIs will keep our APIs consistent and prevent drift.

       

      https://typespec.io/docs/language-basics/scalars/ 

      /**			 
      * Field mask used by the `fields` query parameter.			 
      *			 
      * Examples:			 
      * - `id,name`			 
      * - `id,name,owner(id,email)`			
      */			
      scalar FieldMask extends string; 

      some context of why: https://darrenhobbs.com/2007/04/11/tiny-types/ & https://www.geepawhill.org/2019/01/25/tdd-pro-tip-wrap-containers-early-often/ 

       

      Acceptance Criteria:

      • Scalar type for fields query
      • Scalar type for cursor, limit and offset
      • Scalar type for order_by
      • Defaults for corresponding types

              rh-ee-jmarcant Jonathan Marcantonio
              rh-ee-jmarcant Jonathan Marcantonio
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: