github.com/thetreep/go-swagger@v0.0.0-20240223100711-35af64f14f01/fixtures/bugs/2919/edge-api/management/ext-jwt-signers.yml (about)

     1  ---
     2  paths:
     3    external-jwt-signers:
     4      get:
     5        summary: List External JWT Signers
     6        description: Retrieves a list of external JWT signers for authentication
     7        security:
     8          - ztSession: [ ]
     9        tags:
    10          - External JWT Signer
    11        operationId: listExternalJwtSigners
    12        parameters:
    13          - $ref: '../shared/parameters.yml#/limit'
    14          - $ref: '../shared/parameters.yml#/offset'
    15          - $ref: '../shared/parameters.yml#/filter'
    16        responses:
    17          '200':
    18            $ref: '#/responses/listExternalJwtSigners'
    19          '401':
    20            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    21          '400':
    22            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    23      post:
    24        summary: Creates an External JWT Signer
    25        description: Creates an External JWT Signer. Requires admin access.
    26        security:
    27          - ztSession: [ ]
    28        tags:
    29          - External JWT Signer
    30        operationId: createExternalJwtSigner
    31        parameters:
    32          - name: externalJwtSigner
    33            in: body
    34            required: true
    35            description: An External JWT Signer to create
    36            schema:
    37              $ref: '#/definitions/externalJwtSignerCreate'
    38        responses:
    39          '201':
    40            $ref: '../shared/standard-responses.yml#/responses/createResponse'
    41          '400':
    42            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    43          '401':
    44            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    45    external-jwt-signers-id:
    46      parameters:
    47        - $ref: '../shared/parameters.yml#/id'
    48      get:
    49        summary: Retrieves a single External JWT Signer
    50        description: Retrieves a single External JWT Signer by id. Requires admin access.
    51        security:
    52          - ztSession: [ ]
    53        tags:
    54          - External JWT Signer
    55        operationId: detailExternalJwtSigner
    56        responses:
    57          '200':
    58            $ref: '#/responses/detailExternalJwtSigner'
    59          '404':
    60            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    61          '401':
    62            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    63      put:
    64        summary: Update all fields on an External JWT Signer
    65        description: Update all fields on an External JWT Signer by id. Requires admin access.
    66        security:
    67          - ztSession: [ ]
    68        tags:
    69          - External JWT Signer
    70        operationId: updateExternalJwtSigner
    71        parameters:
    72          - name: externalJwtSigner
    73            in: body
    74            required: true
    75            description: An External JWT Signer update object
    76            schema:
    77              $ref: '#/definitions/externalJwtSignerUpdate'
    78        responses:
    79          '200':
    80            $ref: '../shared/standard-responses.yml#/responses/updateResponse'
    81          '400':
    82            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
    83          '404':
    84            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
    85          '401':
    86            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
    87      patch:
    88        summary: Update the supplied fields on an External JWT Signer
    89        description: Update only the supplied fields on an External JWT Signer by id. Requires admin access.
    90        security:
    91          - ztSession: [ ]
    92        tags:
    93          - External JWT Signer
    94        operationId: patchExternalJwtSigner
    95        parameters:
    96          - name: externalJwtSigner
    97            in: body
    98            required: true
    99            description: An External JWT Signer patch object
   100            schema:
   101              $ref: '#/definitions/externalJwtSignerPatch'
   102        responses:
   103          '200':
   104            $ref: '../shared/standard-responses.yml#/responses/patchResponse'
   105          '400':
   106            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   107          '404':
   108            $ref: '../shared/standard-responses.yml#/responses/notFoundResponse'
   109          '401':
   110            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   111      delete:
   112        summary: Delete an External JWT Signer
   113        description: |
   114          Delete an External JWT Signer by id. Requires admin access.
   115        security:
   116          - ztSession: [ ]
   117        tags:
   118          - External JWT Signer
   119        operationId: deleteExternalJwtSigner
   120        responses:
   121          '200':
   122            $ref: '../shared/standard-responses.yml#/responses/deleteResponse'
   123          '400':
   124            $ref: '../shared/standard-responses.yml#/responses/badRequestResponse'
   125          '401':
   126            $ref: '../shared/standard-responses.yml#/responses/unauthorizedResponse'
   127  responses:
   128    listExternalJwtSigners:
   129      description: A list of External JWT Signers
   130      schema:
   131        $ref: '#/definitions/listExternalJwtSignersEnvelope'
   132    detailExternalJwtSigner:
   133      description: A singular External JWT Signer resource
   134      schema:
   135        $ref: '#/definitions/detailExternalJwtSignerEnvelope'
   136  definitions:
   137    listExternalJwtSignersEnvelope:
   138      type: object
   139      required:
   140        - meta
   141        - data
   142      properties:
   143        meta:
   144          $ref: '../shared/standard-responses.yml#/definitions/meta'
   145        data:
   146          $ref: '#/definitions/externalJwtSignerList'
   147    detailExternalJwtSignerEnvelope:
   148      type: object
   149      required:
   150        - meta
   151        - data
   152      properties:
   153        meta:
   154          $ref: '../shared/standard-responses.yml#/definitions/meta'
   155        data:
   156          $ref: '#/definitions/externalJwtSignerDetail'
   157    externalJwtSignerList:
   158      description: An array of External JWT Signers resources
   159      type: array
   160      items:
   161        $ref: '#/definitions/externalJwtSignerDetail'
   162    externalJwtSignerDetail:
   163      description: A External JWT Signer resource
   164      type: object
   165      allOf:
   166        - $ref: '../shared/base-entity.yml#/definitions/baseEntity'
   167        - type: object
   168          required:
   169            - name
   170            - certPem
   171            - jwksEndpoint
   172            - enabled
   173            - fingerprint
   174            - commonName
   175            - notAfter
   176            - notBefore
   177            - externalAuthUrl
   178            - claimsProperty
   179            - useExternalId
   180            - kid
   181            - issuer
   182            - audience
   183          properties:
   184            name:
   185              type: string
   186              example: 'MyApps Signer'
   187            certPem:
   188              type: string
   189              x-nullable: true
   190            jwksEndpoint:
   191              type: string
   192              format: uri
   193              x-nullable: true
   194            enabled:
   195              type: boolean
   196            fingerprint:
   197              type: string
   198            commonName:
   199              type: string
   200            notAfter:
   201              type: string
   202              format: date-time
   203            notBefore:
   204              type: string
   205              format: date-time
   206            externalAuthUrl:
   207              type: string
   208              format: url
   209            claimsProperty:
   210              type: string
   211            useExternalId:
   212              type: boolean
   213            kid:
   214              type: string
   215            issuer:
   216              type: string
   217            audience:
   218              type: string
   219    externalJwtSignerCreate:
   220      description: A create Certificate Authority (CA) object
   221      type: object
   222      required:
   223        - name
   224        - enabled
   225        - issuer
   226        - audience
   227      properties:
   228        name:
   229          type: string
   230          example: 'MyApps Signer'
   231        certPem:
   232          type: string
   233          x-nullable: true
   234        jwksEndpoint:
   235          type: string
   236          format: uri
   237          x-nullable: true
   238        enabled:
   239          type: boolean
   240        externalAuthUrl:
   241          type: string
   242          format: url
   243          x-nullable: true
   244        kid:
   245          type: string
   246          x-nullable: true
   247        claimsProperty:
   248          type: string
   249          x-nullable: true
   250        useExternalId:
   251          type: boolean
   252          x-nullable: true
   253        issuer:
   254          type: string
   255        audience:
   256          type: string
   257          x-nullable: true
   258        tags:
   259          $ref: '../shared/base-entity.yml#/definitions/tags'
   260    externalJwtSignerUpdate:
   261      type: object
   262      required:
   263        - name
   264        - enabled
   265        - issuer
   266        - audience
   267      properties:
   268        name:
   269          type: string
   270          example: 'MyApps Signer'
   271        certPem:
   272          type: string
   273          x-nullable: true
   274        jwksEndpoint:
   275          type: string
   276          format: uri
   277          x-nullable: true
   278        enabled:
   279          type: boolean
   280        externalAuthUrl:
   281          type: string
   282          format: url
   283          x-nullable: true
   284        kid:
   285          type: string
   286          x-nullable: true
   287        claimsProperty:
   288          type: string
   289          x-nullable: true
   290        useExternalId:
   291          type: boolean
   292          x-nullable: true
   293        issuer:
   294          type: string
   295        audience:
   296          type: string
   297          x-nullable: true
   298        tags:
   299          $ref: '../shared/base-entity.yml#/definitions/tags'
   300    externalJwtSignerPatch:
   301      type: object
   302      properties:
   303        name:
   304          type: string
   305          example: 'MyApps Signer'
   306          x-nullable: true
   307        certPem:
   308          type: string
   309          x-nullable: true
   310        jwksEndpoint:
   311          type: string
   312          format: uri
   313          x-nullable: true
   314        enabled:
   315          type: boolean
   316          x-nullable: true
   317        kid:
   318          type: string
   319          x-nullable: true
   320        externalAuthUrl:
   321          type: string
   322          format: url
   323          x-nullable: true
   324        claimsProperty:
   325          type: string
   326          x-nullable: true
   327        useExternalId:
   328          type: boolean
   329          x-nullable: true
   330        issuer:
   331          type: string
   332          x-nullable: true
   333        audience:
   334          type: string
   335          x-nullable: true
   336        tags:
   337          $ref: '../shared/base-entity.yml#/definitions/tags'