Projekt

Obecné

Profil

« Předchozí | Další » 

Revize e23248ed

Přidáno uživatelem Stanislav Král před téměř 4 roky(ů)

Re #8708 - Changed the swagger.yaml accordingly to the previous REST API endpoint changes (/api/certificate/{id}/identity endpoint)

Changed method from POST to GET.
Changed 201 status code to 200.
Improved status code descriptions.
Improved ID parameter description.
Market IdentityRequest parameters as required.

Zobrazit rozdíly:

src/swagger.yaml
367 367
              schema:
368 368
                $ref: '#/components/schemas/ErrorResponse'
369 369
  /api/certificates/{id}/identity:
370
    post:
370
    get:
371 371
      tags:
372 372
      - certificates
373 373
      summary: Create a PCKS12 identity
......
376 376
      parameters:
377 377
      - name: id
378 378
        in: path
379
        description: ID of a certificate whose private key is to be queried
379
        description: ID of a certificate whose PKCS12 identity should be created
380 380
        required: true
381 381
        style: simple
382 382
        explode: false
383 383
        schema:
384 384
          $ref: '#/components/schemas/IdParameter'
385 385
      requestBody:
386
        description: Certificate data to be created
386
        description: Identity data to be created
387 387
        content:
388 388
          application/json:
389 389
            schema:
390 390
              $ref: '#/components/schemas/IdentityRequest'
391 391
      responses:
392
        "201":
393
          description: identity created
392
        "200":
393
          description: identity successfully generated and returned
394 394
          content:
395 395
            application/x-pkcs12:
396 396
              schema:
397 397
                type: string
398 398
                format: binary
399 399
        "400":
400
          description: invalid input, object invalid
400
          description: missing required parameters
401 401
          content:
402 402
            application/json:
403 403
              schema:
......
659 659
        name:
660 660
          type: string
661 661
          example: Jane Doe
662
          required: true
662 663
        password:
663 664
          type: string
664 665
          example: passphrase
666
          required: true

Také k dispozici: Unified diff